eu.project.ttc.engines.cleaner

Enum TermProperty

java.lang.Object

java.lang.Enum<TermProperty>

eu.project.ttc.engines.cleaner.TermProperty

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TermProperty>

public enum TermProperty
extends java.lang.Enum<TermProperty>

Available term properties that can be used for AE and script configuration (especially in term index cleaning sorting and exporting operations)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCUMENT_FREQUENCY
FREQUENCY
FREQUENCY_NORM
GENERAL_FREQUENCY_NORM
GROUPING_KEY
LEMMA
PATTERN
PILOT
RANK
SPECIFICITY
SPOTTING_RULE
TERM_CLASS_FREQUENCY
TERM_CLASS_HEAD
WR
WR_LOG
WR_LOG_Z_SCORE

Method Summary

Modifier and Type	Method and Description
int	compare(TermIndex termIndex, Term o1, Term o2) The "compare" method that can apply on property measures.
int	compare(Term o1, Term o2)
static TermProperty	forName(java.lang.String name)
java.util.Comparator<Term>	getComparator(boolean reverse)
java.util.Comparator<Term>	getComparator(TermIndex termIndex, boolean reverse)
double	getDoubleValue(Term t)
double	getDoubleValue(TermIndex termIndex, Term t)
java.lang.String	getPropertyName()
java.lang.Class<?>	getRange()
java.lang.String	getShortName()
java.lang.Comparable<?>	getValue(Term t)
java.lang.Comparable<?>	getValue(TermIndex termIndex, Term t)
boolean	isDecimalNumber()
boolean	isMeasure()
boolean	isNumber()
static TermProperty	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TermProperty[]	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

RANK

public static final TermProperty RANK

DOCUMENT_FREQUENCY

public static final TermProperty DOCUMENT_FREQUENCY

FREQUENCY_NORM

public static final TermProperty FREQUENCY_NORM

GENERAL_FREQUENCY_NORM

public static final TermProperty GENERAL_FREQUENCY_NORM

SPECIFICITY

public static final TermProperty SPECIFICITY

WR

public static final TermProperty WR

WR_LOG

public static final TermProperty WR_LOG

WR_LOG_Z_SCORE

public static final TermProperty WR_LOG_Z_SCORE

FREQUENCY

public static final TermProperty FREQUENCY

PILOT

public static final TermProperty PILOT

LEMMA

public static final TermProperty LEMMA

GROUPING_KEY

public static final TermProperty GROUPING_KEY

PATTERN

public static final TermProperty PATTERN

SPOTTING_RULE

public static final TermProperty SPOTTING_RULE

TERM_CLASS_HEAD

public static final TermProperty TERM_CLASS_HEAD

TERM_CLASS_FREQUENCY

public static final TermProperty TERM_CLASS_FREQUENCY

Method Detail

values

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

Returns:

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

valueOf

public static TermProperty valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getRange

public java.lang.Class<?> getRange()

isDecimalNumber

public boolean isDecimalNumber()

isNumber

public boolean isNumber()

isMeasure

public boolean isMeasure()

getPropertyName

public java.lang.String getPropertyName()

getComparator

public java.util.Comparator<Term> getComparator(boolean reverse)

getComparator

public java.util.Comparator<Term> getComparator(TermIndex termIndex,
                                                boolean reverse)

compare

public int compare(TermIndex termIndex,
                   Term o1,
                   Term o2)

The "compare" method that can apply on property measures.

Parameters:

termIndex -

o1 -

o2 -

Returns:

compare

public int compare(Term o1,
                   Term o2)

getDoubleValue

public double getDoubleValue(TermIndex termIndex,
                             Term t)

getDoubleValue

public double getDoubleValue(Term t)

getValue

public java.lang.Comparable<?> getValue(TermIndex termIndex,
                                        Term t)

getValue

public java.lang.Comparable<?> getValue(Term t)

forName

public static TermProperty forName(java.lang.String name)

getShortName

public java.lang.String getShortName()