com.northconcepts.datapipeline.fixedwidth

Class FixedWidthWriter

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.fixedwidth.FixedWidthWriter

public class FixedWidthWriter
extends LinedTextWriter

Writes records to a fixed width 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
FixedWidthWriter(File file)
FixedWidthWriter(File file, boolean append)
FixedWidthWriter(Writer writer)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
FixedWidthWriter	addField(FixedWidthField field)
FixedWidthWriter	addField(int width, FixedWidthAlign align, char fillChar)
FixedWidthWriter	addFields(int... width)
protected void	assembleLine(Record record, StringBuilder lineBuffer)
char	getFillChar()
boolean	isTruncateFields()
FixedWidthWriter	setAutoCloseWriter(boolean autoCloseWriter) Indicates if the underlying java.io.BufferedWriter should be closed when this stream closes (defaults to true).
FixedWidthWriter	setDescription(String description)
FixedWidthWriter	setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
FixedWidthWriter	setFillChar(char fillChar)
FixedWidthWriter	setFlushOnWrite(boolean flushOnWrite) Indicates if the underlying java.io.BufferedWriter should be flushed after each record is written (defaults to false).
FixedWidthWriter	setNewLine(String newLine) Assigns the string used between each line (defaults to "\n" on Linux and "\r\n" on Windows).
FixedWidthWriter	setTruncateFields(boolean truncateFields)

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

FixedWidthWriter

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

FixedWidthWriter

public FixedWidthWriter(File file)

FixedWidthWriter

public FixedWidthWriter(Writer writer)

Method Detail

getFillChar

public char getFillChar()

setFillChar

public FixedWidthWriter setFillChar(char fillChar)

isTruncateFields

public boolean isTruncateFields()

setTruncateFields

public FixedWidthWriter setTruncateFields(boolean truncateFields)

addField

public FixedWidthWriter addField(FixedWidthField field)

addFields

public FixedWidthWriter addFields(int... width)

addField

public FixedWidthWriter addField(int width,
                                 FixedWidthAlign align,
                                 char fillChar)

setFieldNamesInFirstRow

public FixedWidthWriter setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

Overrides:

setFieldNamesInFirstRow in class AbstractWriter

setDescription

public FixedWidthWriter setDescription(String description)

Overrides:

setDescription in class Endpoint

setNewLine

public FixedWidthWriter setNewLine(String newLine)

Description copied from class: LinedTextWriter

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

Overrides:

setNewLine in class LinedTextWriter

setAutoCloseWriter

public FixedWidthWriter 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 FixedWidthWriter 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

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

assembleLine

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

Specified by:

assembleLine in class LinedTextWriter

Throws:

Throwable