Qore CsvUtil Module Reference  1.10
CsvUtil::CsvReadDataProviderFactory Class Reference

The read-only CSV data provider factory. More...

Inherits AbstractDataProviderFactory.

Private Member Methods

Class getClassImpl ()
 Returns the class for the data provider object.
 
list< hash< auto > > getExampleProviderRecordOutputImpl (InputStream example, *hash< auto > constructor_options)
 Returns information about a data provider constructor given the example data as an argument. More...
 
hash< DataProviderFactoryInfo > getInfoImpl ()
 Returns static factory information without provider_info. More...
 
AbstractDataProvider getProviderFromExampleImpl (InputStream example, *hash< auto > constructor_options)
 Returns a data provider given the example data and constructor options as arguments. More...
 
hash< DataProviderInfo > getProviderInfoImpl ()
 Returns static provider information. More...
 

Private Attributes

const FactoryInfo = ...
 Factory info.
 

Static Private Attributes

static Class cls = new Class("CsvReadDataProvider")
 Data provider type info.
 

Detailed Description

The read-only CSV data provider factory.

Member Function Documentation

◆ getExampleProviderRecordOutputImpl()

list<hash<auto> > CsvUtil::CsvReadDataProviderFactory::getExampleProviderRecordOutputImpl ( InputStream  example,
*hash< auto >  constructor_options 
)
private

Returns information about a data provider constructor given the example data as an argument.

Parameters
exampleexample data to process
constructor_optionsconstructor options for the data provider
Returns
example record data parsed from the given options
Exceptions
DATA-PROVIDER-ERRORinvalid construtor options, API not supported

◆ getInfoImpl()

hash<DataProviderFactoryInfo> CsvUtil::CsvReadDataProviderFactory::getInfoImpl ( )
private

Returns static factory information without provider_info.

Returns
static factory information without provider_info which is provided by getProviderInfo()

◆ getProviderFromExampleImpl()

AbstractDataProvider CsvUtil::CsvReadDataProviderFactory::getProviderFromExampleImpl ( InputStream  example,
*hash< auto >  constructor_options 
)
private

Returns a data provider given the example data and constructor options as arguments.

Parameters
exampleexample data to process
constructor_optionsconstructor options for the data provider
Returns
a data provider created from the given options
Exceptions
DATA-PROVIDER-ERRORinvalid construtor options, API not supported
Note
  • If constructor options provide actual input data, then this overrides the example data, in this way this API can be used for the example and also with real data
  • This base class method throws a DATA-PROVIDER-ERROR exception by default; override in subclasses to implement this method properly
Since
DataProvider 2.1

◆ getProviderInfoImpl()

hash<DataProviderInfo> CsvUtil::CsvReadDataProviderFactory::getProviderInfoImpl ( )
private

Returns static provider information.

Note
the name and children attributes are not returned as they are dynamic attributes