fr.univnantes.termsuite.model

Enum TermProperty

java.lang.Object

java.lang.Enum<TermProperty>

fr.univnantes.termsuite.model.TermProperty

All Implemented Interfaces:

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

public enum TermProperty
extends java.lang.Enum<TermProperty>
implements Property<Term>

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
DEPTH
DOCUMENT_FREQUENCY
FILTERED
FREQUENCY
FREQUENCY_NORM
GENERAL_FREQUENCY_NORM
GROUPING_KEY
INDEPENDANCE
INDEPENDANT_FREQUENCY
IS_FIXED_EXPRESSION
IS_SINGLE_WORD
LEMMA
ORTHOGRAPHIC_SCORE
PATTERN
PILOT
RANK
SPEC_IDF
SPECIFICITY
SPOTTING_RULE
SWT_SIZE
TF_IDF

Method Summary

Modifier and Type	Method and Description
int	compare(Term o1, Term o2)
static TermProperty	forName(java.lang.String name)
static java.util.Optional<TermProperty>	forNameOptional(java.lang.String name)
static TermProperty	fromJsonString(java.lang.String field)
java.util.Comparator<Term>	getComparator()
java.util.Comparator<Term>	getComparator(boolean reverse)
java.lang.String	getJsonField()
java.lang.String	getPropertyName()
java.lang.Class<?>	getRange()
java.lang.String	getShortName()
boolean	isDecimalNumber()
boolean	isNumeric()
static java.util.stream.Stream<TermProperty>	numberValues()
static java.util.stream.Stream<TermProperty>	stream()
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

IS_SINGLE_WORD

public static final TermProperty IS_SINGLE_WORD

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

FREQUENCY

public static final TermProperty FREQUENCY

ORTHOGRAPHIC_SCORE

public static final TermProperty ORTHOGRAPHIC_SCORE

INDEPENDANT_FREQUENCY

public static final TermProperty INDEPENDANT_FREQUENCY

INDEPENDANCE

public static final TermProperty INDEPENDANCE

PILOT

public static final TermProperty PILOT

LEMMA

public static final TermProperty LEMMA

TF_IDF

public static final TermProperty TF_IDF

SPEC_IDF

public static final TermProperty SPEC_IDF

GROUPING_KEY

public static final TermProperty GROUPING_KEY

PATTERN

public static final TermProperty PATTERN

SPOTTING_RULE

public static final TermProperty SPOTTING_RULE

IS_FIXED_EXPRESSION

public static final TermProperty IS_FIXED_EXPRESSION

SWT_SIZE

public static final TermProperty SWT_SIZE

FILTERED

public static final TermProperty FILTERED

DEPTH

public static final TermProperty DEPTH

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

getPropertyName

public java.lang.String getPropertyName()

Specified by:

getPropertyName in interface Property<Term>

getJsonField

public java.lang.String getJsonField()

Specified by:

getJsonField in interface Property<Term>

getRange

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

Specified by:

getRange in interface Property<Term>

getShortName

public java.lang.String getShortName()

Specified by:

getShortName in interface Property<Term>

isNumeric

public boolean isNumeric()

Specified by:

isNumeric in interface Property<Term>

isDecimalNumber

public boolean isDecimalNumber()

Specified by:

isDecimalNumber in interface Property<Term>

getComparator

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

Specified by:

getComparator in interface Property<Term>

getComparator

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

Specified by:

getComparator in interface Property<Term>

compare

public int compare(Term o1,
                   Term o2)

Specified by:

compare in interface Property<Term>

forName

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

forNameOptional

public static java.util.Optional<TermProperty> forNameOptional(java.lang.String name)

fromJsonString

public static TermProperty fromJsonString(java.lang.String field)

numberValues

public static java.util.stream.Stream<TermProperty> numberValues()

stream

public static java.util.stream.Stream<TermProperty> stream()