$darkmode
Structured abstract writer for fixed-length lines. More...
Public Member Functions | |
| bool | checkTransition (*string from, *string to) |
| A verification function to be called for each line. This method can be overridden to achieve a begin-to-end validation of the whole input file. More... | |
| constructor (hash< auto > specs, *hash< auto > opts) | |
| creates the FixedLengthAbstractWriter object More... | |
| string | formatLine (hash< auto > line) |
| Formats a single line from a hash describing the record type and its contents. More... | |
| int | linesCount () |
| get processed lines count | |
| abstract | write (hash< auto > line) |
| Renders a single line for a single input record hash to the output. More... | |
| abstract | write (list< auto > lines) |
| iterates the input records and writes rendered versions of all input records to the output More... | |
| abstract | write (Qore::AbstractIterator lines) |
| iterates the input records and writes rendered versions of all input records to the output More... | |
Public Member Functions inherited from FixedLengthUtil::FixedLengthBase | |
| constructor (hash< auto > m_specs, *hash< auto > m_opts) | |
| Creates the object from the record specifications. | |
| *hash< string, AbstractDataField > | getRecordType () |
| Returns the description of the record type, if any. | |
Additional Inherited Members | |
Protected Attributes inherited from FixedLengthUtil::FixedLengthBase | |
| const | GlobalOptionMap |
| Translates from global options to data provider options. | |
| *hash< auto > | m_opts |
| Global input or output options. | |
| hash< auto > | m_specs |
| The record specifications. | |
Structured abstract writer for fixed-length lines.
A verification function to be called for each line. This method can be overridden to achieve a begin-to-end validation of the whole input file.
| from | Type of previous line being processed |
| to | Type of the current line being processed |
creates the FixedLengthAbstractWriter object
| specs | Fixed-length line specification; see Specification Hash for more information |
| opts | Global options; see Global Options for valid values |
Formats a single line from a hash describing the record type and its contents.
| line | a hash describing the record to be formatted; the hash must have the following keys:
|
| INVALID-LINE-DATA | line argument missing either type or record keys |
| INVALID-RECORD | record name (type key in the record hash) not recognized |
| FIELD-INPUT-ERROR | the input value is too large to render into the output field |
| RECORD-TRANSITION-ERROR | a record transition error occurred; an invalid record sequence was given in the input data |
|
pure virtual |
Renders a single line for a single input record hash to the output.
| line | A hash representing input data to be written to the output; the hash must have the following keys:
|
| INVALID-RECORD | record name (type key in the record hash) not recognized |
| FIELD-INPUT-ERROR | the input value is too large to render into the output field |
| RECORD-TRANSITION-ERROR | a record transition error occurred; an invalid record sequence was given in the input data |
Implemented in FixedLengthUtil::FixedLengthWriter, FixedLengthUtil::FixedLengthFileWriter, and FixedLengthUtil::FixedLengthDataWriter.
|
pure virtual |
iterates the input records and writes rendered versions of all input records to the output
| lines | A list of input records; each list value must be a hash with the following keys:
|
| INVALID-RECORD | record name (type key in the record hash) not recognized |
| FIELD-INPUT-ERROR | the input value is too large to render into the output field |
| RECORD-TRANSITION-ERROR | a record transition error occurred; an invalid record sequence was given in the input data |
Implemented in FixedLengthUtil::FixedLengthWriter, FixedLengthUtil::FixedLengthFileWriter, and FixedLengthUtil::FixedLengthDataWriter.
|
pure virtual |
iterates the input records and writes rendered versions of all input records to the output
| lines | An iterator to stream input records; each iterator value must be a hash with the following keys:
|
| INVALID-RECORD | record name (type key in the record hash) not recognized |
| FIELD-INPUT-ERROR | the input value is too large to render into the output field |
| RECORD-TRANSITION-ERROR | a record transition error occurred; an invalid record sequence was given in the input data |
Implemented in FixedLengthUtil::FixedLengthWriter, FixedLengthUtil::FixedLengthFileWriter, and FixedLengthUtil::FixedLengthDataWriter.