org.openimaj.stream.provider.twitter

Class AbstractTwitterStreamDataset<T>

java.lang.Object

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

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

org.openimaj.stream.provider.twitter.AbstractTwitterStreamDataset<T>

Type Parameters:

T - Type of items in the stream

All Implemented Interfaces:

Iterable<T>, Iterator<T>, Dataset<T>, StreamingDataset<T>, Stream<T>

Direct Known Subclasses:

TwitterStreamDataset

public abstract class AbstractTwitterStreamDataset<T>
extends BlockingDroppingBufferedStream<T>
implements StreamingDataset<T>

Base class for Live twitter streams based on the live Twitter streaming API.

This class is abstract in terms of the object the stream consumes. Instances of this class can construct the specific object they require for each twitter status using:

• the status object
• the raw json of the status

Author:

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

Constructor Summary

Constructors

Constructor and Description
AbstractTwitterStreamDataset(TwitterAPIToken token, BlockingDroppingQueue<T> buffer) Construct with the given Twitter API credentials and buffer

Method Summary

Modifier and Type	Method and Description
T	getRandomInstance()
int	numInstances() Returns the number of instances in this dataset.
protected abstract 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.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

forEachRemaining, hasNext, next, remove

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

AbstractTwitterStreamDataset

public AbstractTwitterStreamDataset(TwitterAPIToken token,
                                    BlockingDroppingQueue<T> buffer)

Construct with the given Twitter API credentials and buffer

Parameters:

token - the Twitter api authentication credentials

buffer - the backing buffer for storing data before consumption from the stream

Method Detail

registerStatus

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

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

Parameters:

status - the parsed Status

json - the json string

Throws:

InterruptedException

getRandomInstance

public T getRandomInstance()

Specified by:

getRandomInstance in interface Dataset<T>

Returns:

a randomly selected instance from the dataset.

numInstances

public int numInstances()

Description copied from interface: Dataset

Returns the number of instances in this dataset.

Specified by:

numInstances in interface Dataset<T>

Returns:

the number of instances in this list