Qore CsvUtil Module Reference  1.5
CsvUtil::CsvFileWriter Class Reference

The CsvFileWriter class for safe CSV file creation. More...

Inheritance diagram for CsvUtil::CsvFileWriter:

Public Member Functions

 constructor (string path, *hash opts)
 creates the CsvFileWriter in single-type mode with the path of the file to read and an optional option hash More...
 
 constructor (string path, hash spec, hash opts)
 creates the CsvFileWriter in multi-type mode with the path of the file to read with an option hash More...
 
private writeRawLine (list values)
 This method must be overridden in child classes to provide the output implementation.
 
- Public Member Functions inherited from CsvUtil::AbstractCsvWriter
 constructor (string n_errname, *hash n_opts)
 Creates the AbstractCsvWriter in single-type mode. More...
 
 constructor (string n_errname, hash spec, hash n_opts)
 Creates the AbstractCsvWriter in single-type mode. More...
 
private string prepareRawLine (list values)
 Prepare a string (line with EOF) with formatting and escaping. More...
 
private processCommonOptions (*hash n_opts, int C_OPTx)
 Process options and set internal variables.
 
private processSpec ()
 Process specification and set internal variable for mapping.
 
 write (Qore::AbstractIterator iterator)
 Stream an iterator into the output. More...
 
 write (Qore::SQL::SQLStatement iterator)
 Stream an iterator into the output. More...
 
 write (list l)
 Stream the contents of the list into the output. More...
 
private writeHeaders ()
 Write csv headers.
 
 writeLine (list values)
 Write a line with a list of values; data are checked against column rules. More...
 
 writeLine (hash values)
 Write a line with headers-values hash. More...
 
 writeLine (string type, list values)
 Write a line with headers-values list. More...
 
 writeLine (string type, hash values)
 Write a line for a specific record from a hash to the output. More...
 

Detailed Description

The CsvFileWriter class for safe CSV file creation.

Member Function Documentation

CsvUtil::CsvFileWriter::constructor ( string  path,
*hash  opts 
)

creates the CsvFileWriter in single-type mode with the path of the file to read and an optional option hash

Parameters
patha file name (with path optionally) to write
optsAbstractCsvWriter Constructor Option Hash Overview

The file is created with O_CREAT, O_TRUNC, O_WRONLY and 0644 access.

Exceptions
CSVFILEITER-ERRORin the case of incorrect options
CsvUtil::CsvFileWriter::constructor ( string  path,
hash  spec,
hash  opts 
)

creates the CsvFileWriter in multi-type mode with the path of the file to read with an option hash

Parameters
patha file name (with path optionally) to write
speca hash of field and type definition; see Option Field Hash for more information
optsAbstractCsvWriter Constructor Option Hash Overview

The file is created with O_CREAT, O_TRUNC, O_WRONLY and 0644 access.

Exceptions
CSVFILEITER-ERRORin the case of incorrect options