com.northconcepts.datapipeline.eventbus

Class EventBusReader

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.eventbus.EventBusReader

public class EventBusReader
extends DataReader

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
EventBusReader(EventBus eventBus, int queueCapacity, Object... topics)
EventBusReader(EventBus eventBus, Object... topics)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
int	available() Returns the number of records that can probably be read without blocking.
void	close() Indicates that this endpoint has finished reading or writing.
EventBus	getEventBus()
EventFilter	getEventFilter()
String	getTopicFieldName() Returns the field name used to add the delivery topic to each record or null if the topic should not be added to records (defaults to null).
Object[]	getTopics()
boolean	isStopOnWriterEOF() Indicates if this reader should stop reading from the event bus when any event bus writer on the same topic finishes (default to true).
void	open() Makes this endpoint ready for reading or writing.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
EventBusReader	setEventFilter(EventFilter eventFilter)
EventBusReader	setStopOnWriterEOF(boolean stopOnReaderEOF) Indicates if this reader should stop reading from the event bus when any event bus writer on the same topic finishes (default to true).
EventBusReader	setTopicFieldName(String topicFieldName) Assigns the field name to use when adding the delivery topic to each record or null if the topic should not be added to records (defaults to null).
EventBusReader	setTopics(Object... topics)
String	toString()

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

addLineage, getBufferSize, getNestedEndpoint, getNestedReader, getReader, 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

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

EventBusReader

public EventBusReader(EventBus eventBus,
                      Object... topics)

EventBusReader

public EventBusReader(EventBus eventBus,
                      int queueCapacity,
                      Object... topics)

Method Detail

getEventBus

public EventBus getEventBus()

getTopics

public Object[] getTopics()

setTopics

public EventBusReader setTopics(Object... topics)

getTopicFieldName

public String getTopicFieldName()

Returns the field name used to add the delivery topic to each record or null if the topic should not be added to records (defaults to null).

setTopicFieldName

public EventBusReader setTopicFieldName(String topicFieldName)

Assigns the field name to use when adding the delivery topic to each record or null if the topic should not be added to records (defaults to null).

getEventFilter

public EventFilter getEventFilter()

setEventFilter

public EventBusReader setEventFilter(EventFilter eventFilter)

isStopOnWriterEOF

public boolean isStopOnWriterEOF()

Indicates if this reader should stop reading from the event bus when any event bus writer on the same topic finishes (default to true).

setStopOnWriterEOF

public EventBusReader setStopOnWriterEOF(boolean stopOnReaderEOF)

Indicates if this reader should stop reading from the event bus when any event bus writer on the same topic finishes (default to true).

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class DataEndpoint

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 DataEndpoint

Throws:

DataException

available

public int available()
              throws DataException

Description copied from class: DataReader

Returns the number of records that can probably be read without blocking.

Overrides:

available in class DataReader

Throws:

DataException

readImpl

protected Record readImpl()
                   throws Throwable

Description copied from class: DataReader

Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

If no record is available, null will be returned.

Specified by:

readImpl in class DataReader

Throws:

Throwable

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 DataReader

toString

public String toString()

Overrides:

toString in class DataEndpoint