org.openimaj.stream.provider.twitter

Class TwitterStreamFilterDataset

java.lang.Object

org.openimaj.util.stream.AbstractStream<T>

org.openimaj.util.stream.BlockingDroppingBufferedStream<T>

org.openimaj.stream.provider.twitter.AbstractTwitterStatusesFilterDataset<twitter4j.Status>

org.openimaj.stream.provider.twitter.TwitterStreamFilterDataset

All Implemented Interfaces:

Iterable<twitter4j.Status>, Iterator<twitter4j.Status>, Dataset<twitter4j.Status>, StreamingDataset<twitter4j.Status>, Stream<twitter4j.Status>

public class TwitterStreamFilterDataset
extends AbstractTwitterStatusesFilterDataset<twitter4j.Status>

A concrete version of the AbstractTwitterStreamDataset which pushes the Statuss into the stream.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
TwitterStreamFilterDataset(twitter4j.FilterQuery query, TwitterAPIToken token) Construct the dataset from the given API token.
TwitterStreamFilterDataset(twitter4j.FilterQuery query, TwitterAPIToken token, BlockingDroppingQueue<twitter4j.Status> buffer) Construct the dataset from the given API token and buffer.
TwitterStreamFilterDataset(String[] words, TwitterAPIToken token) Construct the dataset from the given API token.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	registerStatus(twitter4j.Status status, String json) Handle the given incoming status and optionally BlockingDroppingBufferedStream.register(Object) it with the stream.

Methods inherited from class org.openimaj.stream.provider.twitter.AbstractTwitterStatusesFilterDataset

getRandomInstance, numInstances

Methods inherited from class org.openimaj.util.stream.BlockingDroppingBufferedStream

close, getBuffer, hasNext, next, register

Methods inherited from class org.openimaj.util.stream.AbstractStream

filter, forEach, forEach, forEach, iterator, map, map, parallelForEach, parallelForEach, remove, transform

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openimaj.util.stream.Stream

filter, forEach, forEach, forEach, map, map, parallelForEach, parallelForEach, transform

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

TwitterStreamFilterDataset

public TwitterStreamFilterDataset(twitter4j.FilterQuery query,
                          TwitterAPIToken token)

Construct the dataset from the given API token. The stream is backed by an ArrayBlockingDroppingQueue with a single item capacity.

Parameters:

query - the query

token - the Twitter api authentication credentials

TwitterStreamFilterDataset

public TwitterStreamFilterDataset(String[] words,
                          TwitterAPIToken token)

Construct the dataset from the given API token. The stream is backed by an ArrayBlockingDroppingQueue with a single item capacity.

Parameters:

words - the query terms

token - the Twitter api authentication credentials

TwitterStreamFilterDataset

public TwitterStreamFilterDataset(twitter4j.FilterQuery query,
                          TwitterAPIToken token,
                          BlockingDroppingQueue<twitter4j.Status> buffer)

Construct the dataset from the given API token and buffer.

Parameters:

query - the query

token - the Twitter api authentication credentials

buffer - the buffer to hold Statuss before they are consumed.

Method Detail

registerStatus

protected void registerStatus(twitter4j.Status status,
                  String json)
                       throws InterruptedException

Description copied from class: AbstractTwitterStatusesFilterDataset

Handle the given incoming status and optionally BlockingDroppingBufferedStream.register(Object) it with the stream.

Specified by:

registerStatus in class AbstractTwitterStatusesFilterDataset<twitter4j.Status>

Parameters:

status - the parsed Status

json - the json string

Throws:

InterruptedException