RenameOperation

A single field rename operation mapping source field names to a new name.

importerJavadoc: RenameOperation

Notes

Defines a single field rename operation for the RenameTransformer. Specifies which source fields to match and the target field name to rename them to. When using regex patterns, the target field name can include back-references (e.g., $1).

Usage

YAML

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

JSON

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

XML

<renameOperation>
  <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>
  <toField>string</toField>
</renameOperation>

Properties

Property	Type	Required	Default
fieldMatcher	TextMatcher	No	TextMatcher
onSet	enum	No	-
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

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.