adams.flow.source
Class TwitterListener

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.source.AbstractSource
                  adams.flow.source.TwitterListener

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable

public class TwitterListener
extends AbstractSource

Uses the Twitter streaming API to retrieve tweets.

Input/output:
- generates:
twitter4j.Status

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: TwitterListener
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-max-updates <int> (property: maxStatusUpdates)
    The maximum number of status updates to output; use <=0 for unlimited.
    default: 100
    minimum: -1
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz), Yusuke Yamamoto

See Also:

Serialized Form

Nested Class Summary

static class

TwitterListener.Listener Thread for listening to Twitter status updates.

Field Summary

protected TwitterListener.Listener	m_Listener the thread for retrieving the status updates.
protected int	m_MaxStatusUpdates the maximum number of status updates to output.

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

TwitterListener()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
Class[]	generates() Returns the class of objects that it generates.
int	getMaxStatusUpdates() Returns the maximum number of status updates to output.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo() Returns a string describing the object.
boolean	hasPendingOutput() Checks whether there is pending output to be collected after executing the flow item.
String	maxStatusUpdatesTipText() Returns the tip text for this property.
Token	output() Returns the generated token.
void	setMaxStatusUpdates(int value) Sets the maximum number of status updates to output.
String	setUp() Initializes the sub-actors for flow execution.
void	stopExecution() Stops the execution.
protected void	stopListening() Stops listening to the twitter stream.
void	wrapUp() Cleans up after the execution has finished.

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setVariables, sizeOf, stopExecution, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_MaxStatusUpdates

protected int m_MaxStatusUpdates

the maximum number of status updates to output.

m_Listener

protected transient TwitterListener.Listener m_Listener

the thread for retrieving the status updates.

Constructor Detail

TwitterListener

public TwitterListener()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in interface Actor

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

the classes

setMaxStatusUpdates

public void setMaxStatusUpdates(int value)

Sets the maximum number of status updates to output.

Parameters:

value - the maximum number

getMaxStatusUpdates

public int getMaxStatusUpdates()

Returns the maximum number of status updates to output.

Returns:

the maximum number

maxStatusUpdatesTipText

public String maxStatusUpdatesTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setUp

public String setUp()

Initializes the sub-actors for flow execution.

Specified by:

setUp in interface Actor

Overrides:

setUp in class AbstractActor

Returns:

null if everything is fine, otherwise error message

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

always null

stopListening

protected void stopListening()

Stops listening to the twitter stream.

stopExecution

public void stopExecution()

Stops the execution.

Specified by:

stopExecution in interface Stoppable

Specified by:

stopExecution in interface Actor

Overrides:

stopExecution in class AbstractActor

output

public Token output()

Returns the generated token.

Returns:

the generated token

hasPendingOutput

public boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

Returns:

true if there is pending output

wrapUp

public void wrapUp()

Cleans up after the execution has finished.

Specified by:

wrapUp in interface Actor

Overrides:

wrapUp in class AbstractActor