com.screenscraper.csv

Class CsvWriter

java.lang.Object

com.screenscraper.csv.CsvWriter

public class CsvWriter
extends java.lang.Object

Basic Usage:
CsvWriter writer = new CsvWriter( "somefile.csv" );
writer.setHeaderRow( String[] );
writer.writeNext( String[] );
writer.close();

Constructor Summary

Constructors

Constructor and Description
CsvWriter(java.lang.String filePath) Constructs CSVWriter with the given filePath as the output file
CsvWriter(java.lang.String filePath, boolean addTimeStamp) Constructs CSVWriter with the given filePath If the timestamp is set to true, a timestamp will be added to the given filename (yyyy-MM-dd'T'hh'H'mm'M'ss'S')
CsvWriter(java.lang.String filePath, char separator) Constructs CSVWriter with the given filePath and separator.
CsvWriter(java.lang.String filePath, char separator, boolean addTimeStamp) Constructs CSVWriter with the given filePath and separator If the timestamp is set to true, a timestamp will be added to the given filename (yyyy-MM-dd'T'hh'H'mm'M'ss'S')
CsvWriter(java.lang.String filePath, char separator, char quotechar) Constructs CSVWriter with the given filePath, separator and quotchar
CsvWriter(java.lang.String filePath, char separator, char quotechar, char escapechar) Constructs CSVWriter with the given filePath, separator, quote character and escape character
CsvWriter(java.lang.String filePath, char separator, char quotechar, char escapechar, java.lang.String lineEnd) Constructs CSVWriter with supplied separator, quote char, escape char and line ending.
CsvWriter(java.lang.String filePath, char separator, char quotechar, java.lang.String lineEnd) Constructs CSVWriter with the given filePath, separator, quote character, escape character and line end character
CsvWriter(java.io.Writer writer) Constructs CSVWriter with the given writer
CsvWriter(java.io.Writer writer, char separator) Constructs CSVWriter with the given filePath and separator.
CsvWriter(java.io.Writer writer, char separator, char quotechar) Constructs CSVWriter with the given filePath, separator and quotchar
CsvWriter(java.io.Writer writer, char separator, char quotechar, char escapechar) Constructs CSVWriter with the given filePath, separator, quote character and escape character
CsvWriter(java.io.Writer writer, char separator, char quotechar, char escapechar, java.lang.String lineEnd) Constructs CSVWriter with supplied separator, quote char, escape char and line ending.
CsvWriter(java.io.Writer writer, char separator, char quotechar, java.lang.String lineEnd) Constructs CSVWriter with the given filePath, separator, quote character, escape character and line end character

Method Summary

Modifier and Type	Method and Description
void	close() Close the underlying stream writer flushing any buffered content.
void	flush() Flush underlying stream to writer.
java.lang.String	getCsvPath() Returns the path of the file being written to.
java.lang.String[]	getHeaderRow() Returns the header row
java.lang.String[]	getMappingLabels() Returns the mapping labels
void	setAutoCloseAfterScrapeEnds(ScrapingSession session) Tells the writer to close when the scrape ends.
void	setHeader(java.lang.String[] header) Sets the header row to the given String[] and also sets mapping Values to the same String[] The header is only written if the file doesn't originally exist when writing to it.
void	setMapValues(java.lang.String[] mapVals) Set the values used to map the key values of a Map<String, String> into CSV rows.
void	setMapValuesAndLowercaseUnderscore(java.lang.String[] mapVals) Set the mapping values with the given String[], but convert them to lowercase and underscores for spaces eg.
void	setMapValuesAndUnderscore(java.lang.String[] mapVals) Set the mapping values with the given String[], but convert them to have underscores for spaces eg.
void	setMapValuesAndUppercaseUnderscore(java.lang.String[] mapVals) Set the mapping values with the given String[], but convert them to uppercase and underscores for spaces eg.
java.lang.String	toString()
void	write(java.util.List nextLine) Writes the next line to the file.
void	write(java.util.Map nextLine) Writes the next line to the file.
void	write(java.lang.String[] nextLine) Writes the next line to the file.
void	writeAll(DataSet set) Writes all the dataRecords in the set to the CSV (The map values must be set for this to work)
void	writeAll(java.util.List lines) Writes the entire list to a CSV file.
void	writeAll(java.sql.ResultSet rs, boolean includeColumnNames) Writes the entire ResultSet to a CSV file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CsvWriter

