com.northconcepts.datapipeline.core

Class DebugWriter

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataWriter

com.northconcepts.datapipeline.core.ProxyWriter

com.northconcepts.datapipeline.core.DebugWriter

public class DebugWriter
extends ProxyWriter

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.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
DebugWriter(DataWriter nestedDataWriter)
DebugWriter(DataWriter nestedDataWriter, String id)
DebugWriter(DataWriter nestedDataWriter, String id, OutputStream outputStream)
DebugWriter(DataWriter nestedDataWriter, 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)
DebugWriter	setIncludeElapsedTime(boolean includeElapsedTime)

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

addExceptionProperties, available, getNestedWriter, map, map, open, setNestedDataWriter, setNestedDataWriter, writeImpl

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

getNestedEndpoint, getRootEndpoint, getRootWriter, getWriter, write

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

DebugWriter

public DebugWriter(DataWriter nestedDataWriter,
                   String id,
                   Writer writer)

DebugWriter

public DebugWriter(DataWriter nestedDataWriter,
                   String id,
                   OutputStream outputStream)

DebugWriter

public DebugWriter(DataWriter nestedDataWriter,
                   String id)

DebugWriter

public DebugWriter(DataWriter nestedDataWriter)

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 ProxyWriter

Throws:

DataException

getCloseWriterOnClose

public boolean getCloseWriterOnClose()

setCloseWriterOnClose

public void setCloseWriterOnClose(boolean closeWriterOnClose)

getIncludeElapsedTime

public boolean getIncludeElapsedTime()

setIncludeElapsedTime

public DebugWriter setIncludeElapsedTime(boolean includeElapsedTime)

interceptRecord

protected Record interceptRecord(Record record)
                          throws Throwable

Description copied from class: ProxyWriter

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

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

• Return the record (possibly modified) to forward it to the nested DataWriter.
• Return null to drop the record; the framework will not write it downstream.
• Throw to fail the pipeline; the framework wraps the throwable in a DataException with .setRecord(record).
• The nested DataWriter is opened and closed for you; do not write to it here.
• Do not call DataEndpoint.incrementRecordCount() here.

Overrides:

interceptRecord in class ProxyWriter

Throws:

Throwable