edu.northwestern.at.monk.model
Enum Lemma.SortOption

java.lang.Object
  extended by java.lang.Enum<Lemma.SortOption>
      extended by edu.northwestern.at.monk.model.Lemma.SortOption
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Lemma.SortOption>
Enclosing class:
Lemma

public static enum Lemma.SortOption
extends java.lang.Enum<Lemma.SortOption>

Lemma sorting options.


Enum Constant Summary
HEADWORD_ASCENDING
          Headword ascending.
HEADWORD_DESCENDING
          Headword descending.
HOMONYM_ASCENDING
          Homonym number ascending.
HOMONYM_DESCENDING
          Homonym number descending.
NATURAL
          The natural sorting order - by tag ascending.
TAG_ASCENDING
          Tag ascending.
TAG_DESCENDING
          Tag descending.
WORD_CLASS_ASCENDING
          Word class ascending.
WORD_CLASS_DESCENDING
          Word class descending.
 
Method Summary
static Lemma.SortOption valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Lemma.SortOption[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NATURAL

public static final Lemma.SortOption NATURAL
The natural sorting order - by tag ascending.


TAG_ASCENDING

public static final Lemma.SortOption TAG_ASCENDING
Tag ascending.


TAG_DESCENDING

public static final Lemma.SortOption TAG_DESCENDING
Tag descending.


HEADWORD_ASCENDING

public static final Lemma.SortOption HEADWORD_ASCENDING
Headword ascending.


HEADWORD_DESCENDING

public static final Lemma.SortOption HEADWORD_DESCENDING
Headword descending.


HOMONYM_ASCENDING

public static final Lemma.SortOption HOMONYM_ASCENDING
Homonym number ascending.


HOMONYM_DESCENDING

public static final Lemma.SortOption HOMONYM_DESCENDING
Homonym number descending.


WORD_CLASS_ASCENDING

public static final Lemma.SortOption WORD_CLASS_ASCENDING
Word class ascending.


WORD_CLASS_DESCENDING

public static final Lemma.SortOption WORD_CLASS_DESCENDING
Word class descending.

Method Detail

values

public static final Lemma.SortOption[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(Lemma.SortOption c : Lemma.SortOption.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static Lemma.SortOption 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