com.northconcepts.datapipeline.core

Class LinedTextWriter

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

Direct Known Subclasses:

CSVWriter, FixedWidthWriter, JsonLinesWriter

public abstract class LinedTextWriter
extends TextWriter

Abstract super-class for writing records to a text stream.

Nested Class Summary

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
LinedTextWriter(File file)
LinedTextWriter(File file, boolean append)
LinedTextWriter(Writer writer)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
protected abstract void	assembleLine(Record record, StringBuilder lineBuffer)
String	getNewLine()
LinedTextWriter	setNewLine(String newLine) Assigns the string used between each line (defaults to "\n" on Linux and "\r\n" on Windows).
protected void	writeRecord(Record record)

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

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

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

open, setFieldNamesInFirstRow, writeImpl

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

available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter, getWriter

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, setDescription

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

LinedTextWriter

public LinedTextWriter(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.

LinedTextWriter

public LinedTextWriter(File file)

LinedTextWriter

public LinedTextWriter(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 TextWriter

getNewLine

public String getNewLine()

setNewLine

public LinedTextWriter setNewLine(String newLine)

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

writeRecord

protected final void writeRecord(Record record)
                          throws Throwable

Specified by:

writeRecord in class AbstractWriter

Throws:

Throwable

assembleLine

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

Throws:

Throwable