com.northconcepts.datapipeline.validate

Class ValidatingReader

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.filter.FilteringReader

com.northconcepts.datapipeline.validate.ValidatingReader

public class ValidatingReader
extends FilteringReader

A proxy that validates records by applying a set of filters.

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

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
protected Record	discard(Record record, Filter filter)
boolean	isExceptionOnFailure()
boolean	isRecordStackTraceInMessage()
ValidatingReader	setExceptionOnFailure(boolean exceptionOnFailure)
ValidatingReader	setRecordStackTraceInMessage(boolean recordStackTraceInMessage)

Methods inherited from class com.northconcepts.datapipeline.filter.FilteringReader

add, close, get, getCount, getCurrentFilter, getDiscardReasonFieldName, getDiscardWriter, interceptRecord, open, remove, removeAll

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

ValidatingReader

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

Accepts the DataReader to validate and the DataWriter to send discarded records to. The exceptionOnFailure flag will be turned off if discardWriter contains a non-null value. Attempting to turn exceptionOnFailure on while a discardWriter is present will result in an exception.

Parameters:

reader - the source reader to filter.

discardWriter - the discard sink for disallowed records.

discardReasonFieldName - the field in the record to place the description of the filter that disallowed it or null if one should not be added.

ValidatingReader

public ValidatingReader(DataReader reader,
                        DataWriter discardWriter)

Accepts the DataReader to validate and the DataWriter to send discarded records to. The exceptionOnFailure flag will be turned off if discardWriter contains a non-null value. Attempting to turn exceptionOnFailure on while a discardWriter is present will result in an exception.

Parameters:

reader - the source reader to filter.

discardWriter - the discard sink for disallowed records.

ValidatingReader

public ValidatingReader(DataReader reader)

Method Detail

isExceptionOnFailure

public boolean isExceptionOnFailure()

setExceptionOnFailure

public ValidatingReader setExceptionOnFailure(boolean exceptionOnFailure)

isRecordStackTraceInMessage

public boolean isRecordStackTraceInMessage()

setRecordStackTraceInMessage

public ValidatingReader setRecordStackTraceInMessage(boolean recordStackTraceInMessage)

discard

protected Record discard(Record record,
                         Filter filter)

Overrides:

discard in class FilteringReader

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 FilteringReader