com.northconcepts.datapipeline.core

Class ProxyReader

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

Direct Known Subclasses:

AggregateReader, AsyncReader, AsyncTaskReader, BufferedReader, DebugReader, FilteringReader, GroupByReader, IntegrationProxyReader, LimitReader, MeteredReader, RemoveDuplicatesReader, RetryingReader, SortingReader, TailProxyReader, TeeReader, TimedReader, TransformingReader

public class ProxyReader
extends DataReader

Abstract super-class for obtaining records from another DataReader, possibly transforming them along the way. The only method that a subclass should implement is interceptRecord(Record).

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
ProxyReader(DataReader nestedDataReader)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
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.
DataReader	getNestedReader() Returns the DataReader held inside this one or null if there isn't one.
protected Record	interceptRecord(Record record)
static ProxyReader	map(DataReader reader, BiFunction<ProxyReader,Record,Record> mapper)
static ProxyReader	map(DataReader reader, Function<Record,Record> mapper)
void	open() Makes this endpoint ready for reading or writing.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
protected void	setNestedDataReader(DataReader nestedDataReader) Make sure to close old target and open the new one or call #setTargetDataReader(DataReader, boolean) with true.
protected void	setNestedDataReader(DataReader nestedDataReader, boolean manageLifecycle)

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

addLineage, getBufferSize, getNestedEndpoint, 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, 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

ProxyReader

public ProxyReader(DataReader nestedDataReader)

Method Detail

map

public static ProxyReader map(DataReader reader,
                              Function<Record,Record> mapper)
                       throws Throwable

Throws:

Throwable

map

public static ProxyReader map(DataReader reader,
                              BiFunction<ProxyReader,Record,Record> mapper)
                       throws Throwable

Throws:

Throwable

getNestedReader

public DataReader getNestedReader()

Description copied from class: DataReader

Returns the DataReader held inside this one or null if there isn't one.

Overrides:

getNestedReader in class DataReader

setNestedDataReader

protected void setNestedDataReader(DataReader nestedDataReader)

Make sure to close old target and open the new one or call #setTargetDataReader(DataReader, boolean) with true.

setNestedDataReader

protected void setNestedDataReader(DataReader nestedDataReader,
                                   boolean manageLifecycle)
                            throws DataException

Throws:

DataException

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 DataReader

Throws:

DataException

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class DataEndpoint

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 DataEndpoint

Throws:

DataException

interceptRecord

protected Record interceptRecord(Record record)
                          throws Throwable

Throws:

Throwable

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

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