com.northconcepts.datapipeline.core

Class AsyncReader

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.ProxyReader

com.northconcepts.datapipeline.core.AsyncReader

public class AsyncReader
extends ProxyReader

A proxy that reads data asynchronously using a separate thread.

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

DataEndpoint.State

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	lock
static int	MINIMUM_BUFFER_SIZE

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
AsyncReader(DataReader reader)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
protected DataException	addExceptionPropertiesImpl(DataException exception)
int	available() Returns the number of records that can probably be read without blocking.
void	close() Indicates that this endpoint has finished reading or writing.
DataException	exception(String message) Creates an exception with the specified message and containing this endpoint's properties (name-value pairs).
DataException	exception(String message, Throwable exception) Converts an exception to a DataException, prefixing the original message with the specified text and adding this endpoint's properties (name-value pairs).
DataException	exception(Throwable exception) Converts an exception to a DataException and adds this endpoint's properties (name-value pairs).
protected void	fillCache()
long	getBufferSizeInBytes()
DataException	getException()
long	getMaxBufferSizeInBytes()
long	getPeakBufferSizeInBytes()
int	getPriority()
void	open() Makes this endpoint ready for reading or writing.
protected Record	pop() Removes and returns the next record in this DataReaders buffer or null if it is empty.
void	push(Record record) Adds a record to this DataReaders buffer.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
void	rethrowAsyncException() Rethrows the exception thrown by the internal thread or returns silently if no exception was thrown.
AsyncReader	setMaxBufferSizeInBytes(long maxBufferSize)
AsyncReader	setPriority(int priority)

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

getNestedReader, interceptRecord, map, map, setNestedDataReader, setNestedDataReader

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

addLineage, getBufferSize, getNestedEndpoint, getReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, read, setSaveLineage, 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, setDescription

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

getId, getName, resetID

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MINIMUM_BUFFER_SIZE

public static final int MINIMUM_BUFFER_SIZE

See Also:

Constant Field Values

lock

protected final Object lock

Constructor Detail

AsyncReader

public AsyncReader(DataReader reader)

Method Detail

getMaxBufferSizeInBytes

public long getMaxBufferSizeInBytes()

setMaxBufferSizeInBytes

public AsyncReader setMaxBufferSizeInBytes(long maxBufferSize)

getBufferSizeInBytes

public long getBufferSizeInBytes()

getPeakBufferSizeInBytes

public long getPeakBufferSizeInBytes()

getPriority

public int getPriority()

setPriority

public AsyncReader setPriority(int priority)

getException

public DataException getException()

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class ProxyReader

Throws:

DataException

close

public void close()
           throws DataException

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class ProxyReader

Throws:

DataException

push

public void push(Record record)

Description copied from class: DataReader

Adds a record to this DataReaders buffer. Records in the buffer will be returned by DataReader.read() before attempting to read from the underlying implementation.

Overrides:

push in class DataReader

See Also:

DataReader.read()

pop

protected Record pop()

Description copied from class: DataReader

Removes and returns the next record in this DataReaders buffer or null if it is empty.

Overrides:

pop in class DataReader

See Also:

DataReader.push(Record)

available

public int available()
              throws DataException

Description copied from class: DataReader

Returns the number of records that can probably be read without blocking.

Overrides:

available in class ProxyReader

Throws:

DataException

fillCache

protected void fillCache()

rethrowAsyncException

public void rethrowAsyncException()

Rethrows the exception thrown by the internal thread or returns silently if no exception was thrown.

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.

Overrides:

readImpl in class ProxyReader

Throws:

Throwable

exception

public final DataException exception(String message,
                                     Throwable exception)

Description copied from class: DataObject

Converts an exception to a DataException, prefixing the original message with the specified text and adding this endpoint's properties (name-value pairs).

The returned exception can then be thrown in the normal way.

If the supplied exception is an instanceof DataException, it will be returned, otherwise it will be nested inside a DataException. In either case the result message will contain the new prefix along with this endpoint properties.

Overrides:

exception in class DataObject

exception

public final DataException exception(Throwable exception)

Description copied from class: DataObject

Converts an exception to a DataException and adds this endpoint's properties (name-value pairs).

The returned exception can then be thrown in the normal way.

If the supplied exception is an instanceof DataException, it will be returned, otherwise it will be nested inside a DataException. In either case the result message will contain this endpoint properties.

Overrides:

exception in class DataObject

exception

public final DataException exception(String message)

Description copied from class: DataObject

Creates an exception with the specified message and containing this endpoint's properties (name-value pairs).

The returned exception can then be thrown in the normal way.

Overrides:

exception in class DataObject

addExceptionProperties

public final 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 ProxyReader

addExceptionPropertiesImpl

protected DataException addExceptionPropertiesImpl(DataException exception)