com.norconex.importer.handler.tagger.impl

Class CopyTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.CopyTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class CopyTagger
extends AbstractDocumentTagger

Copies metadata fields. If a target field already exists, the values of the original field name will be added, unless "overwrite" is set to true.

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

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.CopyTagger">
  
      <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) -->
      
      <copy fromField="(from field)" toField="(to field)" overwrite="[false|true]" />
      <-- multiple copy tags allowed -->
      
  </tagger>
 

Usage example:

Copies the value of a "creator" and "publisher" fields into an "author" field, adding to any existing values in the "author" field.

  <tagger class="com.norconex.importer.handler.tagger.impl.CopyTagger">
      <copy fromField="creator"   toField="author" overwrite="true" />
      <copy fromField="publisher" toField="author" overwrite="true" />
  </tagger>
 

Since:

1.3.0

Author:

Pascal Dimassimo, Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
CopyTagger()

Method Summary

Modifier and Type	Method and Description
void	addCopyDetails(String fromField, String toField, boolean overwrite) Adds copy instructions.
boolean	equals(Object other)
int	hashCode()
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	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

CopyTagger

public CopyTagger()

Method Detail

tagApplicableDocument

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

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

addCopyDetails

public void addCopyDetails(String fromField,
                           String toField,
                           boolean overwrite)

Adds copy instructions.

Parameters:

fromField - source field name

toField - target field name

overwrite - whether toField overwrite target field if it exists

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