org.openimaj.twitter.collection

Class StreamTwitterStatusList<T extends USMFStatus>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<T>

org.openimaj.util.list.AbstractStreamBackedList<T>

org.openimaj.twitter.collection.StreamTwitterStatusList<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>, Writeable, WriteableASCII, WriteableBinary, TwitterStatusList<T>, RandomisableList<T>

public class StreamTwitterStatusList<T extends USMFStatus>
extends AbstractStreamBackedList<T>
implements TwitterStatusList<T>

Converts an input stream into a list USMFStatus instances using various methods.

Author:

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

Field Summary

Fields inherited from class org.openimaj.util.list.AbstractStreamBackedList

clz, consumed, headerLength, isBinary, recordLength, size

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamTwitterStatusList(InputStream stream, int size, boolean isBinary, int headerLength, int recordLength, Class<? extends GeneralJSON> inputClass, Class<T> instanceClass, String charset)
protected	StreamTwitterStatusList(InputStream stream, int size, boolean isBinary, int headerLength, int recordLength, Class<T> clazz)
protected	StreamTwitterStatusList(InputStream stream, int size, boolean isBinary, int headerLength, int recordLength, Class<T> clazz, String charset)

Method Summary

Methods

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii output.
byte[]	binaryHeader() Header for binary output.
protected T	newElementInstance() Override this id your instances can't be constructed with a no-args ctr
static <T extends USMFStatus> StreamTwitterStatusList<T>	read(BufferedInputStream stream, int nTweets, Class<? extends GeneralJSON> inputClass, Class<T> instanceClass, String charset) Construct a new StreamTwitterStatusList from the given input stream.
static <T extends USMFStatus> StreamTwitterStatusList<T>	read(BufferedInputStream stream, int nTweets, Class<T> clz) Construct a new StreamTwitterStatusList from the given input stream.
static <T extends USMFStatus> StreamTwitterStatusList<T>	read(BufferedInputStream stream, int nTweets, Class<T> clazz, String charset) Construct a new StreamTwitterStatusList from the given input stream.
static StreamTwitterStatusList<USMFStatus>	read(InputStream stream) Construct a new StreamTwitterStatusList from the given input stream.
static StreamTwitterStatusList<USMFStatus>	read(InputStream stream, int nTweets) Construct a new StreamTwitterStatusList from the given input stream.
static <T extends USMFStatus> StreamTwitterStatusList<T>	read(InputStream stream, int nTweets, Class<? extends GeneralJSON> inputClass, Class<T> instanceClass)
static <T extends USMFStatus> StreamTwitterStatusList<T>	read(InputStream stream, int nTweets, Class<T> clazz) Construct a new StreamTwitterStatusList from the given input stream.
static StreamTwitterStatusList<USMFStatus>	read(InputStream stream, int nTweets, String charset) Construct a new StreamTwitterStatusList from the given input stream.
static StreamTwitterStatusList<USMFStatus>	read(InputStream stream, String charset) Construct a new StreamTwitterStatusList from the given input stream.
static StreamTwitterStatusList<USMFStatus>	readUSMF(InputStream stream, Class<? extends GeneralJSON> generalJSON)
static StreamTwitterStatusList<USMFStatus>	readUSMF(InputStream stream, Class<? extends GeneralJSON> generalJSON, String charset)
static StreamTwitterStatusList<USMFStatus>	readUSMF(InputStream stream, int nTweets, Class<? extends GeneralJSON> generalJSON)
static StreamTwitterStatusList<USMFStatus>	readUSMF(InputStream stream, int nTweets, Class<? extends GeneralJSON> generalJSON, String charset)
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class org.openimaj.util.list.AbstractStreamBackedList

consumed, listIterator, randomSubList, readRecord, readRecordASCII, remaining, size

Methods inherited from class java.util.AbstractSequentialList

add, addAll, get, iterator, remove, set

Methods inherited from class java.util.AbstractList

add, clear, equals, hashCode, indexOf, lastIndexOf, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openimaj.util.list.RandomisableList

randomSubList

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Constructor Detail

StreamTwitterStatusList

protected StreamTwitterStatusList(InputStream stream,
                       int size,
                       boolean isBinary,
                       int headerLength,
                       int recordLength,
                       Class<T> clazz,
                       String charset)
                           throws IOException

Throws:

IOException

StreamTwitterStatusList

protected StreamTwitterStatusList(InputStream stream,
                       int size,
                       boolean isBinary,
                       int headerLength,
                       int recordLength,
                       Class<? extends GeneralJSON> inputClass,
                       Class<T> instanceClass,
                       String charset)
                           throws IOException

Throws:

IOException

StreamTwitterStatusList

protected StreamTwitterStatusList(InputStream stream,
                       int size,
                       boolean isBinary,
                       int headerLength,
                       int recordLength,
                       Class<T> clazz)
                           throws IOException

Throws:

IOException

Method Detail

newElementInstance

protected T newElementInstance()

Description copied from class: AbstractStreamBackedList

Override this id your instances can't be constructed with a no-args ctr

Overrides:

newElementInstance in class AbstractStreamBackedList<T extends USMFStatus>

Returns:

read

public static StreamTwitterStatusList<USMFStatus> read(InputStream stream,
                                       int nTweets)
                                                throws IOException

Construct a new StreamTwitterStatusList from the given input stream.

Parameters:

stream - the input stream

nTweets - of tweets to read from this stream

