Package com.norconex.importer.handler.transformer.impl

Class DateFormatTransformerConfig

java.lang.Object

com.norconex.importer.handler.BaseLabelableConfig

com.norconex.importer.handler.BaseDocHandlerConfig

com.norconex.importer.handler.transformer.impl.DateFormatTransformerConfig

All Implemented Interfaces:

Labelable

public class DateFormatTransformerConfig
extends BaseDocHandlerConfig

Formats a date from any given format to a format of choice, as per the formatting options found on ZonedDateTimeParser with the addition of the format "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.

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 with setOnSet(PropertySetter).

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

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 English.

Multiple fromFormat values can be specified. 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.

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:

See Also:

• DateFormatTransformer configuration reference

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DateFormatTransformerConfig.Fields

Constructor Summary

Constructors

Constructor	Description
DateFormatTransformerConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getFromField()
List<String>	getFromFormats()	Gets the source date formats to match.
Locale	getFromLocale()	The locale used for parsing the source date.
PropertySetter	getOnSet()	The property setter to use when a value is set.
String	getToField()
String	getToFormat()
Locale	getToLocale()	The locale used for formatting the target date.
int	hashCode()
boolean	isKeepBadDates()
DateFormatTransformerConfig	setFromField(String fromField)
DateFormatTransformerConfig	setFromFormats(List<String> fromFormats)	Sets the source date formats to match.
DateFormatTransformerConfig	setFromLocale(Locale fromLocale)	The locale used for parsing the source date.
DateFormatTransformerConfig	setKeepBadDates(boolean keepBadDates)
DateFormatTransformerConfig	setOnSet(PropertySetter onSet)	The property setter to use when a value is set.
DateFormatTransformerConfig	setToField(String toField)
DateFormatTransformerConfig	setToFormat(String toFormat)
DateFormatTransformerConfig	setToLocale(Locale toLocale)	The locale used for formatting the target date.
String	toString()

Methods inherited from class com.norconex.importer.handler.BaseLabelableConfig

getLabel, setLabel

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DateFormatTransformerConfig

public DateFormatTransformerConfig()

Method Details

getFromFormats

public List<String> getFromFormats()

Gets the source date formats to match.

Returns:

source date formats

setFromFormats

public DateFormatTransformerConfig setFromFormats(List<String> fromFormats)

Sets the source date formats to match.

Parameters:

fromFormats - source date formats

getFromField

public String getFromField()

getToField

public String getToField()

getToFormat

public String getToFormat()

getFromLocale

public Locale getFromLocale()

The locale used for parsing the source date.

Returns:

locale

getToLocale

public Locale getToLocale()

The locale used for formatting the target date.

Returns:

locale

isKeepBadDates

public boolean isKeepBadDates()

getOnSet

public PropertySetter getOnSet()

The property setter to use when a value is set.

Returns:

property setter

setFromField

public DateFormatTransformerConfig setFromField(String fromField)

Returns:

this.

setToField

public DateFormatTransformerConfig setToField(String toField)

Returns:

this.

setToFormat

public DateFormatTransformerConfig setToFormat(String toFormat)

Returns:

this.

setFromLocale

public DateFormatTransformerConfig setFromLocale(Locale fromLocale)

The locale used for parsing the source date.

Parameters:

fromLocale - locale

Returns:

this.

setToLocale

public DateFormatTransformerConfig setToLocale(Locale toLocale)

The locale used for formatting the target date.

Parameters:

toLocale - locale

Returns:

this.

setKeepBadDates

public DateFormatTransformerConfig setKeepBadDates(boolean keepBadDates)

Returns:

this.

setOnSet

public DateFormatTransformerConfig setOnSet(PropertySetter onSet)

The property setter to use when a value is set.

Parameters:

onSet - property setter

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class BaseLabelableConfig

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseLabelableConfig

hashCode

public int hashCode()

Overrides:

hashCode in class BaseLabelableConfig

toString

public String toString()

Overrides:

toString in class BaseLabelableConfig