com.northconcepts.datapipeline.twitter2.TwitterFilterStreamReader

public class TwitterFilterStreamReader extends AbstractTwitterReader

Continuously reads filtered Tweets in real-time based on a set of filter rules.

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint
DataEndpoint.State
Field Summary

Fields

Modifier and Type

Field

Description

protected static final Record

EOF

Fields inherited from class com.northconcepts.datapipeline.twitter2.AbstractTwitterReader
client, DEFAULT_RETRY_AFTER_SECONDS, twitterCredentials

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

Description

TwitterFilterStreamReader(String apiKey, String apiSecret, String bearerToken)
Method Summary

Modifier and Type

Method

Description

DataException

addExceptionProperties(DataException exception)

Adds this endpoint's current state to a DataException.

TwitterFilterStreamReader

addRule(String key, String value)

Adds a filter rule to be used for streaming Tweets.

void

close()

Indicates that this endpoint has finished reading or writing.

DataException

getException()

Returns the exception raised while streaming, which the next read throws, or null if none occurred.

void

open()

Makes this endpoint ready for reading or writing.

protected Record

readImpl()

Overridden by subclasses to read the next record from this DataReader.

protected Response

search()

Requests the next page of results (see AbstractTwitterReader.getNextToken()); returning null ends reading.

protected DataException

setException(DataException exception)

Stores an exception for the next read to throw and returns it.

Methods inherited from class com.northconcepts.datapipeline.twitter2.AbstractTwitterReader
getMaxResults, getNextToken, readNextBatch, setMaxResults

Methods inherited from class com.northconcepts.datapipeline.core.DataReader
addLineage, available, 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, 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

Field Details
- EOF
  
  protected static final Record EOF
Constructor Details
- TwitterFilterStreamReader
  
  public TwitterFilterStreamReader(String apiKey, String apiSecret, String bearerToken)
Method Details
- addRule
  
  public TwitterFilterStreamReader addRule(String key, String value)
  
  Adds a filter rule to be used for streaming Tweets.
- open
  
  public void open() throws DataException
  
  Description copied from class: DataEndpoint
  
  Makes this endpoint ready for reading or writing.
  
  Overrides:
  
  open in class IntegrationReader
  
  Throws:
  
  DataException
- search
  
  protected Response search()
  
  Description copied from class: AbstractTwitterReader
  
  Requests the next page of results (see AbstractTwitterReader.getNextToken()); returning null ends reading.
  
  Specified by:
  
  search in class AbstractTwitterReader
- 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.
  Contract for subclasses (see also docs/authoring/DataReader.md):
  
  Return null exactly once to signal end-of-stream.
  
  Do not call this method directly — DataReader.read() is the template method that wraps exceptions, increments the record count, and tracks lineage.
  
  Do not call DataEndpoint.incrementRecordCount() here; DataReader.read() already does.
  
  Throw raw exceptions; DataReader.read() wraps them via exception(throwable).
  Overrides:
  
  readImpl in class AbstractTwitterReader
  
  Throws:
  
  Throwable
- 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
- getException
  
  public DataException getException()
  
  Returns the exception raised while streaming, which the next read throws, or null if none occurred.
- setException
  
  protected DataException setException(DataException exception)
  
  Description copied from class: AbstractTwitterReader
  
  Stores an exception for the next read to throw and returns it.
  
  Overrides:
  
  setException in class AbstractTwitterReader
- 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 AbstractTwitterReader

Class TwitterFilterStreamReader

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Field Summary

Fields inherited from class com.northconcepts.datapipeline.twitter2.AbstractTwitterReader

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

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.twitter2.AbstractTwitterReader

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

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

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

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

Methods inherited from class java.lang.Object

Field Details

EOF

Constructor Details

TwitterFilterStreamReader

Method Details

addRule

open

search

readImpl

close

getException

setException

addExceptionProperties