Returns:

a new list

Throws:

IOException - if an error occurs reading from the stream

read

public static StreamTwitterStatusList<USMFStatus> read(InputStream stream)
                                                throws IOException

Construct a new StreamTwitterStatusList from the given input stream.

Parameters:

stream - the input stream

Returns:

a new list

Throws:

IOException - if an error occurs reading from the stream

read

public static StreamTwitterStatusList<USMFStatus> read(InputStream stream,
                                       int nTweets,
                                       String charset)
                                                throws IOException

Construct a new StreamTwitterStatusList from the given input stream.

Parameters:

stream - the input stream

nTweets - of tweets to read from this stream

charset - the charset used to read the stream

Returns:

a new list

Throws:

IOException - if an error occurs reading from the stream

read

public static StreamTwitterStatusList<USMFStatus> read(InputStream stream,
                                       String charset)
                                                throws IOException

Construct a new StreamTwitterStatusList from the given input stream.

Parameters:

stream - the input stream

charset - the charset of the underlying stream

Returns:

a new list

Throws:

IOException - if an error occurs reading from the stream

read

public static <T extends USMFStatus> StreamTwitterStatusList<T> read(InputStream stream,
                                                     int nTweets,
                                                     Class<T> clazz)
                                                          throws IOException

Construct a new StreamTwitterStatusList from the given input stream.

Type Parameters:

T - the type of the USMFStatus instances returned

Parameters:

stream - the input stream

nTweets - of tweets to read from this stream

clazz - the class to instantiate

Returns:

a new list

Throws:

IOException - if an error occurs reading from the stream

readUSMF

public static StreamTwitterStatusList<USMFStatus> readUSMF(InputStream stream,
                                           Class<? extends GeneralJSON> generalJSON)
                                                    throws IOException

Parameters:

stream -

generalJSON -

Returns:

a list of USMFStatus instances

Throws:

IOException

readUSMF

public static StreamTwitterStatusList<USMFStatus> readUSMF(InputStream stream,
                                           Class<? extends GeneralJSON> generalJSON,
                                           String charset)
                                                    throws IOException

Parameters:

stream -

generalJSON -

charset - the charset to read with

Returns:

a list of USMFStatus instances

Throws:

IOException

readUSMF

public static StreamTwitterStatusList<USMFStatus> readUSMF(InputStream stream,
                                           int nTweets,
                                           Class<? extends GeneralJSON> generalJSON,
                                           String charset)
                                                    throws IOException

Parameters:

stream -

nTweets - number of tweets to read

generalJSON -

charset - the charset to read with

Returns:

a list of USMFStatus instances

Throws:

IOException

readUSMF

public static StreamTwitterStatusList<USMFStatus> readUSMF(InputStream stream,
                                           int nTweets,
                                           Class<? extends GeneralJSON> generalJSON)
                                                    throws IOException

Parameters:

stream -

nTweets -

generalJSON -

Returns:

a list of USMFStatus instances

Throws:

IOException

read

public static <T extends USMFStatus> StreamTwitterStatusList<T> read(InputStream stream,
                                                     int nTweets,
                                                     Class<? extends GeneralJSON> inputClass,
                                                     Class<T> instanceClass)
                                                          throws IOException

Type Parameters:

T -

Parameters:

stream -

nTweets -

inputClass - the class of used by the USMFStatus instances to read

instanceClass - the class of the USMFStatus instances

Returns:

a list of USMFStatus instances

Throws:

IOException

read

public static <T extends USMFStatus> StreamTwitterStatusList<T> read(BufferedInputStream stream,
                                                     int nTweets,
                                                     Class<? extends GeneralJSON> inputClass,
                                                     Class<T> instanceClass,
                                                     String charset)
                                                          throws IOException

Construct a new StreamTwitterStatusList from the given input stream.

Type Parameters:

T - the instance type

Parameters:

stream - the input stream

nTweets - the number of tweets expected

inputClass - the input class

instanceClass - the instance class

charset - the charset of the reader

Returns:

a new list

Throws:

IOException - if an error occurs reading from the stream

read

public static <T extends USMFStatus> StreamTwitterStatusList<T> read(BufferedInputStream stream,
                                                     int nTweets,
                                                     Class<T> clz)
                                                          throws IOException

Construct a new StreamTwitterStatusList from the given input stream.

Type Parameters:

T - the type of the USMFStats instances returned

Parameters:

stream - the input stream

nTweets - of tweets to read from this stream

clz - the class of local feature to read

Returns:

a new list

Throws:

IOException - if an error occurs reading from the stream

read

public static <T extends USMFStatus> StreamTwitterStatusList<T> read(BufferedInputStream stream,
                                                     int nTweets,
                                                     Class<T> clazz,
                                                     String charset)
                                                          throws IOException

Construct a new StreamTwitterStatusList from the given input stream.

Type Parameters:

T - the type of status instance returned

Parameters:

stream - the input stream

nTweets - of tweets to read from this stream

clazz - the class of local feature to read

charset - the charset to read with

Returns:

a new list

Throws:

IOException - if an error occurs reading from the stream

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

asciiHeader

public String asciiHeader()

Description copied from interface: WriteableASCII

Header for ascii output. Will be automatically written by IOUtils when using writeASCII().

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

binaryHeader

public byte[] binaryHeader()

Description copied from interface: WriteableBinary

Header for binary output. Will be automatically written by IOUtils when using writeBinary().

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header