Package com.norconex.importer.handler.tagger.impl

Class RenameTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.RenameTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class RenameTagger
extends AbstractDocumentTagger

Rename metadata fields to different names.

Storing values in an existing field

If a target field with the same name already exists for a document, values will be added to the end of the existing value list. It is possible to change this default behavior by supplying a PropertySetter.

When using regular expressions, "toField" can also hold replacement patterns (e.g. $1, $2, etc).

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

XML configuration usage:

<handler
    class="com.norconex.importer.handler.tagger.impl.RenameTagger">
  <!-- multiple "restrictTo" tags allowed (only one needs to match) -->
  <restrictTo>
    <fieldMatcher>(field-matching expression)</fieldMatcher>
    <valueMatcher>(value-matching expression)</valueMatcher>
  </restrictTo>
  <!-- multiple rename tags allowed -->
  <rename
      toField="(to field)">
    <fieldMatcher>(one or more matching fields to rename)</fieldMatcher>
  </rename>
</handler>

XML usage example:

<handler
    class="RenameTagger">
  <rename
      toField="title"
      onSet="replace">
    <fieldMatcher>dc.title</fieldMatcher>
  </rename>
</handler>

The above example renames a "dc.title" field to "title", overwriting any existing values in "title".

Author:

Pascal Essiembre

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RenameTagger.RenameDetails

Constructor Summary

Constructors

Constructor	Description
RenameTagger()

Method Summary

Modifier and Type	Method	Description
void	addRename(TextMatcher fieldMatcher, String toField, PropertySetter onSet)
void	addRename(String fromField, String toField, boolean overwrite)	Deprecated.
void	addRename(String fromField, String toField, boolean overwrite, boolean regex)	Deprecated.
boolean	equals(Object other)
int	hashCode()
protected void	loadHandlerFromXML(XML xml)	Loads configuration settings specific to the implementing class.
protected void	saveHandlerToXML(XML xml)	Saves configuration settings specific to the implementing class.
void	tagApplicableDocument(HandlerDoc doc, InputStream document, ParseState parseState)
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

RenameTagger

public RenameTagger()

Method Detail

tagApplicableDocument

public void tagApplicableDocument(HandlerDoc doc,
                                  InputStream document,
                                  ParseState parseState)
                           throws ImporterHandlerException

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

addRename

public void addRename(TextMatcher fieldMatcher,
                      String toField,
                      PropertySetter onSet)

addRename

@Deprecated
public void addRename(String fromField,
                      String toField,
                      boolean overwrite)

Deprecated.

addRename

@Deprecated
public void addRename(String fromField,
                      String toField,
                      boolean overwrite,
                      boolean regex)

Deprecated.

loadHandlerFromXML

protected void loadHandlerFromXML(XML xml)

Description copied from class: AbstractImporterHandler

Loads configuration settings specific to the implementing class.

Specified by:

loadHandlerFromXML in class AbstractImporterHandler

Parameters:

xml - XML configuration

saveHandlerToXML

protected void saveHandlerToXML(XML xml)

Description copied from class: AbstractImporterHandler

Saves configuration settings specific to the implementing class.

Specified by:

saveHandlerToXML in class AbstractImporterHandler

Parameters:

xml - the 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