org.openimaj.stream.provider.irc

Class BasicIRCStreamDataset

java.lang.Object

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

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

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

org.openimaj.stream.provider.irc.BasicIRCStreamDataset

All Implemented Interfaces:

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

public class BasicIRCStreamDataset
extends AbstractIRCStreamDataset<Context>

Basic streaming dataset from IRC messages. Messages are provided as Context objects. The contexts contain keys for channel, sender, login, hostname and message. All values are Strings.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
String	CHANNEL_KEY The IRC channel name key
String	HOSTNAME_KEY The host name key
String	LOGIN_KEY The login key
String	MESSAGE_KEY The message text key
String	SENDER_KEY The sender key

Constructor Summary

Constructors

Constructor and Description
BasicIRCStreamDataset(BlockingDroppingQueue<Context> buffer, String hostname, String channel) Construct with the given buffer, connecting to the given host and channel.
BasicIRCStreamDataset(String hostname, String channel) Connect to the given host and channel.

Method Summary

Modifier and Type	Method and Description
Context	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)

Methods inherited from class org.openimaj.stream.provider.irc.AbstractIRCStreamDataset

getRandomInstance, numInstances, register

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

forEachRemaining, hasNext, next, remove

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

CHANNEL_KEY

public String CHANNEL_KEY

The IRC channel name key

SENDER_KEY

public String SENDER_KEY

The sender key

LOGIN_KEY

public String LOGIN_KEY

The login key

HOSTNAME_KEY

public String HOSTNAME_KEY

The host name key

MESSAGE_KEY

public String MESSAGE_KEY

The message text key

Constructor Detail

BasicIRCStreamDataset

public BasicIRCStreamDataset(String hostname,
                             String channel)
                      throws IOException

Connect to the given host and channel. Internally a ArrayBlockingDroppingQueue with size of 1 is created to buffer/drop messages.

Parameters:

hostname - the host

channel - the channel

Throws:

IOException

BasicIRCStreamDataset

public BasicIRCStreamDataset(BlockingDroppingQueue<Context> buffer,
                             String hostname,
                             String channel)
                      throws IOException

Construct with the given buffer, connecting to the given host and channel.

Parameters:

buffer - the buffer

hostname - the host

channel - the channel

Throws:

IOException

Method Detail

construct

public Context construct(String channel,
                         String sender,
                         String login,
                         String hostname,
                         String message)

Description copied from class: AbstractIRCStreamDataset

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

Specified by:

construct in class AbstractIRCStreamDataset<Context>

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