org.openimaj.hadoop.tools.twitter.token.outputmode

Enum TwitterTokenOutputModeOption

java.lang.Object

java.lang.Enum<TwitterTokenOutputModeOption>

org.openimaj.hadoop.tools.twitter.token.outputmode.TwitterTokenOutputModeOption

All Implemented Interfaces:

Serializable, Comparable<TwitterTokenOutputModeOption>, CmdLineOptionsProvider

public enum TwitterTokenOutputModeOption
extends Enum<TwitterTokenOutputModeOption>
implements CmdLineOptionsProvider

A twitter tweet token counting mode

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CORRELATION
CSV outputs a CSV file
JACARD_INDEX outputs the jacard index at each time step, a measure for how similar the sets of words are between two timesteps
NONE don't do anything
SPECIFIC_WORD outputs a SPECIFIC_WORDfile
WORD_STATS Output some statistics about the words

Method Summary

Modifier and Type	Method and Description
abstract TwitterTokenOutputMode	getOptions()
static TwitterTokenOutputModeOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static TwitterTokenOutputModeOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CSV

public static final TwitterTokenOutputModeOption CSV

outputs a CSV file

SPECIFIC_WORD

public static final TwitterTokenOutputModeOption SPECIFIC_WORD

outputs a SPECIFIC_WORDfile

JACARD_INDEX

public static final TwitterTokenOutputModeOption JACARD_INDEX

outputs the jacard index at each time step, a measure for how similar the sets of words are between two timesteps

CORRELATION

public static final TwitterTokenOutputModeOption CORRELATION

WORD_STATS

public static final TwitterTokenOutputModeOption WORD_STATS

Output some statistics about the words

NONE

public static final TwitterTokenOutputModeOption NONE

don't do anything

Method Detail

values

public static TwitterTokenOutputModeOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TwitterTokenOutputModeOption c : TwitterTokenOutputModeOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TwitterTokenOutputModeOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOptions

public abstract TwitterTokenOutputMode getOptions()

Specified by:

getOptions in interface CmdLineOptionsProvider

Returns:

the object providing options/arguments