com.northconcepts.datapipeline.csv

Class CSVWriter

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataWriter

com.northconcepts.datapipeline.core.AbstractWriter

com.northconcepts.datapipeline.core.TextWriter

com.northconcepts.datapipeline.core.LinedTextWriter

com.northconcepts.datapipeline.csv.CSVWriter

public class CSVWriter
extends LinedTextWriter

Writes records to a Comma Separated Value (CSV) stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CSVWriter.IValuePolicy The interface used by null and empty string writers.
static class	CSVWriter.ValuePolicy The default implementation used to write null and empty string.

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

DataEndpoint.State

Field Summary

Fields inherited from class com.northconcepts.datapipeline.core.AbstractWriter

currentRecord

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
CSVWriter(File file)
CSVWriter(File file, boolean append)
CSVWriter(Writer writer)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
protected void	assembleLine(Record record, StringBuilder lineBuffer)
CSVWriter.IValuePolicy	getEmptyStringValuePolicy() Returns the object responsible for writing empty string values (defaults to ValuePolicy.QUOTED_EMPTY_STRING).
String	getEndingQuote() Returns the string used to mark the ending of text values that may contain commas and other special characters (defaults to double quote - ").
String	getFieldSeparator() Returns the string used between each field value (defaults to comma).
CSVWriter.IValuePolicy	getNullValuePolicy() Returns the object responsible for writing null values (defaults to ValuePolicy.EMPTY_STRING).
String	getQuoteChar() Returns the starting quote - same as calling getStartingQuote() (defaults to double quote - ").
String	getStartingQuote() Returns the string used to mark the beginning of text values that may contain commas and other special characters (defaults to double quote - ").
boolean	isForceQuote() Returns true if all values will be quoted, even if they are not null or empty strings.
CSVWriter	setAutoCloseWriter(boolean autoCloseWriter) Indicates if the underlying java.io.BufferedWriter should be closed when this stream closes (defaults to true).
CSVWriter	setDescription(String description)
CSVWriter	setEmptyStringValuePolicy(CSVWriter.IValuePolicy emptyStringValuePolicy) Assigns the object responsible for writing empty string values (defaults to ValuePolicy.QUOTED_EMPTY_STRING).
CSVWriter	setEndingQuote(String endingQuote) Assigns the string used to mark the ending of text values that may contain commas and other special characters (defaults to double quote - ").
CSVWriter	setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
CSVWriter	setFieldSeparator(char fieldSeparator) Assigns the string used between each field value (defaults to comma).
CSVWriter	setFieldSeparator(String fieldSeparator) Assigns the string used between each field value (defaults to comma).
CSVWriter	setFlushOnWrite(boolean flushOnWrite) Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written (defaults to false).
CSVWriter	setForceQuote(boolean force) Indicates if all values should be quoted, even if they are not null or empty strings.
CSVWriter	setNewLine(String newLine) Assigns the string used between each line (defaults to "\n" on Linux and "\r\n" on Windows).
CSVWriter	setNullValuePolicy(CSVWriter.IValuePolicy nullValuePolicy) Assigns the object responsible for writing null values (defaults to ValuePolicy.EMPTY_STRING).
CSVWriter	setQuoteChar(String quoteChar) Assigns startingQuote and endingQuote to the same value (defaults to double quote - ").
CSVWriter	setStartingQuote(String startingQuote) Assigns the string used to mark the beginning of text values that may contain commas and other special characters (defaults to double quote - ").

Methods inherited from class com.northconcepts.datapipeline.core.LinedTextWriter

getNewLine, writeRecord

Methods inherited from class com.northconcepts.datapipeline.core.TextWriter

close, getFile, getWriter, isAppend, isAutoCloseWriter, isFieldNamesInFirstRow, isFlushOnWrite, write

Methods inherited from class com.northconcepts.datapipeline.core.AbstractWriter

open, writeImpl

Methods inherited from class com.northconcepts.datapipeline.core.DataWriter

available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVWriter

public CSVWriter(File file,
                 boolean append)

Parameters:

file -

append - Indicates if writing should start at the end of the file (if it exists). If the specified file exists and has contents (more than 0 bytes), then the fieldNamesInFirstRow property will be set to false.

CSVWriter

public CSVWriter(File file)

CSVWriter

public CSVWriter(Writer writer)

Method Detail

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: Endpoint

Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

Overrides:

addExceptionProperties in class LinedTextWriter

setNewLine

public CSVWriter setNewLine(String newLine)

Assigns the string used between each line (defaults to "\n" on Linux and "\r\n" on Windows).

Overrides:

setNewLine in class LinedTextWriter

setForceQuote

public CSVWriter setForceQuote(boolean force)

Indicates if all values should be quoted, even if they are not null or empty strings.

isForceQuote

public boolean isForceQuote()

Returns true if all values will be quoted, even if they are not null or empty strings.

Returns:

True if enabled, false otherwise

getFieldSeparator

public String getFieldSeparator()

Returns the string used between each field value (defaults to comma).

setFieldSeparator

public CSVWriter setFieldSeparator(char fieldSeparator)

Assigns the string used between each field value (defaults to comma).

setFieldSeparator

public CSVWriter setFieldSeparator(String fieldSeparator)

Assigns the string used between each field value (defaults to comma).

getQuoteChar

public String getQuoteChar()

Returns the starting quote - same as calling getStartingQuote() (defaults to double quote - "). getStartingQuote()

setQuoteChar

public CSVWriter setQuoteChar(String quoteChar)

Assigns startingQuote and endingQuote to the same value (defaults to double quote - "). setStartingQuote(String) setEndingQuote(String)

getStartingQuote

public String getStartingQuote()

Returns the string used to mark the beginning of text values that may contain commas and other special characters (defaults to double quote - ").

setStartingQuote

public CSVWriter setStartingQuote(String startingQuote)

Assigns the string used to mark the beginning of text values that may contain commas and other special characters (defaults to double quote - ").

getEndingQuote

public String getEndingQuote()

Returns the string used to mark the ending of text values that may contain commas and other special characters (defaults to double quote - ").

setEndingQuote

public CSVWriter setEndingQuote(String endingQuote)

Assigns the string used to mark the ending of text values that may contain commas and other special characters (defaults to double quote - ").

getNullValuePolicy

public CSVWriter.IValuePolicy getNullValuePolicy()

Returns the object responsible for writing null values (defaults to ValuePolicy.EMPTY_STRING).

See Also:

CSVWriter.ValuePolicy.EMPTY_STRING

setNullValuePolicy

public CSVWriter setNullValuePolicy(CSVWriter.IValuePolicy nullValuePolicy)

Assigns the object responsible for writing null values (defaults to ValuePolicy.EMPTY_STRING).

See Also:

CSVWriter.ValuePolicy.EMPTY_STRING

getEmptyStringValuePolicy

public CSVWriter.IValuePolicy getEmptyStringValuePolicy()

Returns the object responsible for writing empty string values (defaults to ValuePolicy.QUOTED_EMPTY_STRING).

See Also:

CSVWriter.ValuePolicy.QUOTED_EMPTY_STRING

setEmptyStringValuePolicy

public CSVWriter setEmptyStringValuePolicy(CSVWriter.IValuePolicy emptyStringValuePolicy)

Assigns the object responsible for writing empty string values (defaults to ValuePolicy.QUOTED_EMPTY_STRING).

See Also:

CSVWriter.ValuePolicy.QUOTED_EMPTY_STRING

setAutoCloseWriter

public CSVWriter setAutoCloseWriter(boolean autoCloseWriter)

Description copied from class: TextWriter

Indicates if the underlying java.io.BufferedWriter should be closed when this stream closes (defaults to true).

Overrides:

setAutoCloseWriter in class TextWriter

setFlushOnWrite

public CSVWriter setFlushOnWrite(boolean flushOnWrite)

Description copied from class: TextWriter

Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written (defaults to false).

Overrides:

setFlushOnWrite in class TextWriter

setFieldNamesInFirstRow

public CSVWriter setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

Overrides:

setFieldNamesInFirstRow in class AbstractWriter

setDescription

public CSVWriter setDescription(String description)

Overrides:

setDescription in class Endpoint

assembleLine

protected void assembleLine(Record record,
                            StringBuilder lineBuffer)
                     throws Throwable

Specified by:

assembleLine in class LinedTextWriter

Throws:

Throwable