DateCondition

Evaluates to true when a document date field falls within a specified date range.

importerJavadoc: DateCondition

Notes

Evaluates to true when a matching document date field falls within a specified date range or satisfies a date comparison. Supports custom date formats, time zones, and configurable range start and end matchers.

Usage

YAML

class: DateCondition
conditionZoneId: string
docZoneId: string
fieldMatcher:
  ignoreCase: false
  ignoreDiacritic: false
  matchEmpty: false
  method: BASIC
  negateMatches: false
  partial: false
  pattern: string
  replaceAll: false
  trim: false
format: string
label: string
valueMatcher:
  date: string
  operator: gt
  zoneId: string
valueMatcherRangeEnd:
  date: string
  operator: gt
  zoneId: string

JSON

{
  "class": "DateCondition",
  "conditionZoneId": "string",
  "docZoneId": "string",
  "fieldMatcher": {
    "ignoreCase": false,
    "ignoreDiacritic": false,
    "matchEmpty": false,
    "method": "BASIC",
    "negateMatches": false,
    "partial": false,
    "pattern": "string",
    "replaceAll": false,
    "trim": false
  },
  "format": "string",
  "label": "string",
  "valueMatcher": {
    "date": "string",
    "operator": "gt",
    "zoneId": "string"
  },
  "valueMatcherRangeEnd": {
    "date": "string",
    "operator": "gt",
    "zoneId": "string"
  }
}

XML

<condition>
  <class>DateCondition</class>
  <conditionZoneId>string</conditionZoneId>
  <docZoneId>string</docZoneId>
  <fieldMatcher>
    <ignoreCase>false</ignoreCase>
    <ignoreDiacritic>false</ignoreDiacritic>
    <matchEmpty>false</matchEmpty>
    <method>BASIC</method>
    <negateMatches>false</negateMatches>
    <partial>false</partial>
    <pattern>string</pattern>
    <replaceAll>false</replaceAll>
    <trim>false</trim>
  </fieldMatcher>
  <format>string</format>
  <label>string</label>
  <valueMatcher>
    <date>string</date>
    <operator>gt</operator>
    <zoneId>string</zoneId>
  </valueMatcher>
  <valueMatcherRangeEnd>
    <date>string</date>
    <operator>gt</operator>
    <zoneId>string</zoneId>
  </valueMatcherRangeEnd>
</condition>

Properties

Property	Type	Required	Default
conditionZoneId	string	No	-
docZoneId	string	No	-
fieldMatcher	TextMatcher	No	TextMatcher
format	string	No	-
label	string	No	-
valueMatcher	DateValueMatcher	No	-
valueMatcherRangeEnd	DateValueMatcher	No	-

Property Details

conditionZoneId

The default time zone applied to condition dates that do not specify their own. This applies to the dates supplied in valueMatcher and valueMatcherRangeEnd when those date expressions carry no explicit zone. A zone set directly on a value matcher takes precedence over this value, and document field values keep their own zone (use docZoneId to force one on them instead). When neither a matcher zone nor this value is set, condition dates default to UTC. Accepts any IANA time zone id (for example, America/New_York) or a zone offset.

docZoneId

Time zone applied to document dates that carry none of their own, such as America/New_York or UTC. It has no effect on values whose format already includes a zone. Defaults to UTC, which matters once you compare at hour or minute granularity.

fieldMatcher

Matches document fields based on specified patterns and methods. Use this to restrict the handler to operate only on fields whose names satisfy the matcher criteria.

format

Pattern describing how the date is written in the document field, using DateTimeFormatter syntax — yyyy-MM-dd, yyyy-MM-dd'T'HH:mm:ssZ, and so on. When unset, field values are read as EPOCH milliseconds. Values that do not parse are treated as non-matching.

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.

valueMatcher

Matches document field values based on specified patterns and methods. Use this to restrict the handler to operate only on fields whose values satisfy the matcher criteria.

valueMatcherRangeEnd

The upper boundary of the value range for range-based matching.