Attribute | Description | Allowed Values | Example |
---|
pattern | Multiexcerpt |
---|
| A pattern to identify the record. The pattern is checked before the fields are separated. If no pattern is defined, all records will be parsed. |
| a valid regular expression | ^Pattern.* |
attributeLayout
| Defines the property layout of the flat file record.
| fixed | Fixed property layout. For property values that are shorter than the maximum length of the field, the field is filled with a fill character. As per default, this is blank space, but you can change the fill character in attribute fillCharacter of the FlatFile class (see the Attributes of the FlatFile class above). |
|
separated | Separated property layout. Specify the separator using attributeSeparator (see below). |
pattern | Property layout is specified by a RegEx pattern in attributePattern (see below). |
|
attributePattern | A RegEx pattern to parse the record content into the properties using capture groups. | a valid regular expression | ^(.?)(://)([A-Za-z0-9.])(:[0-9])(/.)$ |
attributeSeparator | Defines the property/field separator. | any character | Use the specified character as property separator. |
|
Comma (, ) | Use the comma (,) as property separator. |
<Tab> | Use tabulator as property separator. |
ignoreEmptyRecords | Boolean value for ignoring empty records. If set to true, no item will be generated, if none of the defined properties or sub records have any content. Info |
---|
Note, that a record containing only empty Strings is not empty – in opposition to a record composed from NULL s. See ignoreEmptyStrings below to skip processing of records containing only empty Strings. |
| true | Ignore empty records. |
|
false | Process empty records. |
suppressEscaping | Boolean value to suppress escaping. If suppressEscaping on a FlatFileRecord is true, FlatFileComplexAttribute that are part of this record will inherit this setting. | true | Property values of this record will not be un-escaped (parser) or escaped (composer) (default). |
|
false
| Escaping/un-escaping is not suppressed. |
composeMacro | Multiexcerpt |
---|
| A macro that is executed while parsing/composing a file or complex field. This macro can contain multiple commands separated by commas or spaces. Macros on classes are executed before the processing of its properties or associations. The ID represents a counter. The following counters are available: - eight automatic counters with ID
AUTO0 .. AUTO7 - two automatic line counters with ID
LINE0 and LINE1 (parsing only) - unlimited custom counters with ID
CUSTOM0 .. CUSTOMx
Automatic counters are increased by 1 for each processed record. Custom counters have to be increased manually using the increase macro. All counters have the initial value of 0 when they process the first record. For more details on macro commands see Using Macro Expressions on Parsing or Composing a Flat File. |
| any valid macro expression (see Using Macro Expressions on Parsing or Composing a Flat File) | GetCounter(AUTO0) |
parseMacro |
lineNumber | Specifies the number of a record in the file. The first record is lineNumber=1, the second lineNumber=2, etc. | any integer |
|
evaluationOrder | Defines the order in which the association of the classes starting on same parent class must be processed. | any integer |
|
ignoreEmptyStrings | Boolean value for ignoring empty string properties. If set to true, empty string values will be processed to NULL . Use this attribute in combination with ignoreEmptyRecords to skip processing of records containing only empty Strings. | true | Ignore empty string values. |
|
false | Preserve empty string values. |