com.norconex.importer.handler.tagger.impl

Class CurrentDateTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.CurrentDateTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class CurrentDateTagger
extends AbstractDocumentTagger

Adds the current computer UTC date to the specified field. If no field is provided, the date will be added to document.importedDate.

The default date format is EPOCH (the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC). A custom date format can be specified with the format attribute, as per the formatting options found on SimpleDateFormat.

If field already has one or more values, the new date will be added to the list of existing values, unless "overwrite" is set to true.

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

Since 2.5.2, it is possible to specify a locale used for formatting dates. The locale is the ISO two-letter language code, with an optional ISO country code, separated with an underscore (e.g., "fr" for French, "fr_CA" for Canadian French). When no locale is specified, the default is "en_US" (US English).

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.CurrentDateTagger"
      field="(target field)"
      format="(date format)"
      locale="(locale)"
      overwrite="[false|true]" >
      
      <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) -->
  </tagger>
 

Usage example:

The following will store the current date along with hours and minutes in a "crawl_date" field.

  <tagger class="com.norconex.importer.handler.tagger.impl.CurrentDateTagger"
      field="crawl_date" format="yyyy-MM-dd HH:mm" />
 

Since:

2.2.0

Author:

Pascal Essiembre

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FIELD

Constructor Summary

Constructors

Constructor and Description
CurrentDateTagger() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getField()
String	getFormat()
Locale	getLocale() Gets the locale used for formatting.
int	hashCode()
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	setField(String toField)
void	setFormat(String toFormat)
void	setLocale(Locale locale) Sets the locale used for formatting.
void	setOverwrite(boolean overwrite)
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_FIELD

public static final String DEFAULT_FIELD

See Also:

Constant Field Values

Constructor Detail

CurrentDateTagger

public CurrentDateTagger()

Constructor.

Method Detail

tagApplicableDocument

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

Specified by:

tagApplicableDocument in class AbstractDocumentTagger

Throws:

ImporterHandlerException

getField

public String getField()

setField

public void setField(String toField)

getFormat

public String getFormat()

setFormat

public void setFormat(String toFormat)

getLocale

public Locale getLocale()

Gets the locale used for formatting.

Returns:

locale

Since:

2.5.2

setLocale

public void setLocale(Locale locale)

Sets the locale used for formatting.

Parameters:

locale - locale

Since:

2.5.2

isOverwrite

public boolean isOverwrite()

setOverwrite

public void setOverwrite(boolean overwrite)

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