com.sparsity.sparksee.io.CSVWriter Class Reference

CSVWriter interface. More...

Inheritance diagram for com.sparsity.sparksee.io.CSVWriter:

Collaboration diagram for com.sparsity.sparksee.io.CSVWriter:

Public Member Functions
	CSVWriter ()
	Creates a new instance.
void	SetSeparator (System.String sep) throws System.ApplicationException
	Sets the character used to separate fields in the file.
void	SetAutoQuotes (bool autoquotes)
	Sets on/off the automatic quote mode.
void	Open (System.String f) throws System.IO.IOException
	Opens the output file path.
void	Write (com.sparsity.sparksee.gdb.StringList row) throws System.ApplicationException, System.IO.IOException
	Writes the next row.
void	SetForcedQuotes (com.sparsity.sparksee.gdb.BooleanList forcequotes)
	Disables the automatic quote mode and forces to be quoted those positions set to TRUE in the given vector.
void	Close () throws System.ApplicationException, System.IO.IOException
	Closes the writer.
void	SetLocale (System.String localeStr)
	Sets the locale that will be used to write the file.
void	SetQuotes (System.String quotes) throws System.ApplicationException
	Sets the character used to quote fields.

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

Close()

void com.sparsity.sparksee.io.CSVWriter.Close

(

)

throws System.ApplicationException, System.IO.IOException

Closes the writer.

ErrorFor any issue

Exceptions

System.ApplicationException	null
System.IO.IOException	If the close fails.

Open()

void com.sparsity.sparksee.io.CSVWriter.Open

(

System.String

f

)

throws System.IO.IOException

Opens the output file path.

Parameters

f	[in] Output file path.

Exceptions

System.IO.IOException

If bad things happen opening the file.

SetAutoQuotes()

void com.sparsity.sparksee.io.CSVWriter.SetAutoQuotes

(

bool

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.

SetForcedQuotes()

void com.sparsity.sparksee.io.CSVWriter.SetForcedQuotes

(

com.sparsity.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.

SetLocale()

void com.sparsity.sparksee.io.CSVWriter.SetLocale

(

System.String

localeStr

)

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

Parameters

localeStr

[in] The locale string for the file encoding.

SetQuotes()

void com.sparsity.sparksee.io.CSVWriter.SetQuotes

(

System.String

quotes

)

throws System.ApplicationException

Sets the character used to quote fields.

Parameters

quotes

[in] Quote character.

Exceptions

System.ApplicationException

For any issue

SetSeparator()

void com.sparsity.sparksee.io.CSVWriter.SetSeparator

(

System.String

sep

)

throws System.ApplicationException

Sets the character used to separate fields in the file.

Parameters

sep	[in] Separator character.

Exceptions

System.ApplicationException

For any issue

Write()

void com.sparsity.sparksee.io.CSVWriter.Write

(

com.sparsity.sparksee.gdb.StringList

row

)

throws System.ApplicationException, System.IO.IOException

Writes the next row.

ErrorFor any issue

Parameters

row	[in] Row of data.

Exceptions

System.ApplicationException	null
System.IO.IOException	If bad things happen during the write.