com.norconex.importer.handler.tagger

Class AbstractCharStreamTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.AbstractCharStreamTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

Direct Known Subclasses:

AbstractStringTagger, TextStatisticsTagger

public abstract class AbstractCharStreamTagger
extends AbstractDocumentTagger

Base class for taggers dealing with the body of text documents only. Subclasses can safely be used as either pre-parse or post-parse handlers restricted to text documents only (see AbstractImporterHandler).

Since 2.5.0, when used as a pre-parse handler, this class attempts to detect the content character encoding unless the character encoding was specified using setSourceCharset(String). Since document parsing converts content to UTF-8, UTF-8 is always assumed when used as a post-parse handler.

Subclasses inherit this IXMLConfigurable configuration:

  <!-- parent tag has these attribute: 
      sourceCharset="(character encoding)"
    --> 
  <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) -->
 

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
AbstractCharStreamTagger()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getSourceCharset() Gets the assumed source character encoding.
int	hashCode()
protected abstract void	loadCharStreamTaggerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
protected void	loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
protected abstract void	saveCharStreamTaggerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
protected void	saveHandlerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	setSourceCharset(String sourceCharset) Sets the assumed source character encoding.
protected void	tagApplicableDocument(String reference, InputStream document, ImporterMetadata metadata, boolean parsed)
protected abstract void	tagTextDocument(String reference, Reader input, 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

AbstractCharStreamTagger

public AbstractCharStreamTagger()

Method Detail

getSourceCharset

public String getSourceCharset()

Gets the assumed source character encoding.

Returns:

character encoding of the source to be transformed

Since:

2.5.0

setSourceCharset

public void setSourceCharset(String sourceCharset)

Sets the assumed source character encoding.

Parameters:

sourceCharset - character encoding of the source to be transformed

Since:

2.5.0

tagApplicableDocument

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

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

tagTextDocument

protected abstract void tagTextDocument(String reference,
                                        Reader input,
                                        ImporterMetadata metadata,
                                        boolean parsed)
                                 throws ImporterHandlerException

Throws:

ImporterHandlerException

saveHandlerToXML

protected final 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

saveCharStreamTaggerToXML

protected abstract void saveCharStreamTaggerToXML(EnhancedXMLStreamWriter writer)
                                           throws XMLStreamException

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.

Parameters:

writer - the xml writer

Throws:

XMLStreamException - could not save to XML

loadHandlerFromXML

protected final 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

loadCharStreamTaggerFromXML

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

Loads configuration settings specific to the implementing class.

Parameters:

xml - xml configuration

Throws:

IOException - could not load from XML

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractImporterHandler

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractImporterHandler

toString

public String toString()

Overrides:

toString in class AbstractImporterHandler