com.northconcepts.datapipeline.twitter.TwitterFollowWriter

public class TwitterFollowWriter extends TwitterWriter

Follows accounts written to it.

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.twitter.TwitterWriter
EOF

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

TwitterFollowWriter(TwitterProvider provider, String userScreenNameField)

TwitterFollowWriter(String consumerKey, String consumerSecret, String screenNameField)

TwitterFollowWriter(String consumerKey, String consumerSecret, String accessToken, String accessTokenSecret, String userScreenNameField)
Method Summary

Modifier and Type

Method

Description

DataException

addExceptionProperties(DataException exception)

Adds this endpoint's current state to a DataException.

String

getUserScreenNameField()

boolean

isAddUserToRecord()

Indicates if the followed user's details are added to each written record (default is false).

boolean

isMuteUser()

Indicates if each followed user is also muted (default is false).

TwitterFollowWriter

setAddUserToRecord(boolean addUserToRecord)

Indicates if the followed user's details are added to each written record (default is false).

TwitterFollowWriter

setMuteUser(boolean muteUser)

Indicates if each followed user is also muted (default is false).

protected void

writeImpl(Record record)

Overridden by subclasses to write the specified record to this DataWriter.

Methods inherited from class com.northconcepts.datapipeline.twitter.TwitterWriter
getApiLimitPolicy, getConverter, getEntityExpansionPolicy, getProvider, setApiLimitPolicy, setConverter, setEntityExpansionPolicy

Methods inherited from class com.northconcepts.datapipeline.internal.lang.IntegrationWriter
open

Methods inherited from class com.northconcepts.datapipeline.core.DataWriter
available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter, getWriter, write

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 Details
- TwitterFollowWriter
  
  public TwitterFollowWriter(TwitterProvider provider, String userScreenNameField)
- TwitterFollowWriter
  
  public TwitterFollowWriter(String consumerKey, String consumerSecret, String screenNameField)
- TwitterFollowWriter
  
  public TwitterFollowWriter(String consumerKey, String consumerSecret, String accessToken, String accessTokenSecret, String userScreenNameField)
Method Details
- getUserScreenNameField
  
  public String getUserScreenNameField()
- isAddUserToRecord
  
  public boolean isAddUserToRecord()
  
  Indicates if the followed user's details are added to each written record (default is false).
- setAddUserToRecord
  
  public TwitterFollowWriter setAddUserToRecord(boolean addUserToRecord)
  
  Indicates if the followed user's details are added to each written record (default is false).
- isMuteUser
  
  public boolean isMuteUser()
  
  Indicates if each followed user is also muted (default is false).
- setMuteUser
  
  public TwitterFollowWriter setMuteUser(boolean muteUser)
  
  Indicates if each followed user is also muted (default is false).
- writeImpl
  
  protected void writeImpl(Record record) throws Throwable
  
  Description copied from class: DataWriter
  Overridden by subclasses to write the specified record to this DataWriter.
  Contract for subclasses (see also docs/authoring/DataWriter.md):
  
  Do not call this method directly — DataWriter.write(Record) is the template method that wraps exceptions, increments the record count, and attaches the offending record to thrown DataExceptions.
  
  Do not call DataEndpoint.incrementRecordCount() here; DataWriter.write(Record) already does.
  
  Throw raw exceptions; DataWriter.write(Record) wraps them via exception(throwable).setRecord(record).
  Specified by:
  
  writeImpl in class DataWriter
  
  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 TwitterWriter

Class TwitterFollowWriter

Nested Class Summary

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

Field Summary

Fields inherited from class com.northconcepts.datapipeline.twitter.TwitterWriter

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.twitter.TwitterWriter

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

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

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

Constructor Details

TwitterFollowWriter

TwitterFollowWriter

TwitterFollowWriter

Method Details

getUserScreenNameField

isAddUserToRecord

setAddUserToRecord

isMuteUser

setMuteUser

writeImpl

addExceptionProperties