com.northconcepts.datapipeline.transform

Class TransformingReader

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.transform.TransformingReader

public class TransformingReader
extends ProxyReader

A proxy that applies transformations to records passing through.

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
TransformingReader(DataReader reader) Accepts the DataReader to transform.
TransformingReader(DataReader reader, DataWriter discardWriter) Accepts the DataReader to transform and the DataWriter to send discarded records to (due to exception).
TransformingReader(DataReader reader, DataWriter discardWriter, String discardReasonFieldName) Accepts the DataReader to transform and the DataWriter to send discarded records to (due to exception).

Method Summary

Modifier and Type	Method and Description
TransformingReader	add(Transformer... transformer)
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
Transformer	get(int index)
Filter	getCondition() Returns the condition under which this transformation applies or null if it always applies.
int	getCount()
String	getDiscardReasonFieldName() Returns the the field in the record to place the description of the transformation that failed along with the exception message.
DataWriter	getDiscardWriter() Returns the discard sink for bad records or null if one was not assigned.
Filter	getFilter() Deprecated.
protected Record	interceptRecord(Record record)
boolean	isExceptionOnFailure()
boolean	isRecordStackTraceInMessage()
protected void	onFailure(Record record, Transformer transformer, DataException exception, String message, Messages messages)
void	open() Makes this endpoint ready for reading or writing.
TransformingReader	setCondition(Filter condition) Sets the condition under which this transformation applies or null if it should always be applied.
TransformingReader	setCondition(String condition) Sets the condition under which this transformation applies or null if it should always be applied.
TransformingReader	setExceptionOnFailure(boolean exceptionOnFailure) Sets the flag to stop processing if an exception is thrown (default) or false if they should be ignored.
TransformingReader	setFilter(Filter filter) Deprecated.
TransformingReader	setRecordStackTraceInMessage(boolean recordStackTraceInMessage)
protected boolean	transformRecord(Record record, Transformer transformer, Messages messages)

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

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

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

TransformingReader

public TransformingReader(DataReader reader,
                          DataWriter discardWriter,
                          String discardReasonFieldName)

Accepts the DataReader to transform and the DataWriter to send discarded records to (due to exception).

Parameters:

reader - the source reader to transform.

discardWriter - the discard sink for bad records.

discardReasonFieldName - the field in the record to place the description of the transformation that failed along with the exception message.

TransformingReader

public TransformingReader(DataReader reader,
                          DataWriter discardWriter)

Accepts the DataReader to transform and the DataWriter to send discarded records to (due to exception).

Parameters:

reader - the source reader to transform.

discardWriter - the discard sink for bad records.

TransformingReader

public TransformingReader(DataReader reader)

Accepts the DataReader to transform.

Parameters:

reader - the source reader to transform.

Method Detail

getFilter

@Deprecated
public Filter getFilter()

Deprecated.

Use getCondition() instead.

setFilter

@Deprecated
public TransformingReader setFilter(Filter filter)

Deprecated.

Use setCondition(Filter) instead.

getCondition

public Filter getCondition()

Returns the condition under which this transformation applies or null if it always applies.

setCondition

public TransformingReader setCondition(Filter condition)

Sets the condition under which this transformation applies or null if it should always be applied.

setCondition

public TransformingReader setCondition(String condition)

Sets the condition under which this transformation applies or null if it should always be applied.

isExceptionOnFailure

public boolean isExceptionOnFailure()

setExceptionOnFailure

public TransformingReader setExceptionOnFailure(boolean exceptionOnFailure)

Sets the flag to stop processing if an exception is thrown (default) or false if they should be ignored.

isRecordStackTraceInMessage

public boolean isRecordStackTraceInMessage()

setRecordStackTraceInMessage

public TransformingReader setRecordStackTraceInMessage(boolean recordStackTraceInMessage)

add

public TransformingReader add(Transformer... transformer)

getCount

public int getCount()

get

public Transformer get(int index)

getDiscardWriter

public DataWriter getDiscardWriter()

Returns the discard sink for bad records or null if one was not assigned.

getDiscardReasonFieldName

public String getDiscardReasonFieldName()

Returns the the field in the record to place the description of the transformation that failed along with the exception message.

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

transformRecord

protected boolean transformRecord(Record record,
                                  Transformer transformer,
                                  Messages messages)

onFailure

protected void onFailure(Record record,
                         Transformer transformer,
                         DataException exception,
                         String message,
                         Messages messages)

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 ProxyReader