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

Class UUIDTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.UUIDTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class UUIDTagger
extends AbstractDocumentTagger

Generates a random Universally unique identifier (UUID) and stores it in the specified field. If no field is provided, the UUID will be added to document.uuid.

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.

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

XML configuration usage:

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

XML usage example:

<handler
    class="UUIDTagger"
    field="uuid"
    onSet="replace"/>

The above generates a UUID and stores it in a "uuid" field, overwriting any existing values under that field.

Since:

2.7.0

Author:

Pascal Essiembre

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_FIELD

Constructor Summary

Constructors

Constructor	Description
UUIDTagger()	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
String	getField()	Deprecated. Since 3.0.0, use getToField()
PropertySetter	getOnSet()	Gets the property setter to use when a value is set.
String	getToField()	Gets the target field.
int	hashCode()
boolean	isOverwrite()	Deprecated. Since 3.0.0 use getOnSet().
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	setField(String toField)	Deprecated. Since 3.0.0, use setToField(String)
void	setOnSet(PropertySetter onSet)	Sets the property setter to use when a value is set.
void	setOverwrite(boolean overwrite)	Deprecated. Since 3.0.0 use setOnSet(PropertySetter).
void	setToField(String toField)	Sets the target field.
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

Field Detail

DEFAULT_FIELD

public static final String DEFAULT_FIELD

See Also:

Constant Field Values

Constructor Detail

UUIDTagger

public UUIDTagger()

Constructor.

Method Detail

tagApplicableDocument

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

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

getToField

public String getToField()

Gets the target field.

Returns:

target field

Since:

3.0.0

setToField

public void setToField(String toField)

Sets the target field.

Parameters:

toField - target field

Since:

3.0.0

getField

@Deprecated
public String getField()

Deprecated.

Since 3.0.0, use getToField()

Gets the target field.

Returns:

target field

setField

@Deprecated
public void setField(String toField)

Deprecated.

Since 3.0.0, use setToField(String)

Sets the target field.

Parameters:

toField - target field

isOverwrite

@Deprecated
public boolean isOverwrite()

Deprecated.

Since 3.0.0 use getOnSet().

Gets whether existing value for the same field should be overwritten.

Returns:

true if overwriting existing value.

setOverwrite

@Deprecated
public void setOverwrite(boolean overwrite)

Deprecated.

Since 3.0.0 use setOnSet(PropertySetter).

Sets whether existing value for the same field should be overwritten.

Parameters:

overwrite - true if overwriting existing value.

getOnSet

public PropertySetter getOnSet()

Gets the property setter to use when a value is set.

Returns:

property setter

Since:

3.0.0

setOnSet

public void setOnSet(PropertySetter onSet)

Sets the property setter to use when a value is set.

Parameters:

onSet - property setter

Since:

3.0.0

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