Qore CsvUtil Module Reference 1.10.1
Loading...
Searching...
No Matches
CsvUtil::CsvReadDataProvider Class Reference

Provides a data provider for reading CSV files. More...

#include <CsvReadDataProvider.qc.dox.h>

Inheritance diagram for CsvUtil::CsvReadDataProvider:
[legend]

Public Member Methods

 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. More...
 
 constructor (string path, *hash< auto > opts)
 Creates the CsvReadDataProvider with the input data path and optionally an option hash. More...
 
string getName ()
 Returns the object name.
 

Public Attributes

const ConstructorOptions
 Constructor options.
 
const CsvIterationOptionList = keys (ConstructorOptions - ("path", "stream"))
 CSV iteration option list.
 
const ProviderInfo
 Provider info.
 

Private Member Methods

*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. More...
 
AbstractDataProviderRecordIterator searchRecordsImpl (*hash< DataProviderExpression > where_cond, *hash< auto > search_options)
 Returns an iterator for zero or more records matching the search options. More...
 

Private Attributes

AbstractCsvIterator i
 the iterator object
 

Detailed Description

Provides a data provider for reading CSV files.

Supports generic record search operators and options

Member Function Documentation

◆ 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
streamthe input stream to iterate
optsa hash of optional options; see AbstractCsvIterator Constructor Option Hash Overview for more information
Exceptions
ABSTRACTCSVITERATOR-ERRORinvalid 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
paththe input file to iterate
optsa hash of optional options; see AbstractCsvIterator Constructor Option Hash Overview for more information
Exceptions
ABSTRACTCSVITERATOR-ERRORinvalid 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 
)
private

Returns an iterator for zero or more records matching the search options.

Parameters
where_condthe search criteria
search_optionsthe search options after processing by validateSearchOptions()

◆ searchRecordsImpl() [2/2]

AbstractDataProviderRecordIterator CsvUtil::CsvReadDataProvider::searchRecordsImpl ( *hash< DataProviderExpression >  where_cond,
*hash< auto >  search_options 
)
private

Returns an iterator for zero or more records matching the search options.

Parameters
where_condthe search criteria
search_optionsthe search options after processing by validateSearchOptions()