org.openimaj.hadoop.tools.twitter.utils

Class WordDFIDFTimeSeries

java.lang.Object

org.openimaj.ml.timeseries.TimeSeries<DATA[],DATA,TS>

org.openimaj.ml.timeseries.series.ConcreteTimeSeries<WordDFIDF,WordDFIDFTimeSeries>

org.openimaj.hadoop.tools.twitter.utils.WordDFIDFTimeSeries

All Implemented Interfaces:

Iterable<IndependentPair<Long,WordDFIDF>>, ReadableASCII, ReadWriteableASCII, WriteableASCII, TimeSeriesCollectionAssignable<WordDFIDF,WordDFIDFTimeSeries>, DoubleTimeSeriesProvider, TimeSeriesArithmaticOperator<WordDFIDF,WordDFIDFTimeSeries>

public class WordDFIDFTimeSeries
extends ConcreteTimeSeries<WordDFIDF,WordDFIDFTimeSeries>
implements TimeSeriesArithmaticOperator<WordDFIDF,WordDFIDFTimeSeries>, DoubleTimeSeriesProvider, ReadWriteableASCII

A time series of WordDFIDF instances

Author:

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

Constructor Summary

Constructors

Constructor and Description
WordDFIDFTimeSeries()

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
DoubleTimeSeries	doubleTimeSeries()
WordDFIDFTimeSeries	newInstance()
void	readASCII(Scanner in) Read internal state from in.
WordDFIDF	sum() An explicit assumption is made that WordDFIDF instances all come from the same period of time and therefore have the same total number of tweets and total number of word instances across time (i.e.
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.
WordDFIDF	zero()

Methods inherited from class org.openimaj.ml.timeseries.series.ConcreteTimeSeries

add, get, get, get, get, getData, getTimes, internalAssign, internalAssign, internalAssign, iterator, newInstance, set, size, toString

Methods inherited from class org.openimaj.ml.timeseries.TimeSeries

convert, convert, copy, get, process, processInplace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

WordDFIDFTimeSeries

public WordDFIDFTimeSeries()

Method Detail

newInstance

public WordDFIDFTimeSeries newInstance()

Specified by:

newInstance in class TimeSeries<WordDFIDF[],WordDFIDF,WordDFIDFTimeSeries>

Returns:

an empty new instance of this timeseries type

zero

public WordDFIDF zero()

Specified by:

zero in interface TimeSeriesArithmaticOperator<WordDFIDF,WordDFIDFTimeSeries>

Returns:

a 0 data for this time series

sum

public WordDFIDF sum()

An explicit assumption is made that WordDFIDF instances all come from the same period of time and therefore have the same total number of tweets and total number of word instances across time (i.e. WordDFIDF.Ttf and WordDFIDF.Twf remain untouched)

Specified by:

sum in interface TimeSeriesArithmaticOperator<WordDFIDF,WordDFIDFTimeSeries>

Returns:

Addition of all time series

doubleTimeSeries

public DoubleTimeSeries doubleTimeSeries()

Specified by:

doubleTimeSeries in interface DoubleTimeSeriesProvider

Returns:

provide an instance of a double time series for this time series

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

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