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

Class WritableEnumCounter<T extends Enum<?>>

java.lang.Object

org.openimaj.hadoop.tools.twitter.token.mode.WritableEnumCounter<T>

Type Parameters:

T - the enum type

All Implemented Interfaces:

ReadableASCII, ReadWriteableASCII, WriteableASCII

Direct Known Subclasses:

WritablePairEnum

public abstract class WritableEnumCounter<T extends Enum<?>>
extends Object
implements ReadWriteableASCII

A writeable hadoop Counter written using the enum used with the counter

Author:

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

Constructor Summary

Constructors

Constructor and Description
WritableEnumCounter() initialise the values map
WritableEnumCounter(org.apache.hadoop.mapreduce.Counters counters, T[] enumType) intitalise the global stats from some counters

Method Summary

Methods

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
long	getValue(T type)
void	readASCII(Scanner in) Read internal state from in.
void	setValue(T type, Long value)
abstract T	valueOf(String str)
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.

Methods inherited from class java.lang.Object

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

Constructor Detail

WritableEnumCounter

public WritableEnumCounter()

initialise the values map

WritableEnumCounter

public WritableEnumCounter(org.apache.hadoop.mapreduce.Counters counters,
                   T[] enumType)

intitalise the global stats from some counters

Parameters:

counters - the counters to look for the enum types in

enumType - the enum types

Method Detail

setValue

public void setValue(T type,
            Long value)

Parameters:

type -

value -

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

valueOf

public abstract T valueOf(String str)

Parameters:

str -

Returns:

The enum value of a given name

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

getValue

public long getValue(T type)

Parameters:

type -

Returns:

the value for the given type