org.openimaj.hadoop.tools.twitter.utils

Class WordDFIDF

java.lang.Object

org.openimaj.hadoop.tools.twitter.utils.WordDFIDF

All Implemented Interfaces:

Comparable<WordDFIDF>, Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary

Direct Known Subclasses:

WordDFIDFValue

public class WordDFIDF
extends Object
implements ReadWriteable, Comparable<WordDFIDF>

Convenience class which holds all the components required to calculate DF-IDF

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
long	tf Number of tweets in this timeperiod
long	timeperiod the measurment time period
long	Ttf Total number of tweets in all timeperiods
long	Twf Number of tweets containing this word in all timeperiods
long	wf Number of tweets containing this word in this time period

Constructor Summary

Constructors

Constructor and Description
WordDFIDF() Helpful for reading
WordDFIDF(long timeperiod, long wf, long tf, long twf, long ttf)

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
int	compareTo(WordDFIDF other)
double	dfidf() DF-IDF as defined by "Event Detection in Twitter by J.
boolean	equals(Object obj)
int	hashCode()
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
String	toString()
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 java.lang.Object

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

Field Detail

Ttf

public long Ttf

Total number of tweets in all timeperiods

Twf

public long Twf

Number of tweets containing this word in all timeperiods

tf

public long tf

Number of tweets in this timeperiod

wf

public long wf

Number of tweets containing this word in this time period

timeperiod

public long timeperiod

the measurment time period

Constructor Detail

WordDFIDF

public WordDFIDF()

Helpful for reading

WordDFIDF

public WordDFIDF(long timeperiod,
                 long wf,
                 long tf,
                 long twf,
                 long ttf)

Parameters:

timeperiod - the timeperiod

wf - Word count in this timeperiod

tf - Tweet count in this timeperiod

twf - Word count across all time

ttf - Tweet count across all time

Method Detail

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: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

dfidf

public double dfidf()

DF-IDF as defined by "Event Detection in Twitter by J. Weng et. al. 2011"

Returns:

the DF-IDF score

compareTo

public int compareTo(WordDFIDF other)

Specified by:

compareTo in interface Comparable<WordDFIDF>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

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