Qore CsvUtil Module Reference  1.7
CsvUtil::CsvReadDataProvider Class Reference

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

Inherits AbstractDataProvider.

Public Member Functions

 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 ProviderInfo
 Provider info.
 

Protected Member Functions

*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...
 

Protected Attributes

AbstractCsvIterator i
 the iterator object
 

Detailed Description

Provides a data provider for reading CSV files.

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 "header_lines" is 0 or "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 "header_lines" is 0 or "headers" is also present; unknown field type

◆ searchRecordsImpl()

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_condthe search criteria
search_optionsthe search options after processing by validateSearchOptions()