TextBetweenOperation

A start/end delimiter pair defining a text region to extract and store.

importerJavadoc: TextBetweenOperation

Notes

Defines a pair of start and end string matchers used by the TextBetweenTransformer to identify and extract a region of text. The extracted text is stored in the specified target field. The inclusive flag controls whether the matched delimiters are included in the extracted value.

Usage

YAML

endMatcher:
  ignoreCase: false
  ignoreDiacritic: false
  matchEmpty: false
  method: BASIC
  negateMatches: false
  partial: false
  pattern: string
  replaceAll: false
  trim: false
fieldMatcher:
  ignoreCase: false
  ignoreDiacritic: false
  matchEmpty: false
  method: BASIC
  negateMatches: false
  partial: false
  pattern: string
  replaceAll: false
  trim: false
inclusive: false
onSet: APPEND
startMatcher:
  ignoreCase: false
  ignoreDiacritic: false
  matchEmpty: false
  method: BASIC
  negateMatches: false
  partial: false
  pattern: string
  replaceAll: false
  trim: false
toField: string

JSON

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

XML

<textBetweenOperation>
  <endMatcher>
    <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>
  </endMatcher>
  <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>
  <inclusive>false</inclusive>
  <onSet>APPEND</onSet>
  <startMatcher>
    <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>
  </startMatcher>
  <toField>string</toField>
</textBetweenOperation>

Properties

Property	Type	Required	Default
endMatcher	TextMatcher	No	TextMatcher
fieldMatcher	TextMatcher	No	TextMatcher
inclusive	boolean	No	false
onSet	enum	No	-
startMatcher	TextMatcher	No	TextMatcher
toField	string	No	-

Property Details

endMatcher

Matcher for the text that closes the region to extract. The text between the first startMatcher hit and the next endMatcher hit becomes the extracted value.

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.

inclusive

Whether the delimiters themselves are part of the extracted value. Default is false, which returns only the text between them.

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

startMatcher

Restricts which start references are processed, based on a pattern match against each reference.

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.