com.norconex.importer.handler.tagger

Class AbstractDocumentTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

Direct Known Subclasses:

AbstractCharStreamTagger, CharacterCaseTagger, CharsetTagger, ConstantTagger, CopyTagger, CurrentDateTagger, DateFormatTagger, DebugTagger, DeleteTagger, DocumentLengthTagger, DOMTagger, FieldReportTagger, ForceSingleValueTagger, HierarchyTagger, KeepOnlyTagger, MergeTagger, RenameTagger, ReplaceTagger, SplitTagger, TruncateTagger, UUIDTagger

public abstract class AbstractDocumentTagger
extends AbstractImporterHandler
implements IDocumentTagger

Base class for taggers.

Subclasses inherit this IXMLConfigurable configuration:

  <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) -->
 

Since:

2.0.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentTagger()

Method Summary

Modifier and Type	Method and Description
protected abstract void	tagApplicableDocument(String reference, InputStream document, ImporterMetadata metadata, boolean parsed)
void	tagDocument(String reference, InputStream document, ImporterMetadata metadata, boolean parsed) Tags a document with extra metadata information.

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

addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, equals, getRestrictions, hashCode, isApplicable, loadFromXML, loadHandlerFromXML, removeRestriction, removeRestriction, saveHandlerToXML, saveToXML, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDocumentTagger

public AbstractDocumentTagger()

Method Detail

tagDocument

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

Description copied from interface: IDocumentTagger

Tags a document with extra metadata information.

Specified by:

tagDocument in interface IDocumentTagger

Parameters:

reference - document reference (e.g. URL)

document - document

metadata - document metadata

parsed - whether the document has been parsed already or not (a parsed document should normally be text-based)

Throws:

ImporterHandlerException - problem tagging the document

tagApplicableDocument

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

Throws:

ImporterHandlerException