com.northconcepts.datapipeline.file

Class FileWriter

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.file.FileWriter

public class FileWriter
extends DataWriter

Writes records to a binary stream that can be later read using a FileReader.

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.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
FileWriter(DataOutput out)
FileWriter(File file)
FileWriter(File file, boolean append)
FileWriter(File file, boolean append, boolean compressed)
FileWriter(OutputStream outputStream, boolean compressed)

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.
boolean	isAppend() Indicates if writing should start at the end of the file (if it exists).
boolean	isAutoCloseWriter() Indicates if the underlying output stream should be closed when this stream closes (defaults to true).
boolean	isCompressed() Indicates if the data should be compressed as it is being written (default false).
boolean	isFlushOnWrite() Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written.
FileWriter	setAutoCloseWriter(boolean autoCloseWriter) Indicates if the underlying output stream should be closed when this stream closes (defaults to true).
FileWriter	setFlushOnWrite(boolean flushOnWrite) Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written.
static Record	write(DataOutput out, Record record)
protected void	writeImpl(Record record) Overridden by subclasses to write the specified record to this DataWriter.

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

available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter, write

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

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, open, 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

FileWriter

public FileWriter(File file,
                  boolean append,
                  boolean compressed)

Parameters:

file - the file to write or append to.

append - Indicates if writing should start at the end of the file (if it exists).

compressed - Indicates if the data should be compressed as it is being written (default false).

FileWriter

public FileWriter(OutputStream outputStream,
                  boolean compressed)

Parameters:

outputStream - the stream to write to.

compressed - Indicates if the data should be compressed as it is being written.

FileWriter

public FileWriter(File file,
                  boolean append)

FileWriter

public FileWriter(File file)

FileWriter

public FileWriter(DataOutput out)

Method Detail

write

public static Record write(DataOutput out,
                           Record record)

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 DataWriter

isAppend

public boolean isAppend()

Indicates if writing should start at the end of the file (if it exists).

isFlushOnWrite

public boolean isFlushOnWrite()

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

setFlushOnWrite

public FileWriter setFlushOnWrite(boolean flushOnWrite)

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

isAutoCloseWriter

public boolean isAutoCloseWriter()

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

setAutoCloseWriter

public FileWriter setAutoCloseWriter(boolean autoCloseWriter)

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

isCompressed

public boolean isCompressed()

Indicates if the data should be compressed as it is being written (default false).

close

public void close()

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint

writeImpl

protected void writeImpl(Record record)
                  throws Throwable

Description copied from class: DataWriter

Overridden by subclasses to write the specified record to this DataWriter.

Specified by:

writeImpl in class DataWriter

Throws:

Throwable