com.northconcepts.datapipeline.twitter2

Class TwitterTimelineReader

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.twitter2.AbstractTwitterReader

com.northconcepts.datapipeline.twitter2.TwitterTimelineReader

Direct Known Subclasses:

TwitterTimelineMentionsReader, TwitterTimelineTweetsReader

public abstract class TwitterTimelineReader
extends AbstractTwitterReader

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.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 and Description
TwitterTimelineReader(String apiKey, String apiSecret, String bearerToken, String username)
TwitterTimelineReader(String apiKey, String apiSecret, String accessToken, String accessTokenSecret, String username)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
LocalDateTime	getEndDate() Indicates the newest UTC timestamp search criteria.
String	getSinceId() Returns the sinceId search criteria.
LocalDateTime	getStartDate() Indicates the oldest UTC timestamp search criteria.
String	getUntilId() Returns the untilId search criteria.
String	getUsername()
protected Response	search()
abstract Response	searchImpl()
TwitterTimelineReader	setEndDate(LocalDateTime endDate) Indicates the newest UTC timestamp search criteria.
void	setSinceId(String sinceId) Sets the sinceId search criteria.
TwitterTimelineReader	setStartDate(LocalDateTime startDate) Indicates the oldest UTC timestamp search criteria.
void	setUntilId(String untilId) Sets the untilId search criteria.

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

getMaxResults, getNextToken, readImpl, readNextBatch, setException, setMaxResults

Methods inherited from class com.northconcepts.datapipeline.internal.lang.IntegrationReader

open

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

addLineage, available, getBufferSize, getNestedEndpoint, getNestedReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, 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

Constructor Detail

TwitterTimelineReader

public TwitterTimelineReader(String apiKey,
                             String apiSecret,
                             String accessToken,
                             String accessTokenSecret,
                             String username)

TwitterTimelineReader

public TwitterTimelineReader(String apiKey,
                             String apiSecret,
                             String bearerToken,
                             String username)

Method Detail

getUsername

public String getUsername()

getStartDate

public LocalDateTime getStartDate()

Indicates the oldest UTC timestamp search criteria.

setStartDate

public TwitterTimelineReader setStartDate(LocalDateTime startDate)

Indicates the oldest UTC timestamp search criteria.

getEndDate

public LocalDateTime getEndDate()

Indicates the newest UTC timestamp search criteria.

setEndDate

public TwitterTimelineReader setEndDate(LocalDateTime endDate)

Indicates the newest UTC timestamp search criteria.

getSinceId

public String getSinceId()

Returns the sinceId search criteria. Only Tweets greater than the sinceId will be returned. If both startDate and sinceId are set, only sinceId will be used.

setSinceId

public void setSinceId(String sinceId)

Sets the sinceId search criteria. Only Tweets greater than the sinceId will be returned. If both startDate and sinceId are set, only sinceId will be used.

getUntilId

public String getUntilId()

Returns the untilId search criteria. Only Tweets lesser than the sinceId will be returned.

setUntilId

public void setUntilId(String untilId)

Sets the untilId search criteria. Only Tweets lesser than the sinceId will be returned.

searchImpl

public abstract Response searchImpl()

search

protected Response search()

Specified by:

search 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