Sparksee  5.2.0
STSCSVWriter Class Reference

CSVWriter interface. More...

Inheritance diagram for STSCSVWriter:
Inheritance graph
Collaboration diagram for STSCSVWriter:
Collaboration graph

Instance Methods

(id) - init
 Creates a new instance.
 
(void) - setSeparator:
 Sets the character used to separate fields in the file.
 
(void) - setQuotes:
 Sets the character used to quote fields.
 
(void) - setAutoQuotes:
 Sets on/off the automatic quote mode.
 
(void) - setForcedQuotes:
 Disables the automatic quote mode and forces to be quoted those positions set to TRUE in the given vector.
 
(void) - setLocale:
 Sets the locale that will be used to write the file.
 
(void) - open:
 Opens the output file path.
 
(void) - write:
 Writes the next row.
 
(void) - close
 Closes the writer.
 

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

Method Documentation

- (void) close

Closes the writer.

Exceptions
System.IO.IOExceptionIf the close fails.
System.ApplicationExceptionnull

Implements STSRowWriter.

- (void) open: (NSString *)  f

Opens the output file path.

Parameters
f[in] Output file path.
Exceptions
System.IO.IOExceptionIf bad things happen opening the file.
- (void) 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.
- (void) setForcedQuotes: (STSBooleanList *)  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) setLocale: (NSString *)  localeStr

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

Parameters
localeStr[in] The locale string for the file encoding.
- (void) setQuotes: (NSString *)  quotes

Sets the character used to quote fields.

Parameters
quotes[in] Quote character.
Exceptions
System.ApplicationExceptionnull
- (void) setSeparator: (NSString *)  sep

Sets the character used to separate fields in the file.

Parameters
sep[in] Separator character.
Exceptions
System.ApplicationExceptionnull
- (void) write: (STSStringList *)  row

Writes the next row.

Parameters
row[in] Row of data.
Exceptions
System.IO.IOExceptionIf bad things happen during the write.
System.ApplicationExceptionnull

Implements STSRowWriter.


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