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

Enum TwitterTokenModeOption

java.lang.Object

java.lang.Enum<TwitterTokenModeOption>

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

All Implemented Interfaces:

Serializable, Comparable<TwitterTokenModeOption>, CmdLineOptionsProvider

public enum TwitterTokenModeOption
extends Enum<TwitterTokenModeOption>
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
DFIDF Calculates DF-IDF for each term as described by: "Event Detection in Twitter" by J.
JUST_OUTPUT Skip the actual processing, assume the input contains the data needed by the output
MATCH_TERM In the JSONPath requested locate tweets with terms which contain any of the tokens requested.
PAIRMI Calculates DF-IDF for each term as described by: "Event Detection in Twitter" by J.

Method Summary

Modifier and Type	Method and Description
abstract TwitterTokenMode	getOptions()
static TwitterTokenModeOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static TwitterTokenModeOption[]	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

DFIDF

public static final TwitterTokenModeOption DFIDF

Calculates DF-IDF for each term as described by: "Event Detection in Twitter" by J. Weng et. al.

PAIRMI

public static final TwitterTokenModeOption PAIRMI

Calculates DF-IDF for each term as described by: "Event Detection in Twitter" by J. Weng et. al.

MATCH_TERM

public static final TwitterTokenModeOption MATCH_TERM

In the JSONPath requested locate tweets with terms which contain any of the tokens requested. The tokens may be regex

JUST_OUTPUT

public static final TwitterTokenModeOption JUST_OUTPUT

Skip the actual processing, assume the input contains the data needed by the output

Method Detail

values

public static TwitterTokenModeOption[] 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 (TwitterTokenModeOption c : TwitterTokenModeOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static TwitterTokenModeOption 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 TwitterTokenMode getOptions()

Specified by:

getOptions in interface CmdLineOptionsProvider

Returns:

the object providing options/arguments