org.openimaj.hadoop.tools.twitter.token.mode.pointwisemi.count

Class TokenPairCount

java.lang.Object

org.openimaj.util.pair.IndependentPair<T,T>

org.openimaj.util.pair.Pair<String>

org.openimaj.hadoop.tools.twitter.token.mode.pointwisemi.count.TokenPairCount

All Implemented Interfaces:

Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary

Direct Known Subclasses:

TokenPairUnaryCount

public class TokenPairCount
extends Pair<String>
implements ReadWriteable

A pair of strings with 2 distinct counts:

• number of times the pair appears together in a document

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isSingle
long	paircount Number of times this pair appears together

Constructor Summary

Constructors

Constructor and Description
TokenPairCount()
TokenPairCount(String tok1)
TokenPairCount(String tok1, String tok2)

Method Summary

Modifier and Type	Method and Description
void	add(TokenPairCount that)
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
String	identifier()
String	identifier(long time)
byte[]	identifierBinary(long time) Generate a byte array identifier with some time stamp included.
static IndependentPair<Long,TokenPairCount>	parseTimeTokenID(String string) Given a string, extract the time and TokenPairCount assuming the format: time + TokenPairCount#TIMESPLIT + identifier()
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
static long	timeFromBinaryIdentity(byte[] bytes)
static long	timeFromBinaryIdentity(byte[] bytes, int start, int length)
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 org.openimaj.util.pair.IndependentPair

equals, firstObject, getFirst, getFirstFunction, getFirstObject, getSecond, getSecondFunction, getSecondObject, pair, pairList, secondObject, setFirstObject, setSecondObject, swap, swapList

Methods inherited from class java.lang.Object

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

Field Detail

paircount

public long paircount

Number of times this pair appears together

isSingle

public boolean isSingle

Constructor Detail

TokenPairCount

public TokenPairCount()

TokenPairCount

public TokenPairCount(String tok1,
                      String tok2)

Parameters:

tok1 -

tok2 -

TokenPairCount

public TokenPairCount(String tok1)

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

add

public void add(TokenPairCount that)

identifier

public String identifier()

Returns:

identifier string without a count

toString

public String toString()

Overrides:

toString in class Pair<String>

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

parseTimeTokenID

public static IndependentPair<Long,TokenPairCount> parseTimeTokenID(String string)
                                                             throws IOException

Given a string, extract the time and TokenPairCount assuming the format: time + TokenPairCount#TIMESPLIT + identifier()

Parameters:

string -

Returns:

a time and TokenPairCount (with a zero count of course)

Throws:

IOException

identifier

public String identifier(long time)

identifierBinary

public byte[] identifierBinary(long time)
                        throws IOException

Generate a byte array identifier with some time stamp included. This function writes time then calls writeBinary(DataOutput)

Parameters:

time -

Returns:

a byte array encoded as: time,TokenPairCount

Throws:

IOException

timeFromBinaryIdentity

public static long timeFromBinaryIdentity(byte[] bytes)
                                   throws IOException

Throws:

IOException

timeFromBinaryIdentity

public static long timeFromBinaryIdentity(byte[] bytes,
                                          int start,
                                          int length)
                                   throws IOException

Throws:

IOException