com.northconcepts.datapipeline.core

Class TextWriter

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

Direct Known Subclasses:

JsonWriter, LinedTextWriter, MySqlInsertWriter, PostgreSqlInsertWriter, SimpleJsonWriter, SimpleXmlWriter, TemplateWriter, XmlWriter

public abstract class TextWriter
extends AbstractWriter

Abstract super-class for writing records to a text stream. Unike TextStreamWriter, this writer has the concept of fieldNamesInFirstRow and assumes the output is line based.

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

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
File	getFile()
BufferedWriter	getWriter()
boolean	isAppend() Indicates if writing should start at the end of the file (if it exists).
boolean	isAutoCloseWriter() Indicates if the underlying java.io.BufferedWriter should be closed when this stream closes (defaults to true).
boolean	isFieldNamesInFirstRow()
boolean	isFlushOnWrite() Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written.
TextWriter	setAutoCloseWriter(boolean autoCloseWriter) Indicates if the underlying java.io.BufferedWriter should be closed when this stream closes (defaults to true).
TextWriter	setFlushOnWrite(boolean flushOnWrite) Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written (defaults to false).
void	write(Record record) Writes the specified record to this DataWriter and increases the record-count by 1.

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

open, setFieldNamesInFirstRow, writeImpl, writeRecord

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

TextWriter

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

TextWriter

public TextWriter(File file)

TextWriter

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

getWriter

public BufferedWriter getWriter()

getFile

public File getFile()

isFieldNamesInFirstRow

public boolean isFieldNamesInFirstRow()

Overrides:

isFieldNamesInFirstRow in class AbstractWriter

isAppend

public boolean isAppend()

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.

See Also:

AbstractWriter.setFieldNamesInFirstRow(boolean), isFieldNamesInFirstRow()

isAutoCloseWriter

public boolean isAutoCloseWriter()

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

setAutoCloseWriter

public TextWriter setAutoCloseWriter(boolean autoCloseWriter)

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

isFlushOnWrite

public boolean isFlushOnWrite()

Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written.

setFlushOnWrite

public TextWriter setFlushOnWrite(boolean flushOnWrite)

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

close

public void close()

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint

write

public void write(Record record)
           throws DataException

Description copied from class: DataWriter

Writes the specified record to this DataWriter and increases the record-count by 1. Any exception raised while writing will be converted to a DataException using DataObject.exception(Throwable).

Subclasses generally do not need to override this method, instead they should implement DataWriter.writeImpl(Record).

Overrides:

write in class AbstractWriter

Throws:

DataException