org.openimaj.hadoop.tools.twitter.utils

Class TweetCountWordMap

java.lang.Object

org.openimaj.hadoop.tools.twitter.utils.TweetCountWordMap

All Implemented Interfaces:

ReadableBinary, ReadWriteableBinary, WriteableBinary

public class TweetCountWordMap
extends Object
implements ReadWriteableBinary

Class encapsulating a number of tweets across which certain words were seen

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	INVALID_TWEET_COUNT If the ntweets is set to this value, the ntweets should be ignored

Constructor Summary

Constructors

Constructor and Description
TweetCountWordMap() empty words and 0 tweets
TweetCountWordMap(int ntweets, gnu.trove.map.hash.TObjectIntHashMap<String> wordMap)

Method Summary

Modifier and Type	Method and Description
byte[]	binaryHeader() Header for binary input.
void	combine(TweetCountWordMap that) Add values from "that" to those in this if they exist, otherwise create the element and start a new count
boolean	equals(Object other)
long	getNTweets()
gnu.trove.map.hash.TObjectIntHashMap<String>	getTweetWordMap()
void	incrementTweetCount(int i)
void	readBinary(DataInput in) Read internal state from in.
void	setNTweets(int ntweets) set the number of tweets
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_TWEET_COUNT

public static final int INVALID_TWEET_COUNT

If the ntweets is set to this value, the ntweets should be ignored

See Also:

Constant Field Values

Constructor Detail

TweetCountWordMap

public TweetCountWordMap()

empty words and 0 tweets

TweetCountWordMap

public TweetCountWordMap(int ntweets,
                         gnu.trove.map.hash.TObjectIntHashMap<String> wordMap)

Parameters:

ntweets -

wordMap -

Method Detail

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

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getTweetWordMap

public gnu.trove.map.hash.TObjectIntHashMap<String> getTweetWordMap()

Returns:

the word map

incrementTweetCount

public void incrementTweetCount(int i)

Parameters:

i - increment number of tweets by this amount

combine

public void combine(TweetCountWordMap that)

Add values from "that" to those in this if they exist, otherwise create the element and start a new count

Parameters:

that -

getNTweets

public long getNTweets()

Returns:

the number of tweets

setNTweets

public void setNTweets(int ntweets)

set the number of tweets

Parameters:

ntweets -