org.openimaj.stream.provider.irc

Class AbstractIRCStreamDataset<T>

java.lang.Object

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

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

org.openimaj.stream.provider.irc.AbstractIRCStreamDataset<T>

Type Parameters:

T - The type of items produced

All Implemented Interfaces:

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

Direct Known Subclasses:

BasicIRCStreamDataset, WikipediaEditsDataset

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

Abstract base class for producing a stream of items from an IRC channel.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk), Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIRCStreamDataset(BlockingDroppingQueue<T> buffer, String hostname, String channel)

Method Summary

Methods

Modifier and Type	Method and Description
abstract T	construct(String channel, String sender, String login, String hostname, String message) Called by PircBot.onMessage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
T	getRandomInstance()
int	numInstances() Returns the number of instances in this dataset.
protected void	register(T obj)

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

close, getBuffer, hasNext, next

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

AbstractIRCStreamDataset

protected AbstractIRCStreamDataset(BlockingDroppingQueue<T> buffer,
                        String hostname,
                        String channel)
                            throws IOException

Throws:

IOException

Method Detail

register

protected void register(T obj)
                 throws InterruptedException

Overrides:

register in class BlockingDroppingBufferedStream<T>

Throws:

InterruptedException

construct

public abstract T construct(String channel,
          String sender,
          String login,
          String hostname,
          String message)

Called by PircBot.onMessage(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

Parameters:

channel - the channel to which the message was sent

sender - the sender of the message (their nick)

login - the login of the message sender

hostname - the hostname of the message sender

message - the message itself

Returns:

the object the stream produces

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