com.northconcepts.datapipeline.core

Class DebugReader

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

public class DebugReader
extends ProxyReader

A proxy that prints records passing through to a stream in a human-readable format

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

log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
DebugReader(DataReader nestedDataReader)
DebugReader(DataReader nestedDataReader, String id)
DebugReader(DataReader nestedDataReader, String id, OutputStream outputStream)
DebugReader(DataReader nestedDataReader, String id, Writer writer)

Method Summary

Modifier and Type	Method and Description
void	close() Indicates that this endpoint has finished reading or writing.
boolean	getCloseWriterOnClose()
boolean	getIncludeElapsedTime()
protected Record	interceptRecord(Record record) Overridden by subclasses to transform, drop, or observe a record on its way through this proxy.
void	setCloseWriterOnClose(boolean closeWriterOnClose)
DebugReader	setIncludeElapsedTime(boolean includeElapsedTime)

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

addExceptionProperties, available, getNestedReader, map, map, open, 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

DebugReader

public DebugReader(DataReader nestedDataReader,
                   String id,
                   Writer writer)

DebugReader

public DebugReader(DataReader nestedDataReader,
                   String id,
                   OutputStream outputStream)

DebugReader

public DebugReader(DataReader nestedDataReader,
                   String id)

DebugReader

public DebugReader(DataReader nestedDataReader)

Method Detail

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

getCloseWriterOnClose

public boolean getCloseWriterOnClose()

setCloseWriterOnClose

public void setCloseWriterOnClose(boolean closeWriterOnClose)

getIncludeElapsedTime

public boolean getIncludeElapsedTime()

setIncludeElapsedTime

public DebugReader setIncludeElapsedTime(boolean includeElapsedTime)

interceptRecord

protected Record interceptRecord(Record record)
                          throws Throwable

Description copied from class: ProxyReader

Overridden by subclasses to transform, drop, or observe a record on its way through this proxy.

Contract for subclasses (see also docs/authoring/ProxyReader.md):

• Return the record (possibly modified) to pass it downstream.
• Return null to drop the record; the framework reads the next one.
• Throw to fail the pipeline; the framework wraps the throwable in a DataException with .setRecord(record).
• The nested DataReader is opened and closed for you; do not read from it here.
• Do not call DataEndpoint.incrementRecordCount() here.

Overrides:

interceptRecord in class ProxyReader

Throws:

Throwable