com.norconex.importer.handler.tagger.impl

Class ForceSingleValueTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.ForceSingleValueTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class ForceSingleValueTagger
extends AbstractDocumentTagger

Forces a metadata field to be single-value. The action can be one of the following:

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

    keepFirst          Keeps the first occurrence found.
    keepLast           Keeps the first occurrence found.
    mergeWith:<sep>    Merges all occurrences, joining them with the
                       specified separator (<sep>). 
 

If you do not specify any action, the default behavior is to merge all occurrences, joining values with a comma.

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.ForceSingleValueTagger">
  
      <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) -->
  
      <singleValue field="FIELD_NAME" action="[keepFirst|keepLast|mergeWith:<separator>]"/>
      <!-- multiple single value fields allowed -->
      
  </tagger>
 

Usage example:

For documents where multiple title fields are found, the following only keeps the first title value captured.

  <tagger class="com.norconex.importer.handler.tagger.impl.ForceSingleValueTagger">
      <singleValue field="title" action="keepFirst"/>
  </tagger>
 

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
ForceSingleValueTagger()

Method Summary

Modifier and Type	Method and Description
void	addSingleValueField(String field, String action)
boolean	equals(Object other)
Map<String,String>	getSingleValueFields()
int	hashCode()
protected void	loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
void	removeSingleValueField(String name)
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

ForceSingleValueTagger

public ForceSingleValueTagger()

Method Detail

tagApplicableDocument

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

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

getSingleValueFields

public Map<String,String> getSingleValueFields()

addSingleValueField

public void addSingleValueField(String field,
                                String action)

removeSingleValueField

public void removeSingleValueField(String name)

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