com.norconex.importer.handler.tagger.impl

Class DebugTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.DebugTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class DebugTagger
extends AbstractDocumentTagger

A utility tagger to help with troubleshooting of document importing. Place this tagger anywhere in your handler configuration to print to the log stream the metadata fields or content so far when this handler gets invoked. This handler does not impact the data being imported at all (it only reads it).

The default behavior logs all metadata fields using the DEBUG log level. You can optionally set which fields to log and whether to also log the document content or not, as well as specifying a different log level.

Be careful: Logging the content when you deal with very large content can result in memory exceptions.

Can be used both as a pre-parse or post-parse handler.

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.DebugTagger"
          logFields="(CSV list of fields to log)"
          logContent="(false|true)"
          logLevel="(FATAL|ERROR|WARN|INFO|DEBUG|TRACE)" >
      
      <restrictTo caseSensitive="[false|true]"
              field="(name of header/metadata field name to match)">
          (regular expression of value to match)
      </restrictTo>
      <!-- multiple "restrictTo" tags allowed (only one needs to match) -->
  </tagger>
 

Usage example:

The following logs the value of any "title" and "author" document metadata fields.

  <tagger class="com.norconex.importer.handler.tagger.impl.DebugTagger"
          logFields="title,author" logLevel="INFO" />
 

Since:

2.0.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
DebugTagger()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String[]	getLogFields()
String	getLogLevel()
int	hashCode()
boolean	isLogContent()
protected void	loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
protected void	saveHandlerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	setLogContent(boolean logContent)
void	setLogFields(String... logFields)
void	setLogLevel(String logLevel)
void	tagApplicableDocument(String reference, InputStream document, ImporterMetadata metadata, boolean parsed)
String	toString()

Methods inherited from class com.norconex.importer.handler.tagger.AbstractDocumentTagger

tagDocument

Methods inherited from class com.norconex.importer.handler.AbstractImporterHandler

addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, getRestrictions, isApplicable, loadFromXML, removeRestriction, removeRestriction, saveToXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DebugTagger

public DebugTagger()

Method Detail

tagApplicableDocument

public void tagApplicableDocument(String reference,
                                  InputStream document,
                                  ImporterMetadata metadata,
                                  boolean parsed)
                           throws ImporterHandlerException

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

getLogFields

public String[] getLogFields()

setLogFields

public void setLogFields(String... logFields)

isLogContent

public boolean isLogContent()

setLogContent

public void setLogContent(boolean logContent)

getLogLevel

public String getLogLevel()

setLogLevel

public void setLogLevel(String logLevel)

loadHandlerFromXML

protected void loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml)
                           throws IOException

Description copied from class: AbstractImporterHandler

Loads configuration settings specific to the implementing class.

Specified by:

loadHandlerFromXML in class AbstractImporterHandler

Parameters:

xml - xml configuration

Throws:

IOException - could not load from XML

saveHandlerToXML

protected void saveHandlerToXML(EnhancedXMLStreamWriter writer)
                         throws XMLStreamException

Description copied from class: AbstractImporterHandler

Saves configuration settings specific to the implementing class. The parent tag along with the "class" attribute are already written. Implementors must not close the writer.

Specified by:

saveHandlerToXML in class AbstractImporterHandler

Parameters:

writer - the xml writer

Throws:

XMLStreamException - could not save to XML

toString

public String toString()

Overrides:

toString in class AbstractImporterHandler

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractImporterHandler

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractImporterHandler