com.norconex.importer.handler.tagger.impl

Class ConstantTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.ConstantTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class ConstantTagger
extends AbstractDocumentTagger

Define and add constant values to documents. To add multiple constant values under the same constant name, repeat the constant entry with a different value.

Conflict resolution

If a field with the same name already exists for a document, the constant value(s) will be added to the list of already existing values.

Since 2.7.0, it is possible to change this default behavior with setOnConflict(OnConflict). Possible values are:

• add: add the constant value(s) to any existing ones (default).
• replace: replace any existing values with constant ones.
• noop: No operation (does nothing).

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

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.ConstantTagger"
          onConflict="[add|replace|noop]" >
  
      <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) -->

      <constant name="CONSTANT_NAME">Constant Value</constant>
      <!-- multiple constant tags allowed -->
      
  </tagger>
 

Usage example:

Adds a constant to incoming documents to identify they were web documents.

  <tagger class="com.norconex.importer.handler.tagger.impl.ConstantTagger">
      <constant name="source">web</constant>
  </tagger>
 

Author:

Pascal Essiembre

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConstantTagger.OnConflict

Field Summary

Fields

Modifier and Type	Field and Description
static ConstantTagger.OnConflict	DEFAULT_ON_CONFLICT

Constructor Summary

Constructors

Constructor and Description
ConstantTagger()

Method Summary

Modifier and Type	Method and Description
void	addConstant(String name, String value)
boolean	equals(Object other)
Map<String,List<String>>	getConstants()
ConstantTagger.OnConflict	getOnConflict() Gets the conflict resolution strategy.
int	hashCode()
protected void	loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
void	removeConstant(String name)
protected void	saveHandlerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	setOnConflict(ConstantTagger.OnConflict onConflict) Sets the conflict resolution strategy.
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

Field Detail

DEFAULT_ON_CONFLICT

public static final ConstantTagger.OnConflict DEFAULT_ON_CONFLICT

Constructor Detail

ConstantTagger

public ConstantTagger()

Method Detail

tagApplicableDocument

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

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

getOnConflict

public ConstantTagger.OnConflict getOnConflict()

Gets the conflict resolution strategy.

Returns:

conflict resolution strategy

Since:

2.7.0

setOnConflict

public void setOnConflict(ConstantTagger.OnConflict onConflict)

Sets the conflict resolution strategy.

Parameters:

onConflict - conflict resolution strategy.

Since:

2.7.0

getConstants

public Map<String,List<String>> getConstants()

addConstant

public void addConstant(String name,
                        String value)

removeConstant

public void removeConstant(String name)

loadHandlerFromXML

protected void loadHandlerFromXML(org.apache.commons.configuration.XMLConfiguration 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(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