Qore CsvUtil Module Reference 1.10.1
Loading...
Searching...
No Matches
CsvUtil::CsvWriteDataProvider Class Reference

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

#include <CsvWriteDataProvider.qc.dox.h>

Inheritance diagram for CsvUtil::CsvWriteDataProvider:
[legend]

Public Member Methods

 constructor (*hash< auto > options)
 Creates the object from constructor options.
 
 constructor (OutputStream stream, *hash< auto > opts)
 Creates the CsvWriteDataProvider with the output data stream where data will be writeen and an option hash. More...
 
 constructor (string path, *hash< auto > opts)
 Creates the CsvWriteDataProvider with the output path and optionally an option hash. More...
 
string getName ()
 Returns the object name.
 

Public Attributes

const ConstructorOptions
 Constructor options.
 
const CsvGenerationOptionList = keys (ConstructorOptions - ("path", "stream"))
 CSV generation option list.
 
const ProviderInfo
 Provider info.
 

Private Member Methods

*hash< auto > createRecordImpl (hash< auto > rec, *hash< auto > create_options)
 Creates the given record to the data provider. More...
 
*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

AbstractCsvWriter writer
 the writer object
 

Detailed Description

Provides a data provider for reading CSV files.

Member Function Documentation

◆ constructor() [1/2]

CsvUtil::CsvWriteDataProvider::constructor ( OutputStream  stream,
*hash< auto >  opts 
)

Creates the CsvWriteDataProvider with the output data stream where data will be writeen and an option hash.

Parameters
streamthe output stream for writing the data
optsa hash of optional options; see AbstractCsvWriter Constructor Option Hash Overview for more information
Exceptions
CSVSTREAMWRITER-ERRORoption error

◆ constructor() [2/2]

CsvUtil::CsvWriteDataProvider::constructor ( string  path,
*hash< auto >  opts 
)

Creates the CsvWriteDataProvider with the output path and optionally an option hash.

Parameters
paththe output file to write
optsa hash of options; see AbstractCsvWriter Constructor Option Hash Overview for more information
Exceptions
CSVFILEWRITER-ERRORoption error

◆ createRecordImpl()

*hash< auto > CsvUtil::CsvWriteDataProvider::createRecordImpl ( hash< auto >  rec,
*hash< auto >  create_options 
)
private

Creates the given record to the data provider.

Parameters
reca hash representing a single input record
create_optionsthe create options after processing by validateCreateOptions()
Returns
the data written to the data provider