public CsvWriter(@NotNull
                 java.lang.String filePath)
          throws java.io.IOException

Constructs CSVWriter with the given filePath as the output file

Parameters:

filePath - the filepath for the underlying CSV source.

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.lang.String filePath,
                 char separator)
          throws java.io.IOException

Constructs CSVWriter with the given filePath and separator.

Parameters:

filePath - the filepath for the underlying CSV source.

separator - the delimiter to use for separating entries.

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.lang.String filePath,
                 boolean addTimeStamp)
          throws java.io.IOException

Constructs CSVWriter with the given filePath If the timestamp is set to true, a timestamp will be added to the given filename (yyyy-MM-dd'T'hh'H'mm'M'ss'S')

Parameters:

filePath - the filepath for the underlying CSV source.

addTimeStamp - whether to add a current time stamp to the filename

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.lang.String filePath,
                 char separator,
                 boolean addTimeStamp)
          throws java.io.IOException

Constructs CSVWriter with the given filePath and separator If the timestamp is set to true, a timestamp will be added to the given filename (yyyy-MM-dd'T'hh'H'mm'M'ss'S')

Parameters:

filePath - the filepath for the underlying CSV source.

separator - the delimiter to use for separating entries.

addTimeStamp - whether to add a current time stamp to the filename

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.lang.String filePath,
                 char separator,
                 char quotechar)
          throws java.io.IOException

Constructs CSVWriter with the given filePath, separator and quotchar

Parameters:

filePath - the filepath for the underlying CSV source.

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.lang.String filePath,
                 char separator,
                 char quotechar,
                 char escapechar)
          throws java.io.IOException

Constructs CSVWriter with the given filePath, separator, quote character and escape character

Parameters:

filePath - the filepath for the underlying CSV source.

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

escapechar - the character to use for escaping quotechars or escapechars

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.lang.String filePath,
                 char separator,
                 char quotechar,
                 java.lang.String lineEnd)
          throws java.io.IOException

Constructs CSVWriter with the given filePath, separator, quote character, escape character and line end character

Parameters:

filePath - the filepath for the underlying CSV source.

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

lineEnd - the line feed terminator to use

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.lang.String filePath,
                 char separator,
                 char quotechar,
                 char escapechar,
                 java.lang.String lineEnd)
          throws java.io.IOException

Constructs CSVWriter with supplied separator, quote char, escape char and line ending.

Parameters:

filePath - the filepath for the underlying CSV source.

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

escapechar - the character to use for escaping quotechars or escapechars

lineEnd - the line feed terminator to use

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.io.Writer writer)
          throws java.io.IOException

Constructs CSVWriter with the given writer

Parameters:

writer - The writer to write to

Throws:

java.io.IOException - On error preparing to write

CsvWriter

public CsvWriter(@NotNull
                 java.io.Writer writer,
                 char separator)
          throws java.io.IOException

Constructs CSVWriter with the given filePath and separator.

Parameters:

writer - The writer to write to

separator - the delimiter to use for separating entries.

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.io.Writer writer,
                 char separator,
                 char quotechar)
          throws java.io.IOException

Constructs CSVWriter with the given filePath, separator and quotchar

Parameters:

writer - The writer to write to

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.io.Writer writer,
                 char separator,
                 char quotechar,
                 char escapechar)
          throws java.io.IOException

Constructs CSVWriter with the given filePath, separator, quote character and escape character

Parameters:

writer - The writer to write to

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

escapechar - the character to use for escaping quotechars or escapechars

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.io.Writer writer,
                 char separator,
                 char quotechar,
                 java.lang.String lineEnd)
          throws java.io.IOException

Constructs CSVWriter with the given filePath, separator, quote character, escape character and line end character

Parameters:

writer - The writer to write to

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

lineEnd - the line feed terminator to use

Throws:

java.io.IOException - If the specified file could not be found

CsvWriter

public CsvWriter(@NotNull
                 java.io.Writer writer,
                 char separator,
                 char quotechar,
                 char escapechar,
                 java.lang.String lineEnd)
          throws java.io.IOException

Constructs CSVWriter with supplied separator, quote char, escape char and line ending.

Parameters:

writer - The writer to write to

separator - the delimiter to use for separating entries

quotechar - the character to use for quoted elements

escapechar - the character to use for escaping quotechars or escapechars

