com.northconcepts.datapipeline.twitter

Class TwitterReader

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.internal.lang.IntegrationReader

com.northconcepts.datapipeline.twitter.TwitterReader

Direct Known Subclasses:

TwitterPageableReader, TwitterSearchReader

public abstract class TwitterReader
extends IntegrationReader

Base class for all Twitter DataReaders.

Nested Class Summary

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

DataEndpoint.State

Field Summary

Fields

Modifier and Type	Field and Description
protected static Record	EOF

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
TwitterReader(String rateLimitResource, String rateLimitKey, String consumerKey, String consumerSecret)
TwitterReader(String rateLimitResource, String rateLimitKey, String consumerKey, String consumerSecret, String accessToken, String accessTokenSecret)
TwitterReader(String rateLimitResource, String rateLimitKey, TwitterProvider provider)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
IApiLimitPolicy	getApiLimitPolicy()
ITwitterConverter	getConverter()
IEntityExpansionPolicy	getEntityExpansionPolicy()
TwitterProvider	getProvider()
TwitterRateLimit	getRateLimit()
TwitterRateLimit	getRateLimit(boolean autoReload)
boolean	isRateLimitExceeded()
protected boolean	onRateLimitExceeded()
void	open() Makes this endpoint ready for reading or writing.
void	reloadRateLimit()
TwitterReader	setApiLimitPolicy(IApiLimitPolicy apiLimitPolicy)
TwitterReader	setConverter(ITwitterConverter converter)
TwitterReader	setEntityExpansionPolicy(IEntityExpansionPolicy entityExpansionPolicy)
TwitterReader	setRateLimit(RateLimitStatus rateLimitStatus)
TwitterReader	setRateLimit(TwitterResponse response)
protected TwitterReader	setRateLimitExceeded(boolean rateLimitExceeded)

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

addLineage, available, getBufferSize, getNestedEndpoint, getNestedReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, readImpl, setSaveLineage, skip

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

close, 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 Detail

EOF

protected static final Record EOF

Constructor Detail

TwitterReader

public TwitterReader(String rateLimitResource,
                     String rateLimitKey,
                     TwitterProvider provider)

TwitterReader

public TwitterReader(String rateLimitResource,
                     String rateLimitKey,
                     String consumerKey,
                     String consumerSecret)

TwitterReader

public TwitterReader(String rateLimitResource,
                     String rateLimitKey,
                     String consumerKey,
                     String consumerSecret,
                     String accessToken,
                     String accessTokenSecret)

Method Detail

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

getProvider

public TwitterProvider getProvider()

getApiLimitPolicy

public IApiLimitPolicy getApiLimitPolicy()

setApiLimitPolicy

public TwitterReader setApiLimitPolicy(IApiLimitPolicy apiLimitPolicy)

getRateLimit

public final TwitterRateLimit getRateLimit()

onRateLimitExceeded

protected boolean onRateLimitExceeded()

setRateLimitExceeded

protected TwitterReader setRateLimitExceeded(boolean rateLimitExceeded)

isRateLimitExceeded

public boolean isRateLimitExceeded()

getRateLimit

public final TwitterRateLimit getRateLimit(boolean autoReload)

setRateLimit

public TwitterReader setRateLimit(TwitterResponse response)

setRateLimit

public TwitterReader setRateLimit(RateLimitStatus rateLimitStatus)

reloadRateLimit

public final void reloadRateLimit()

getEntityExpansionPolicy

public IEntityExpansionPolicy getEntityExpansionPolicy()

setEntityExpansionPolicy

public TwitterReader setEntityExpansionPolicy(IEntityExpansionPolicy entityExpansionPolicy)

getConverter

public ITwitterConverter getConverter()

setConverter

public TwitterReader setConverter(ITwitterConverter converter)

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