com.northconcepts.datapipeline.filter

Class FilteringReader

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

Direct Known Subclasses:

ValidatingReader

public class FilteringReader
extends ProxyReader

A proxy that chooses records using a filter criteria. Chosen records are returned by the read() methods, while rejected records disappear.

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

Method Summary

Modifier and Type	Method and Description
FilteringReader	add(Filter... filters)
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
protected Record	discard(Record record, Filter filter)
Filter	get(int index)
int	getCount()
Filter	getCurrentFilter()
String	getDiscardReasonFieldName() Returns the field in the record to place the description of the filter that disallowed it or null if one should not be added.
DataWriter	getDiscardWriter() Returns the discard sink for disallowed records or null if one was not assigned.
protected Record	interceptRecord(Record record)
void	open() Makes this endpoint ready for reading or writing.
FilteringReader	remove(int index)
FilteringReader	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

FilteringReader

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

Accepts the DataReader to filter and the DataWriter to send discarded records to.

Parameters:

reader - the source reader to filter.

discardWriter - the discard sink for disallowed records or null if they should simply disappear.

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

FilteringReader

public FilteringReader(DataReader reader,
                       DataWriter discardWriter)

Accepts the DataReader to filter and the DataWriter to send discarded records to.

Parameters:

reader - the source reader to filter.

discardWriter - the discard sink for disallowed records.

FilteringReader

public FilteringReader(DataReader reader)

Accepts the DataReader to filter.

Parameters:

reader - the source reader to filter.

Method Detail

add

public FilteringReader add(Filter... filters)

getCurrentFilter

public Filter getCurrentFilter()

getDiscardWriter

public DataWriter getDiscardWriter()

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

getDiscardReasonFieldName

public String getDiscardReasonFieldName()

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

getCount

public int getCount()

get

public Filter get(int index)

remove

public FilteringReader remove(int index)

removeAll

public FilteringReader removeAll()

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

discard

protected Record discard(Record record,
                         Filter filter)

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