com.norconex.importer.handler.tagger.impl

Class KeepOnlyTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.KeepOnlyTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class KeepOnlyTagger
extends AbstractDocumentTagger

Keep only the metadata fields provided, delete all other ones. Exact field names (case-insensitive) to keep can be provided as well as a regular expression that matches one or many fields (since 2.1.0).

Note: Unless you have good reasons for doing otherwise, it is recommended to use this handler as one of the last ones to be executed. This is a good practice to ensure all metadata fields are available to other handlers that may require them even if they are not otherwise required.

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

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.KeepOnlyTagger">
      
      <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) -->
      
      <fields>(coma-separated list of fields to keep)</fields>
      <fieldsRegex>(regular expression matching fields to keep)</fieldsRegex>
      
  </tagger>
 

Usage example:

The following keeps only the title and description fields from all extracted fields.

  <tagger class="com.norconex.importer.handler.tagger.impl.KeepOnlyTagger">
      <fields>title, description</fields>
  </tagger>
 

Author:

Pascal Essiembre

See Also:

Pattern

Constructor Summary

Constructors

Constructor and Description
KeepOnlyTagger()

Method Summary

Modifier and Type	Method and Description
void	addField(String field)
boolean	equals(Object other)
List<String>	getFields()
String	getFieldsRegex()
int	hashCode()
protected void	loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
void	removeField(String field)
protected void	saveHandlerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	setFieldsRegex(String fieldsRegex)
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

KeepOnlyTagger

public KeepOnlyTagger()

Method Detail

tagApplicableDocument

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

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

getFields

public List<String> getFields()

addField

public void addField(String field)

removeField

public void removeField(String field)

getFieldsRegex

public String getFieldsRegex()

setFieldsRegex

public void setFieldsRegex(String fieldsRegex)

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

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractImporterHandler

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractImporterHandler

toString

public String toString()

Overrides:

toString in class AbstractImporterHandler