CurrentDateTransformer

Adds the current computer UTC date to the specified field

importerJavadoc: CurrentDateTransformer

Notes

This functionality allows you to 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.

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

Storing values in an existing field

If a document already has a target field with the same name, new values are appended to the existing list by default. Use onSet to manage this default behavior.

Parser Handler Compatibility

This functionality can be applied as either a pre-parse or post-parse handler.

Locale of Date Formatting

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

Examples

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

YAML

handler:
  class: CurrentDateTransformer
  format: yyyy-MM-dd HH:mm
  toField: crawl_date

JSON

{
  "handler": {
    "class": "CurrentDateTransformer",
    "format": "yyyy-MM-dd HH:mm",
    "toField": "crawl_date"
  }
}

XML

<handler>
  <class>CurrentDateTransformer</class>
  <format>yyyy-MM-dd HH:mm</format>
  <toField>crawl_date</toField>
</handler>

Usage

Full configuration skeleton, with every option and its default

YAML

class: CurrentDateTransformer
format: string
label: string
locale: string
onSet: APPEND
toField: string

JSON

{
  "class": "CurrentDateTransformer",
  "format": "string",
  "label": "string",
  "locale": "string",
  "onSet": "APPEND",
  "toField": "string"
}

XML

<handler>
  <class>CurrentDateTransformer</class>
  <format>string</format>
  <label>string</label>
  <locale>string</locale>
  <onSet>APPEND</onSet>
  <toField>string</toField>
</handler>

Properties

Property	Type	Required	Default
format	string	No	-
label	string	No	-
locale	string	No	-
onSet	enum	No	-
toField	string	No	document.importedDate

Property Details

format

Specifies the format of the date to be added.

label

An optional, user-supplied label for this step in the importer pipeline. It has no effect on processing — it exists purely to help identify this step, for example in large configurations or in the visual configurator.

locale

Specifies the locale used for formatting

onSet

What to do if a target field of the same name already exist.

Allowed Values

• APPEND
• PREPEND
• REPLACE
• OPTIONAL

toField

A target field name used to store the value.