 |
Qore CsvUtil Module Reference
1.6.2
|
|
Qore CsvUtil Module Reference
1.6.2
|
The CsvFileIterator class allows CSV files to be iterated on a record basis. More...
Public Member Methods | |
| constructor (string path, *hash opts) | |
| Creates the CsvFileIterator in single-type mode with the path of the file to read and an option hash. More... | |
| constructor (string path, hash spec, hash opts) | |
| Creates the CsvFileIterator in multi-type mode with the path of the file to read and optionally an option hash. More... | |
| string | getEncoding () |
| Returns the character encoding for the file. | |
| string | getFileName () |
| Returns the file path/name used to open the file. | |
| hash< Qore::StatInfo > | hstat () |
| Returns a StatInfo hash of the underlying file. | |
| auto | memberGate (string name) |
| calls AbstractCsvIterator::memberGate() | |
| list | stat () |
| Returns a stat list of the underlying file. | |
 Public Member Methods inherited from CsvUtil::AbstractCsvIterator | |
| constructor (AbstractLineIterator li, *hash opts) | |
| creates the AbstractCsvIterator with an option hash in single-type mode More... | |
| constructor (AbstractLineIterator li, hash spec, hash opts) | |
| creates the AbstractCsvIterator with an option hash in multi-type mode More... | |
| *list | getHeaders () |
| Returns the current record headers or NOTHING if no headers have been detected or saved yet. More... | |
| *list | getHeaders (string type) |
| Returns a list of headers for the given record or NOTHING if the record is not recognized. More... | |
| string | getQuote () |
| Returns the current quote string. More... | |
| string | getRawLine () |
| Returns the current line 'as it is', i.e. the original string. More... | |
| list | getRawLineValues () |
| Returns the list of raw string values of the current line. More... | |
| hash | getRecord (bool extended) |
| Returns the current record as a hash. More... | |
| hash | getRecord () |
| Returns the current record as a hash. More... | |
| auto | getRecordList () |
| Returns the current record as a list. More... | |
| string | getSeparator () |
| Returns the current separator string. More... | |
| hash | getValue () |
| Returns the current record as a hash. More... | |
| string | identifyType (list rec) |
| Identify a fixed-length line type using identifyTypeImpl(); may be overridden if necessary. More... | |
| int | index () |
| Returns the row index being iterated, which does not necessarily correspond to the line number when there are header rows and blank lines are skipped. More... | |
| int | lineNumber () |
| Returns the current iterator line number in the file (the first line is line 1) or 0 if not pointing at a valid element. More... | |
| auto | memberGate (string name) |
| Returns the given column value for the current row. More... | |
| bool | next () |
| Moves the current line / record position to the next line / record; returns False if there are no more lines to iterate. More... | |
Private Attributes | |
| string | m_file_path |
| the path of the file being iterated | |
| Private Attributes inherited from CsvUtil::AbstractCsvIterator | |
| const | Options |
| valid options for the object (a hash for quick lookups of valid keys) | |
Additional Inherited Members | |
| Private Member Methods inherited from CsvUtil::AbstractCsvIterator | |
| list | getLineAndSplit () |
| Read line split by separator/quote into list. | |
| *string | identifyTypeImpl (list rec) |
| Identify a input record, given the raw line string. This method performs a lookup to a precalculated table based on number of records (see constructor()). In case different criteria are needed, eg. when two line types in a spec have the same record number and no unique resolving rule are specified, this method needs to be overridden, otherwise it will throw an exception because the precalculated mapping will be empty. More... | |
| hash | parseLine () |
| Parses a line in the file and returns a processed list of the fields. | |
| prepareFieldsFromHeaders (*list headers) | |
| match headers provided at csv header or in options, never called for multi-type because header_names is False | |
| processCommonOptions (*hash opts, int C_OPTx) | |
| process common options and and assing internal fields | |
| processSpec (hash spec) | |
| process specification and assing internal data for resolving | |
The CsvFileIterator class allows CSV files to be iterated on a record basis.
The class is deprecated as CsvIterator provides more flexibility.
Creates the CsvFileIterator in single-type mode with the path of the file to read and an option hash.
| path | the path to the CSV file to read |
| opts | a hash of optional options; see AbstractCsvIterator Constructor Option Hash Overview for more information |
| ABSTRACTCSVITERATOR-ERROR | invalid or unknown option; invalid data type for option; "header_names" is True and "header_lines" is 0 or "headers" is also present; unknown field type |
Creates the CsvFileIterator in multi-type mode with the path of the file to read and optionally an option hash.
| path | the path to the CSV file to read |
| spec | a hash of field and type definition; see Option Field Hash for more information |
| opts | a hash of optional options; see AbstractCsvIterator Constructor Option Hash Overview for more information |