Provides a data provider for reading CSV files.
More...
#include <CsvReadDataProvider.qc.dox.h>
Inherits DataProvider::AbstractDataProvider.
|
| constructor (*hash< auto > options) |
| Creates the object from constructor options.
|
|
| constructor (InputStream stream, *hash< auto > opts) |
| Creates the CsvReadDataProvider with the input data stream and optionally an option hash.
|
|
| constructor (string path, *hash< auto > opts) |
| Creates the CsvReadDataProvider with the input data path and optionally an option hash.
|
|
string | getName () |
| Returns the object name.
|
|
|
const | ConstructorOptions |
| Constructor options.
|
|
const | CsvIterationOptionList = keys (ConstructorOptions - ("path", "stream")) |
| CSV iteration option list.
|
|
const | ProviderInfo |
| Provider info.
|
|
|
*hash< string, AbstractDataField > | getRecordTypeImpl (*hash< auto > search_options) |
| Returns the description of the record type, if any.
|
|
hash< DataProviderInfo > | getStaticInfoImpl () |
| Returns data provider static info.
|
|
AbstractDataProviderRecordIterator | searchRecordsImpl (*hash< auto > where_cond, *hash< auto > search_options) |
| Returns an iterator for zero or more records matching the search options.
|
|
AbstractDataProviderRecordIterator | searchRecordsImpl (*hash< DataProviderExpression > where_cond, *hash< auto > search_options) |
| Returns an iterator for zero or more records matching the search options.
|
|
Provides a data provider for reading CSV files.
Supports generic record search operators and options
◆ constructor() [1/2]
CsvUtil::CsvReadDataProvider::constructor |
( |
InputStream |
stream, |
|
|
*hash< auto > |
opts |
|
) |
| |
Creates the CsvReadDataProvider with the input data stream and optionally an option hash.
- Parameters
-
- Exceptions
-
ABSTRACTCSVITERATOR-ERROR | invalid or unknown option; invalid data type for option; "header_names" is True and "headers" is also present; unknown field type |
◆ constructor() [2/2]
CsvUtil::CsvReadDataProvider::constructor |
( |
string |
path, |
|
|
*hash< auto > |
opts |
|
) |
| |
Creates the CsvReadDataProvider with the input data path and optionally an option hash.
- Parameters
-
- Exceptions
-
ABSTRACTCSVITERATOR-ERROR | invalid or unknown option; invalid data type for option; "header_names" is True and "headers" is also present; unknown field type |
◆ searchRecordsImpl() [1/2]
AbstractDataProviderRecordIterator CsvUtil::CsvReadDataProvider::searchRecordsImpl |
( |
*hash< auto > |
where_cond, |
|
|
*hash< auto > |
search_options |
|
) |
| |
|
protected |
Returns an iterator for zero or more records matching the search options.
- Parameters
-
where_cond | the search criteria |
search_options | the search options after processing by validateSearchOptions() |
◆ searchRecordsImpl() [2/2]
AbstractDataProviderRecordIterator CsvUtil::CsvReadDataProvider::searchRecordsImpl |
( |
*hash< DataProviderExpression > |
where_cond, |
|
|
*hash< auto > |
search_options |
|
) |
| |
|
protected |
Returns an iterator for zero or more records matching the search options.
- Parameters
-
where_cond | the search criteria |
search_options | the search options after processing by validateSearchOptions() |