com.norconex.importer.handler.tagger.impl

Class DateFormatTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.impl.DateFormatTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class DateFormatTagger
extends AbstractDocumentTagger

Formats a date from any given format to a format of choice, as per the formatting options found on SimpleDateFormat with the exception of the string "EPOCH" which represents the difference, measured in milliseconds, between the date and midnight, January 1, 1970. The default format for fromFormat or toFormat when not specified is EPOCH.

When omitting the toField, the value will replace the one in the same field.

If the toField already exists, the newly formatted 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 parsing and 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).

Since 2.6.0, it is possible to specify multiple fromFormat values. Each formats will be tried in the order provided and the first format that succeed in parsing a date will be used. A date will be considered "bad" only if none of the formats could parse the date.

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.DateFormatTagger"
          fromField="(from field)" toField="(to field)" 
          fromLocale="(locale)"    toLocale="(locale)"
          toFormat="(date format)"
          keepBadDates="(false|true)"
          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) -->
      
      <fromFormat>(date format)</fromFormat>
      <!-- multiple "fromFormat" tags allowed (only one needs to match) -->
  </tagger>
 

Usage example:

The following converts a date that is sometimes obtained from the HTTP header "Last-Modified" and sometimes is an EPOCH date, into an Apache Solr date format:

  <tagger class="com.norconex.importer.handler.tagger.impl.DateFormatTagger"
          fromField="Last-Modified"
          toField="solr_date" 
          toFormat="yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" >
      <fromFormat>EEE, dd MMM yyyy HH:mm:ss zzz</fromFormat>
      <fromFormat>EPOCH</fromFormat>
  </tagger>
 

Since:

2.0.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor and Description
DateFormatTagger() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getFromField()
String	getFromFormat() Deprecated. Since 2.6.0, user getFromFormats()
String[]	getFromFormats() Gets the source date formats to match.
Locale	getFromLocale() Gets the locale used for parsing the source date.
String	getToField()
String	getToFormat()
Locale	getToLocale() Gets the locale used for formatting the target date.
int	hashCode()
boolean	isKeepBadDates()
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	setFromField(String fromField)
void	setFromFormat(String fromFormat) Deprecated. Since 2.6.0, user setFromFormats(String...)
void	setFromFormats(String... fromFormats) Sets the source date formats to match.
void	setFromLocale(Locale fromLocale) Sets the locale used for parsing the source date.
void	setKeepBadDates(boolean keepBadDates)
void	setOverwrite(boolean overwrite)
void	setToField(String toField)
void	setToFormat(String toFormat)
void	setToLocale(Locale toLocale) Sets the locale used for formatting the source date.
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

DateFormatTagger

public DateFormatTagger()

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

getFromField

public String getFromField()

setFromField

public void setFromField(String fromField)

getToField

public String getToField()

setToField

public void setToField(String toField)

getFromFormat

@Deprecated
public String getFromFormat()

Deprecated. Since 2.6.0, user getFromFormats()

Gets the source format to match.

Returns:

source date formats

setFromFormat

@Deprecated
public void setFromFormat(String fromFormat)

Deprecated. Since 2.6.0, user setFromFormats(String...)

Sets the source format to match.

Parameters:

fromFormat - source date formats

getFromFormats

public String[] getFromFormats()

Gets the source date formats to match.

Returns:

source date formats

Since:

2.6.0

setFromFormats

public void setFromFormats(String... fromFormats)

Sets the source date formats to match.

Parameters:

fromFormats - source date formats

Since:

2.6.0

getToFormat

public String getToFormat()

setToFormat

public void setToFormat(String toFormat)

isOverwrite

public boolean isOverwrite()

setOverwrite

public void setOverwrite(boolean overwrite)

isKeepBadDates

public boolean isKeepBadDates()

setKeepBadDates

public void setKeepBadDates(boolean keepBadDates)

getFromLocale

public Locale getFromLocale()

Gets the locale used for parsing the source date.

Returns:

locale

Since:

2.5.2

setFromLocale

public void setFromLocale(Locale fromLocale)

Sets the locale used for parsing the source date.

Parameters:

fromLocale - locale

Since:

2.5.2

getToLocale

public Locale getToLocale()

Gets the locale used for formatting the target date.

Returns:

locale

Since:

2.5.2

setToLocale

public void setToLocale(Locale toLocale)

Sets the locale used for formatting the source date.

Parameters:

toLocale - locale

Since:

2.5.2

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