ExcelDataProvider::ExcelWorksheetReadDataProvider Class Reference

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

#include <ExcelWorksheetReadDataProvider.qc.dox.h>

Inherits DataProvider::AbstractDataProvider.

Public Member Methods
	constructor (InputStream i, string name, string sheet, *hash< auto > opts)
	Creates the ExcelReadDataProvider with the input stream, name, sheet name, and optionally an option hash.
	constructor (string path, string name, string sheet, *hash< auto > opts)
	Creates the ExcelReadDataProvider with the input data path, name, sheet name, and optionally an option hash.
	constructor (*hash< auto > options)
	Creates the object from constructor options.
string	getName ()
	Returns the object name.

Public Attributes
const	ProviderInfo = ...
	Provider info.

Private Member Methods
	setup (string name, string sheet, *hash< auto > opts)
	Common constructor code.
	setOptions ()
	Common setup code.
AbstractDataProviderRecordIterator	searchRecordsImpl (*hash< auto > where_cond, *hash< auto > search_options)
	Returns an iterator for zero or more records matching the search options.
*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.

Private Attributes
ExcelIterator	i
	the iterator object
string	name
	the name of the object
string	sheet
	the name of the worksheet
*hash< auto >	opts
	Excel iteration options.

Detailed Description

Provides a data provider for reading EXCEL files.

Member Function Documentation

constructor() [1/2]

ExcelDataProvider::ExcelWorksheetReadDataProvider::constructor	(	InputStream	i,
		string	name,
		string	sheet,
		*hash< auto >	opts
	)

Creates the ExcelReadDataProvider with the input stream, name, sheet name, and optionally an option hash.

Parameters

i	the input stream
name	the name of the object
sheet	the name of the current worksheet
opts	a hash of optional options, must be already processed for validity

constructor() [2/2]

ExcelDataProvider::ExcelWorksheetReadDataProvider::constructor	(	string	path,
		string	name,
		string	sheet,
		*hash< auto >	opts
	)

Creates the ExcelReadDataProvider with the input data path, name, sheet name, and optionally an option hash.

Parameters

path	the path to the input file
name	the name of the object
sheet	the name of the current worksheet
opts	a hash of optional options, must be already processed for validity

searchRecordsImpl()

AbstractDataProviderRecordIterator ExcelDataProvider::ExcelWorksheetReadDataProvider::searchRecordsImpl ( *hash< auto >  where_cond, *hash< auto >  search_options  )

private

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()

---

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

• doxygen/qlib/ExcelDataProvider/ExcelWorksheetReadDataProvider.qc.dox.h