com.northconcepts.datapipeline.file

Class FileReader

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

public class FileReader
extends DataReader

Obtains records from a binary stream previously written using a FileWriter.

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.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
FileReader(DataInput in)
FileReader(File file)
FileReader(File file, boolean compressed)
FileReader(InputStream inputStream, 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	isAutoCloseReader() Indicates if the underlying input stream should be closed when this stream closes (defaults to true).
boolean	isAutoCloseWriter() Deprecated. use isAutoCloseReader() instead. Indicates if the underlying input stream should be closed when this stream closes (defaults to true).
boolean	isCompressed() Indicates if the data is compressed and should be decompressed as it is being read.
static Record	read(DataInput in, Record record)
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
FileReader	setAutoCloseReader(boolean autoCloseReader) Indicates if the underlying input stream should be closed when this stream closes (defaults to true).
FileReader	setAutoCloseWriter(boolean autoCloseWriter) Deprecated. use setAutoCloseReader(boolean) instead. Indicates if the underlying input stream should be closed when this stream closes (defaults to true).

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

addLineage, available, getBufferSize, getNestedEndpoint, getNestedReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, setSaveLineage, skip

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

FileReader

public FileReader(File file,
                  boolean compressed)

Parameters:

file - the file to read.

compressed - Indicates if the data is compressed and should be decompressed as it is being read.

FileReader

public FileReader(InputStream inputStream,
                  boolean compressed)

Parameters:

compressed - Indicates if the data is compressed and should be decompressed as it is being read.

FileReader

public FileReader(File file)

FileReader

public FileReader(DataInput in)

Method Detail

read

public static Record read(DataInput in,
                          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 DataReader

isAutoCloseReader

public boolean isAutoCloseReader()

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

setAutoCloseReader

public FileReader setAutoCloseReader(boolean autoCloseReader)

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

isAutoCloseWriter

@Deprecated
public boolean isAutoCloseWriter()

Deprecated. use isAutoCloseReader() instead. Indicates if the underlying input stream should be closed when this stream closes (defaults to true).

setAutoCloseWriter

@Deprecated
public FileReader setAutoCloseWriter(boolean autoCloseWriter)

Deprecated. use setAutoCloseReader(boolean) instead. Indicates if the underlying input stream should be closed when this stream closes (defaults to true).

isCompressed

public boolean isCompressed()

Indicates if the data is compressed and should be decompressed as it is being read.

close

public void close()

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint

readImpl

protected Record readImpl()
                   throws Throwable

Description copied from class: DataReader

Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

If no record is available, null will be returned.

Specified by:

readImpl in class DataReader

Throws:

Throwable