CSVWriter Class Reference
[Io]

CSVWriter interface. More...

Inheritance diagram for CSVWriter:

Inheritance graph
Collaboration diagram for CSVWriter:

Collaboration graph

List of all members.

Public Member Functions

 CSVWriter ()
 Creates a new instance.
void SetSeparator (const std::wstring &sep) throw (sparksee::gdb::Error)
 Sets the character used to separate fields in the file.
void SetQuotes (const std::wstring &quotes) throw (sparksee::gdb::Error)
 Sets the character used to quote fields.
void SetAutoQuotes (sparksee::gdb::bool_t autoquotes)
 Sets on/off the automatic quote mode.
void SetForcedQuotes (sparksee::gdb::BooleanList &forcequotes)
 Disables the automatic quote mode and forces to be quoted those positions set to TRUE in the given vector.
void SetLocale (const std::wstring &localeStr)
 Sets the locale that will be used to write the file.
void Open (const std::wstring &f) throw (sparksee::gdb::IOException)
 Opens the output file path.
void Write (sparksee::gdb::StringList &row) throw (sparksee::gdb::IOException, sparksee::gdb::Error)
 Writes the next row.
void Close () throw (sparksee::gdb::IOException, sparksee::gdb::Error)
 Closes the writer.
virtual ~CSVWriter ()
 Destructor.


Detailed Description

CSVWriter interface.

A very simple CSV writer implementing RowWriter.

It works as any other RowWriter, but open must be called once before the first write operation.

It uses the format RFC 4180: http://tools.ietf.org/html/rfc4180

You can use your own separators and quote characters. By default the separator is the comma (,) and the quote character is the double quotes (") and autoquote is enabled.

See the CSVReader locale documentation or the SPARKSEE User Manual.

Check out the 'Data export' section in the SPARKSEE User Manual for more details on this.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

void CSVWriter::SetSeparator ( const std::wstring &  sep  )  throw (sparksee::gdb::Error)

Sets the character used to separate fields in the file.

Parameters:
sep [in] Separator character.

void CSVWriter::SetQuotes ( const std::wstring &  quotes  )  throw (sparksee::gdb::Error)

Sets the character used to quote fields.

Parameters:
quotes [in] Quote character.

void CSVWriter::SetAutoQuotes ( sparksee::gdb::bool_t  autoquotes  ) 

Sets on/off the automatic quote mode.

If there are forced quotes, setting autoquotes on will clear them. If the autoquotes is set to off and no forced quotes are provided, there will not be any quote.

Parameters:
autoquotes [in] If TRUE it enables the automatic quote mode, if FALSE it disables it.

void CSVWriter::SetForcedQuotes ( sparksee::gdb::BooleanList &  forcequotes  ) 

Disables the automatic quote mode and forces to be quoted those positions set to TRUE in the given vector.

Parameters:
forcequotes [in] A booleanList with the position for each column that must be quoted set to true.

void CSVWriter::SetLocale ( const std::wstring &  localeStr  ) 

Sets the locale that will be used to write the file.

Parameters:
localeStr [in] The locale string for the file encoding.

void CSVWriter::Open ( const std::wstring &  f  )  throw (sparksee::gdb::IOException)

Opens the output file path.

Parameters:
f [in] Output file path.
Exceptions:
IOException If bad things happen opening the file.

void CSVWriter::Write ( sparksee::gdb::StringList &  row  )  throw (sparksee::gdb::IOException, sparksee::gdb::Error) [virtual]

Writes the next row.

Parameters:
row [in] Row of data.
Exceptions:
IOException If bad things happen during the write.

Implements RowWriter.

void CSVWriter::Close (  )  throw (sparksee::gdb::IOException, sparksee::gdb::Error) [virtual]

Closes the writer.

Exceptions:
IOException If the close fails.

Implements RowWriter.


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

Generated on Tue Jun 2 13:44:08 2015 for Sparksee by  doxygen 1.5.6