Class CSVWriter

java.lang.Object
com.sparsity.sparksee.io.RowWriter
com.sparsity.sparksee.io.CSVWriter
public class CSVWriter extends RowWriter
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

  • Constructor Details

    • CSVWriter

      public CSVWriter()
      Creates a new instance.

  • Method Details

    • setSeparator

      public void setSeparator(String sep) throws RuntimeException
      Sets the character used to separate fields in the file.

      Parameters:
      sep - [in] Separator character.
      Throws:
      RuntimeException - For any issue

    • setAutoQuotes

      public void setAutoQuotes(boolean 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.

    • open

      public void open(String f) throws IOException
      Opens the output file path.

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

    • write

      public void write(StringList row) throws RuntimeException, IOException
      Writes the next row.

      ErrorFor any issue

      Overrides:
      write in class RowWriter
      Parameters:
      row - [in] Row of data.
      Throws:
      RuntimeException - null
      IOException - If bad things happen during the write.

    • setForcedQuotes

      public void setForcedQuotes(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.

    • close

      public void close() throws RuntimeException, IOException
      Closes the writer.

      ErrorFor any issue

      Overrides:
      close in class RowWriter
      Throws:
      RuntimeException - null
      IOException - If the close fails.

    • setLocale

      public void setLocale(String localeStr)
      Sets the locale that will be used to write the file.

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

    • setQuotes

      public void setQuotes(String quotes) throws RuntimeException
      Sets the character used to quote fields.

      Parameters:
      quotes - [in] Quote character.
      Throws:
      RuntimeException - For any issue