com.northconcepts.datapipeline.fixedwidth

Class FixedWidthReader

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataReader

com.northconcepts.datapipeline.core.AbstractReader

com.northconcepts.datapipeline.core.TextReader

com.northconcepts.datapipeline.fixedwidth.FixedWidthReader

public class FixedWidthReader
extends TextReader

Obtains records from 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.TextReader

EOF, reader

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

currentRecord, fieldNames, lastRow, startingRow

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

fieldLineage, recordLineage

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
FixedWidthReader(File file)
FixedWidthReader(Reader reader)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
FixedWidthReader	addField(FixedWidthField field)
FixedWidthReader	addField(String name, int width)
FixedWidthReader	addField(String name, int width, FixedWidthAlign align, char fillChar)
FixedWidthReader	addFields(int... width)
protected Record	addLineage(Record record)
protected boolean	fillRecord(Record record)
char	getFillChar()
boolean	isLastFieldConsumesRemaining()
boolean	isLineageSupported()
void	open() Makes this endpoint ready for reading or writing.
FixedWidthReader	setDescription(String description)
FixedWidthReader	setFieldNames(Collection<String> fieldNames)
FixedWidthReader	setFieldNames(String... fieldNames)
FixedWidthReader	setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)
FixedWidthReader	setFillChar(char fillChar)
FixedWidthReader	setLastFieldConsumesRemaining(boolean lastFieldConsumesRemaining) Set whether the last field in each record will contain the rest of each line.
FixedWidthReader	setLastRow(int lastRow)
FixedWidthReader	setSaveLineage(boolean saveLineage)
FixedWidthReader	setSkipEmptyRows(boolean skipEmptyRows) Indicates that rows with only null values should not be returned by the reader (default is false).
FixedWidthReader	setStartingRow(int startingRow)
FixedWidthReader	skipField(int width)

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

available, close, getFile, getLineNumber, readImpl

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

getFieldNames, getLastRow, getStartingRow, isFieldNamesInFirstRow, isSkipEmptyRows, read

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

getBufferSize, getNestedEndpoint, getNestedReader, getRootEndpoint, getRootReader, isExhausted, isSaveLineage, peek, pop, push, skip

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

FixedWidthReader

public FixedWidthReader(File file)

FixedWidthReader

public FixedWidthReader(Reader reader)

Method Detail

getFillChar

public char getFillChar()

setFillChar

public FixedWidthReader setFillChar(char fillChar)

isLastFieldConsumesRemaining

public boolean isLastFieldConsumesRemaining()

setLastFieldConsumesRemaining

public FixedWidthReader setLastFieldConsumesRemaining(boolean lastFieldConsumesRemaining)

Set whether the last field in each record will contain the rest of each line. Default is false.

addField

public FixedWidthReader addField(FixedWidthField field)

addFields

public FixedWidthReader addFields(int... width)

addField

public FixedWidthReader addField(String name,
                                 int width)

addField

public FixedWidthReader addField(String name,
                                 int width,
                                 FixedWidthAlign align,
                                 char fillChar)

skipField

public FixedWidthReader skipField(int width)

setFieldNamesInFirstRow

public FixedWidthReader setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

Overrides:

setFieldNamesInFirstRow in class AbstractReader

setFieldNames

public FixedWidthReader setFieldNames(String... fieldNames)

Overrides:

setFieldNames in class AbstractReader

setFieldNames

public FixedWidthReader setFieldNames(Collection<String> fieldNames)

Overrides:

setFieldNames in class AbstractReader

setStartingRow

public FixedWidthReader setStartingRow(int startingRow)

Overrides:

setStartingRow in class AbstractReader

setLastRow

public FixedWidthReader setLastRow(int lastRow)

Overrides:

setLastRow in class AbstractReader

setSkipEmptyRows

public FixedWidthReader setSkipEmptyRows(boolean skipEmptyRows)

Description copied from class: AbstractReader

Indicates that rows with only null values should not be returned by the reader (default is false).

Overrides:

setSkipEmptyRows in class AbstractReader

setSaveLineage

public FixedWidthReader setSaveLineage(boolean saveLineage)

Overrides:

setSaveLineage in class DataReader

setDescription

public FixedWidthReader setDescription(String description)

Overrides:

setDescription in class Endpoint

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 TextReader

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class TextReader

Throws:

DataException

fillRecord

protected boolean fillRecord(Record record)
                      throws Throwable

Specified by:

fillRecord in class AbstractReader

Throws:

Throwable

isLineageSupported

public boolean isLineageSupported()

Overrides:

isLineageSupported in class DataReader

addLineage

protected Record addLineage(Record record)

Overrides:

addLineage in class TextReader