org.openimaj.hadoop.tools.twitter.token.mode.dfidf

Class TimeFrequencyHolder.TimeFrequency

java.lang.Object

org.openimaj.hadoop.tools.twitter.token.mode.dfidf.TimeFrequencyHolder.TimeFrequency

All Implemented Interfaces:

ReadableBinary, ReadWriteableBinary, WriteableBinary

Enclosing class:

TimeFrequencyHolder

public static class TimeFrequencyHolder.TimeFrequency
extends Object
implements ReadWriteableBinary

Holds the number of a thing at a moment in time and the total number of that thing seen across all time

Author:

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

Constructor Summary

Constructors

Constructor and Description
TimeFrequency() default
TimeFrequency(long time, long frequency) initialise, presumed to be at the beginning of some time period so the cumulative == the period frequency

Method Summary

Modifier and Type	Method and Description
byte[]	binaryHeader() Header for binary input.
TimeFrequencyHolder.TimeFrequency	combine(long l, long nTweets)
TimeFrequencyHolder.TimeFrequency	combine(TimeFrequencyHolder.TimeFrequency other) Given a TimeFrequencyHolder.TimeFrequency instance, keep count of cumulative frequency and set the periodFrequency to the one furthest along in time
void	readBinary(DataInput in) Read internal state from in.
String	toString()
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeFrequency

public TimeFrequency()

default

TimeFrequency

public TimeFrequency(long time,
                     long frequency)

initialise, presumed to be at the beginning of some time period so the cumulative == the period frequency

Parameters:

time -

frequency -

Method Detail

toString

public String toString()

Overrides:

toString in class Object

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

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

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

combine

public TimeFrequencyHolder.TimeFrequency combine(TimeFrequencyHolder.TimeFrequency other)

Given a TimeFrequencyHolder.TimeFrequency instance, keep count of cumulative frequency and set the periodFrequency to the one furthest along in time

Parameters:

other -

Returns:

a new TimeFrequencyHolder.TimeFrequency instance

combine

public TimeFrequencyHolder.TimeFrequency combine(long l,
                                                 long nTweets)

Parameters:

l -

nTweets -

Returns:

a new TimeFrequencyHolder.TimeFrequency instance