SplitOperation

A single value split operation for the SplitTransformer.

importerJavadoc: SplitOperation

Notes

Defines a single value split operation for the SplitTransformer. Specifies source fields, the separator character or regex used to split values, and an optional target field for storing the resulting multiple values.

Usage

YAML

fieldMatcher:
  ignoreCase: false
  ignoreDiacritic: false
  matchEmpty: false
  method: BASIC
  negateMatches: false
  partial: false
  pattern: string
  replaceAll: false
  trim: false
onSet: APPEND
separator: string
separatorRegex: false
toField: string

JSON

{
  "fieldMatcher": {
    "ignoreCase": false,
    "ignoreDiacritic": false,
    "matchEmpty": false,
    "method": "BASIC",
    "negateMatches": false,
    "partial": false,
    "pattern": "string",
    "replaceAll": false,
    "trim": false
  },
  "onSet": "APPEND",
  "separator": "string",
  "separatorRegex": false,
  "toField": "string"
}

XML

<splitOperation>
  <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>
  <onSet>APPEND</onSet>
  <separator>string</separator>
  <separatorRegex>false</separatorRegex>
  <toField>string</toField>
</splitOperation>

Properties

Property	Type	Required	Default
fieldMatcher	TextMatcher	No	TextMatcher
onSet	enum	No	-
separator	string	No	-
separatorRegex	boolean	No	false
toField	string	No	-

Property Details

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.

onSet

Defines what to do when the target field already has one or more values. When unspecified, new values are appended to existing ones by default.

Allowed Values

• APPEND
• PREPEND
• REPLACE
• OPTIONAL

separator

The delimiter each value is split on. Interpreted literally unless separatorRegex is true.

separatorRegex

Whether separator is a regular expression rather than literal text. Default is false. Turn it on to split on a pattern — \s*;\s* to tolerate spaces around a semicolon, for instance.

toField

The target metadata field name where the extracted or computed value will be stored. If a field of the same name already exists, the behavior is controlled by onSet.