SaxDataProvider::SaxDataProviderFactory Class Reference

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

#include <SaxDataProviderFacory.qc.dox.h>

Inherits AbstractDataProviderFactory.

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

Private Attributes
const auto	FactoryInfo = ...
	Factory info.

Detailed Description

The read-only CSV data provider factory.

Member Function Documentation

getExampleProviderRecordOutputImpl()

list< hash< auto > > SaxDataProvider::SaxDataProviderFactory::getExampleProviderRecordOutputImpl	(	InputStream	example,
		soft< hash< auto > >	constructor_options
	)

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

Parameters

example	example data to process
constructor_options	constructor options for the data provider

Returns

example record data parsed from the given options

Exceptions

DATA-PROVIDER-ERROR

invalid construtor options, API not supported

getInfoImpl()

hash< DataProviderFactoryInfo > SaxDataProvider::SaxDataProviderFactory::getInfoImpl

(

)

Returns static factory information without provider_info.

Returns

static factory information without provider_info which is provided by getProviderInfo

getProviderFromExampleImpl()

AbstractDataProvider SaxDataProvider::SaxDataProviderFactory::getProviderFromExampleImpl	(	InputStream	example,
		soft< hash< auto > >	constructor_options
	)

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

Parameters

example	example data to process
constructor_options	constructor options for the data provider

Returns

a data provider created from the given options

Exceptions

DATA-PROVIDER-ERROR

invalid 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 > SaxDataProvider::SaxDataProviderFactory::getProviderInfoImpl

(

)

Returns static provider information.

Note

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

---

The documentation for this class was generated from the following file:

• doxygen/qlib/SaxDataProvider/SaxDataProviderFacory.qc.dox.h