WordDataProvider::WordReadDataProvider Class Reference

Provides a data provider for reading Word documents (.docx format) More...

#include <WordReadDataProvider.qc.dox.h>

Inherits DataProvider::AbstractDataProvider.

Public Member Methods
void	constructor (string path, soft< hash< auto > > opts)
	Creates the WordReadDataProvider with the input data path and optionally an option hash.
void	constructor (InputStream stream, soft< hash< auto > > opts)
	Creates the WordReadDataProvider with the input data stream and optionally an option hash.
void	validateOptions ()
	Validates options for mutual exclusivity.
string	getName ()
	Returns the object name.
void	checkIterator ()
	Common setup code.
AbstractDataProviderRecordIterator	searchRecordsImpl (soft< hash< auto > > where_cond, soft< hash< auto > > search_options)
	Returns an iterator for zero or more records matching the search options.
soft< hash< string, AbstractDataField > >	getRecordTypeImpl (soft< hash< auto > > search_options)
	Returns the description of the record type, if any.
hash< DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.

Public Attributes
const auto	ProviderInfo = ...
	Provider info.
const auto	SearchOptions = ...
	Search options.
const auto	ConstructorOptions = ...
	Constructor options.

Private Attributes
InputStream	i
	The input stream for the Word data.
WordIterator	it
	the iterator object
string	path
	The path to the Word file.
string	name
	The name of the object.
string	content_type
	Content type (paragraphs or table)
int	table_index
	Table index for table mode.
bool	dummy
	dummy iterator
soft< hash< auto > >	opts
	Word iteration options.

Detailed Description

Provides a data provider for reading Word documents (.docx format)

Member Function Documentation

constructor() [1/2]

void WordDataProvider::WordReadDataProvider::constructor	(	InputStream	stream,
		soft< hash< auto > >	opts
	)

Creates the WordReadDataProvider with the input data stream and optionally an option hash.

Parameters

stream	the input stream to iterate
opts	a hash of optional options

Exceptions

WORD-READ-OPTION-ERROR

invalid or unknown option; invalid data type for option; "header_row" is True and "headers" is also present

constructor() [2/2]

void WordDataProvider::WordReadDataProvider::constructor	(	string	path,
		soft< hash< auto > >	opts
	)

Creates the WordReadDataProvider with the input data path and optionally an option hash.

Parameters

path	the input file to iterate; will be subjected to environment variable substitution
opts	a hash of optional options

Exceptions

WORD-READ-OPTION-ERROR

invalid or unknown option; invalid data type for option; "header_row" is True and "headers" is also present

searchRecordsImpl()

AbstractDataProviderRecordIterator WordDataProvider::WordReadDataProvider::searchRecordsImpl	(	soft< hash< auto > >	where_cond,
		soft< hash< auto > >	search_options
	)

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/WordDataProvider/WordReadDataProvider.qc.dox.h