TextCondition

Evaluates to true when document text content or field values match a configured expression.

importerJavadoc: TextCondition

Notes

Evaluates to true when the text content of a document or matching metadata fields satisfies a configured value matcher. Supports matching against document content or specific field values with a configurable read size limit.

Usage

YAML

class: TextCondition
fieldMatcher:
  ignoreCase: false
  ignoreDiacritic: false
  matchEmpty: false
  method: BASIC
  negateMatches: false
  partial: false
  pattern: string
  replaceAll: false
  trim: false
label: string
maxReadSize: 0
sourceCharset: string
valueMatcher:
  ignoreCase: false
  ignoreDiacritic: false
  matchEmpty: false
  method: BASIC
  negateMatches: false
  partial: false
  pattern: string
  replaceAll: false
  trim: false

JSON

{
  "class": "TextCondition",
  "fieldMatcher": {
    "ignoreCase": false,
    "ignoreDiacritic": false,
    "matchEmpty": false,
    "method": "BASIC",
    "negateMatches": false,
    "partial": false,
    "pattern": "string",
    "replaceAll": false,
    "trim": false
  },
  "label": "string",
  "maxReadSize": 0,
  "sourceCharset": "string",
  "valueMatcher": {
    "ignoreCase": false,
    "ignoreDiacritic": false,
    "matchEmpty": false,
    "method": "BASIC",
    "negateMatches": false,
    "partial": false,
    "pattern": "string",
    "replaceAll": false,
    "trim": false
  }
}

XML

<condition>
  <class>TextCondition</class>
  <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>
  <label>string</label>
  <maxReadSize>0</maxReadSize>
  <sourceCharset>string</sourceCharset>
  <valueMatcher>
    <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>
  </valueMatcher>
</condition>

Properties

Property	Type	Required	Default
fieldMatcher	TextMatcher	No	TextMatcher
label	string	No	-
maxReadSize	integer	No	10000000
sourceCharset	string	No	-
valueMatcher	TextMatcher	No	TextMatcher

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.

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.

maxReadSize

The maximum number of characters to read from the document content at once. Use this to limit memory usage when processing large documents.

sourceCharset

Sets the character encoding of the source document to ensure proper reading and processing.

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.