com.norconex.importer.handler.tagger.impl

Class SplitTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.SplitTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class SplitTagger
extends AbstractDocumentTagger

Splits an existing metadata value into multiple values based on a given value separator. The "toField" argument is optional (the same field will be used to store the splits if no "toField" is specified").

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

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.SplitTagger">
  
      <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) -->

      <split fromField="sourceFieldName" toField="targetFieldName" 
               regex="[false|true]">
          <separator>(separator value)</separator>
      </split>
      <!-- multiple split tags allowed -->
      
  </tagger>
 

Usage example:

The following example splits a single value field holding a comma-separated list into multiple values.

  <tagger class="com.norconex.importer.handler.tagger.impl.SplitTagger">
      <split fromField="myField" regex="true">
          <separator>\s*,\s*</separator>
      </split>
  </tagger>
 

Since:

1.3.0

Author:

Pascal Essiembre

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SplitTagger.Split

Constructor Summary

Constructors

Constructor and Description
SplitTagger()

Method Summary

Modifier and Type	Method and Description
void	addSplit(String fromField, String separator, boolean regex)
void	addSplit(String fromField, String toField, String separator, boolean regex)
boolean	equals(Object other)
List<SplitTagger.Split>	getSplits()
int	hashCode()
protected void	loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
void	removeSplit(String fromField)
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

SplitTagger

public SplitTagger()

Method Detail

tagApplicableDocument

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

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

getSplits

public List<SplitTagger.Split> getSplits()

removeSplit

public void removeSplit(String fromField)

addSplit

public void addSplit(String fromField,
                     String separator,
                     boolean regex)

addSplit

public void addSplit(String fromField,
                     String toField,
                     String separator,
                     boolean regex)

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