com.norconex.importer.handler.tagger.impl

Class TruncateTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.TruncateTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class TruncateTagger
extends AbstractDocumentTagger

Truncates a fromField value(s) and optionally replace truncated portion by a hash value to help ensure uniqueness (not 100% guaranteed to be collision-free). If the field to truncate has multiple values, all values will be subject to truncation. You can store the value(s), truncated or not, in another fromField.

When storing the truncated values in a new fromField already having one or more values, the truncated values will be added to the list of existing values, unless "overwrite" is set to true.

The maxLength is guaranteed to be respected. This means any appended hash code and suffix will fit within the maxLength.

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

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.TruncateTagger"
      fromField="(fromField holding one or more values to truncate)"
      maxLength="(maximum length)"
      toField="(optional fromField where to store the truncated value)"
      overwrite="[false|true]"
      appendHash="[false|true]"
      suffix="(value to append after truncation. Goes before hash if one.)" >
      
      <restrictTo caseSensitive="[false|true]"
              fromField="(name of header/metadata fromField name to match)">
          (regular expression of value to match)
      </restrictTo>
      <!-- multiple "restrictTo" tags allowed (only one needs to match) -->
  </tagger>
 

Usage example:

To truncate this "myField" value...

    Please truncate me before you start thinking I am too long.

...to become this...

    Please truncate me before you start thi!0996700004

...you would set a max length of 50, with a "!" suffix and append a hash. Like this:

  <tagger class="com.norconex.importer.handler.tagger.impl.TruncateTagger"
      fromField="myField"
      maxLength="50"
      appendHash="true"
      suffix="!" />
 

Since:

2.8.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
TruncateTagger()
TruncateTagger(String fromField, int maxLength)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getFromField()
int	getMaxLength()
String	getSuffix()
String	getToField()
int	hashCode()
boolean	isAppendHash()
boolean	isOverwrite()
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	setAppendHash(boolean appendHash)
void	setFromField(String fromField)
void	setMaxLength(int maxLength)
void	setOverwrite(boolean keepOverwrite)
void	setSuffix(String suffix)
void	setToField(String keepToField)
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

TruncateTagger

public TruncateTagger()

TruncateTagger

public TruncateTagger(String fromField,
                      int maxLength)

Method Detail

getToField

public String getToField()

setToField

public void setToField(String keepToField)

isOverwrite

public boolean isOverwrite()

setOverwrite

public void setOverwrite(boolean keepOverwrite)

isAppendHash

public boolean isAppendHash()

setAppendHash

public void setAppendHash(boolean appendHash)

getSuffix

public String getSuffix()

setSuffix

public void setSuffix(String suffix)

getMaxLength

public int getMaxLength()

setMaxLength

public void setMaxLength(int maxLength)

getFromField

public String getFromField()

setFromField

public void setFromField(String fromField)

tagApplicableDocument

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

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

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

toString

public String toString()

Overrides:

toString in class AbstractImporterHandler

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractImporterHandler

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractImporterHandler