com.northconcepts.datapipeline.transform

Class TransformingWriter

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

public class TransformingWriter
extends ProxyWriter

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.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
TransformingWriter(DataWriter writer) Accepts the target DataWriter of the transform.
TransformingWriter(DataWriter writer, DataWriter discardWriter) Accepts the target DataWriter of the transform and the DataWriter to send discarded records to (due to exception).
TransformingWriter(DataWriter writer, DataWriter discardWriter, String discardReasonFieldName) Accepts the target DataWriter of the transform and the DataWriter to send discarded records to (due to exception).

Method Summary

Modifier and Type	Method and Description
TransformingWriter	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.
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.
TransformingWriter	setCondition(Filter condition) Sets the condition under which this transformation applies or null if it should always be applied.
TransformingWriter	setExceptionOnFailure(boolean exceptionOnFailure) Sets the flag to stop processing if an exception is thrown (default) or false if they should be ignored.
TransformingWriter	setRecordStackTraceInMessage(boolean recordStackTraceInMessage)
protected boolean	transformRecord(Record record, Transformer transformer, Messages messages)

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

available, getNestedWriter, map, map, setNestedDataWriter, setNestedDataWriter, writeImpl

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

getNestedEndpoint, getRootEndpoint, getRootWriter, 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

TransformingWriter

public TransformingWriter(DataWriter writer,
                          DataWriter discardWriter,
                          String discardReasonFieldName)

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

Parameters:

writer - the target writer of the 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.

TransformingWriter

public TransformingWriter(DataWriter writer,
                          DataWriter discardWriter)

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

Parameters:

writer - the target writer of the transform.

discardWriter - the discard sink for bad records.

TransformingWriter

public TransformingWriter(DataWriter writer)

Accepts the target DataWriter of the transform.

Parameters:

writer - the target writer of the transform.

Method Detail

getCondition

public Filter getCondition()

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

setCondition

public TransformingWriter setCondition(Filter condition)

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

isExceptionOnFailure

public boolean isExceptionOnFailure()

setExceptionOnFailure

public TransformingWriter 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 TransformingWriter setRecordStackTraceInMessage(boolean recordStackTraceInMessage)

add

public TransformingWriter 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 ProxyWriter

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 ProxyWriter

Throws:

DataException

interceptRecord

protected Record interceptRecord(Record record)
                          throws Throwable

Overrides:

interceptRecord in class ProxyWriter

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 ProxyWriter