com.northconcepts.datapipeline.core

Class TeeReader

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

public class TeeReader
extends ProxyReader

A proxy reader that also writes every record passing through it to a DataWriter.

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
TeeReader(DataReader nestedDataReader, DataWriter writer) Creates a new TeeReader.
TeeReader(DataReader nestedDataReader, DataWriter writer, boolean cloneRecord) Creates a new TeeReader.

Method Summary

Modifier and Type	Method and Description
void	close() Indicates that this endpoint has finished reading or writing.
protected Record	interceptRecord(Record record)
boolean	isCloneRecord() Indicates if a copy of the original record should be sent to the writer (default false), otherwise the original record is sent to the writer.
void	open() Makes this endpoint ready for reading or writing.

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

addExceptionProperties, available, getNestedReader, map, map, readImpl, setNestedDataReader, setNestedDataReader

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

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

TeeReader

public TeeReader(DataReader nestedDataReader,
                 DataWriter writer,
                 boolean cloneRecord)

Creates a new TeeReader.

Parameters:

nestedDataReader - the previous reader in this pipeline.

writer - the sink to receive records passing through this proxy.

cloneRecord - Indicates if a copy of the original record should be sent to the writer instead of the original record itself (default false). If the original record is sent to the writer, any changes made by the writer will be seen by subsequent steps in the primary pipeline.

TeeReader

public TeeReader(DataReader nestedDataReader,
                 DataWriter writer)

Creates a new TeeReader.

Parameters:

nestedDataReader - the previous reader in this pipeline.

writer - the sink to receive records passing through this proxy.

Method Detail

isCloneRecord

public boolean isCloneRecord()

Indicates if a copy of the original record should be sent to the writer (default false), otherwise the original record is sent to the writer. If the original record is sent to the writer, any changes made by the writer will be seen by subsequent steps in the primary pipeline.

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

interceptRecord

protected Record interceptRecord(Record record)
                          throws Throwable

Overrides:

interceptRecord in class ProxyReader

Throws:

Throwable