lineEnd - the line feed terminator to use

Throws:

java.io.IOException - If the specified file could not be found

Method Detail

setHeader

public void setHeader(@NotNull
                      java.lang.String[] header)

Sets the header row to the given String[] and also sets mapping Values to the same String[] The header is only written if the file doesn't originally exist when writing to it. The default mapping values are the result of calling setMapValuesAndUppercaseUnderscore

Parameters:

header - The headers to use

setMapValues

public void setMapValues(java.lang.String[] mapVals)

Set the values used to map the key values of a Map<String, String> into CSV rows.

Parameters:

mapVals - The values to use for each header key (in order) when reading values from a map

setMapValuesAndUppercaseUnderscore

public void setMapValuesAndUppercaseUnderscore(@NotNull
                                               java.lang.String[] mapVals)

Set the mapping values with the given String[], but convert them to uppercase and underscores for spaces eg. {"A key", "KEY 2"} becomes the mapping values of {"A_KEY", "KEY_2"}

Parameters:

mapVals - The values to use for each header key (in order) when reading values from a map

setMapValuesAndLowercaseUnderscore

public void setMapValuesAndLowercaseUnderscore(@NotNull
                                               java.lang.String[] mapVals)

Set the mapping values with the given String[], but convert them to lowercase and underscores for spaces eg. {"A key", "KEY 2"} becomes the mapping values of {"a_key", "key_2"}

Parameters:

mapVals - The values to use for each header key (in order) when reading values from a map

setMapValuesAndUnderscore

public void setMapValuesAndUnderscore(@NotNull
                                      java.lang.String[] mapVals)

Set the mapping values with the given String[], but convert them to have underscores for spaces eg. {"A key", "KEY 2"} becomes the mapping values of {"A_key", "KEY_2"}

Parameters:

mapVals - The values to use for each header key (in order) when reading values from a map

writeAll

public void writeAll(@NotNull
                     java.util.List lines)

Writes the entire list to a CSV file. The list is assumed contain String[] or List<String> or List<Map<String, Object>>

Parameters:

lines - a List of String[] or List<String>, each item representing a line of the file.

writeAll

public void writeAll(@NotNull
                     DataSet set)

Writes all the dataRecords in the set to the CSV (The map values must be set for this to work)

Parameters:

set - The DataSet of records to write

write

public void write(@NotNull
                  java.util.List nextLine)

Writes the next line to the file.

Parameters:

nextLine - a list of Strings with each comma-separated element as a separate entry.

write

public void write(@NotNull
                  java.util.Map nextLine)

Writes the next line to the file. (The map values must be set for this to work) Takes a map where the key is mapped to a header row name.

Parameters:

nextLine - a map of String => String

write

public void write(java.lang.String[] nextLine)

Writes the next line to the file.

Parameters:

nextLine - a string array with each comma-separated element as a separate entry.

flush

public void flush()
           throws java.io.IOException

Flush underlying stream to writer.

Throws:

java.io.IOException - if bad things happen

close

public void close()
           throws java.io.IOException

Close the underlying stream writer flushing any buffered content.

Throws:

java.io.IOException - if bad things happen

setAutoCloseAfterScrapeEnds

public void setAutoCloseAfterScrapeEnds(@NotNull
                                        ScrapingSession session)

Tells the writer to close when the scrape ends. Calling this method will close the csv writer automatically when the scrape ends. It will call flush before closing.

Parameters:

session - The current session

writeAll

public void writeAll(@NotNull
                     java.sql.ResultSet rs,
                     boolean includeColumnNames)
              throws java.sql.SQLException,
                     java.io.IOException

Writes the entire ResultSet to a CSV file.

The caller is responsible for closing the ResultSet.

Parameters:

rs - the result set to write

includeColumnNames - true if you want column names in the output, false otherwise

Throws:

java.sql.SQLException - If the result set cannot be read

java.io.IOException - On error writing the data to file

getCsvPath

@Nullable
public java.lang.String getCsvPath()

Returns the path of the file being written to.

Returns:

The path of the file being written to

getHeaderRow

@Nullable
public java.lang.String[] getHeaderRow()

Returns the header row

Returns:

An array of the values in the header row

getMappingLabels

@Nullable
public java.lang.String[] getMappingLabels()

Returns the mapping labels

Returns:

An array of labels used for mapping

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object