org.openimaj.stream.provider.twitter

Class ContextRoundRobinTwitterSearchAPIDataset

java.lang.Object

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

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

org.openimaj.stream.provider.twitter.AbstractTwitterSearchDataset<Context>

org.openimaj.stream.provider.twitter.ContextRoundRobinTwitterSearchAPIDataset

All Implemented Interfaces:

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

public class ContextRoundRobinTwitterSearchAPIDataset
extends AbstractTwitterSearchDataset<Context>

Extends the TwitterSearchDataset to support multiple queries. All attempts are made to access the Twitter API in a fair way. Each query is handled in turn and backoffs, new results etc. are stored per query.

A round robin approach is used to fill the underlying BlockingDroppingQueue. Each query is given a chance to fill the queue, then all appropriate wait times are respected and the next query is given a chance.

Further this round robin dataset passes QueryHoldingStatus instances due to the variable queue.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields inherited from class org.openimaj.stream.provider.twitter.AbstractTwitterSearchDataset

config, logger, query, twitter

Constructor Summary

Constructors

Constructor and Description
ContextRoundRobinTwitterSearchAPIDataset(List<twitter4j.Query> queries, TwitterAPIToken token, BlockingDroppingQueue<Context> buffer)

Method Summary

Modifier and Type	Method and Description
twitter4j.Query	getQuery() Get the current query
void	registerStatus(twitter4j.Query query, 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.AbstractTwitterSearchDataset

getRandomInstance, makeConfiguration, 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

forEachRemaining, hasNext, next, remove

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

ContextRoundRobinTwitterSearchAPIDataset

public ContextRoundRobinTwitterSearchAPIDataset(List<twitter4j.Query> queries,
                                                TwitterAPIToken token,
                                                BlockingDroppingQueue<Context> buffer)

Parameters:

queries -

token -

buffer -

Method Detail

getQuery

public twitter4j.Query getQuery()

Description copied from class: AbstractTwitterSearchDataset

Get the current query

Specified by:

getQuery in class AbstractTwitterSearchDataset<Context>

Returns:

the query

registerStatus

public void registerStatus(twitter4j.Query query,
                           twitter4j.Status status,
                           String json)
                    throws InterruptedException

Description copied from class: AbstractTwitterSearchDataset

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

Specified by:

registerStatus in class AbstractTwitterSearchDataset<Context>

Parameters:

query - the query

status - the parsed Status

json - the raw json string

Throws:

InterruptedException