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

java.lang.Object
  extended by java.lang.Enum<Counter.SortOption>
      extended by edu.northwestern.at.monk.model.Counter.SortOption
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Counter.SortOption>
Enclosing class:
Counter<T extends Container & java.lang.Comparable<? super T>,S extends Feature & java.lang.Comparable<? super S>>

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

Counter sorting options.


Enum Constant Summary
CONTAINER_ASCENDING
          Container ascending.
CONTAINER_DESCENDING
          Container descending.
COUNT_CUM_ASCENDING
          Cumulative count ascending.
COUNT_CUM_DESCENDING
          Cumulative count descending.
COUNT_CUM_MAIN_ASCENDING
          Cumulative count ascending over main text (non-paratext).
COUNT_CUM_MAIN_DESCENDING
          Cumulative count descending over main text (non-paratext).
COUNT_NON_CUM_ASCENDING
          Non-cumulative count ascending.
COUNT_NON_CUM_DESCENDING
          Non-cumulative count descending.
COUNT_NON_CUM_MAIN_ASCENDING
          Non-cumulative count ascending over main text (non-paratext).
COUNT_NON_CUM_MAIN_DESCENDING
          Non-cumulative count descending over main text (non-paratext).
FEATURE_ASCENDING
          Feature ascending.
FEATURE_DESCENDING
          Feature descending.
FREQ_CUM_ASCENDING
          Cumulative freq ascending.
FREQ_CUM_DESCENDING
          Cumulative freq descending.
FREQ_CUM_MAIN_ASCENDING
          Cumulative freq ascending over main text (non-paratext).
FREQ_CUM_MAIN_DESCENDING
          Cumulative freq descending over main text (non-paratext).
FREQ_NON_CUM_ASCENDING
          Non-cumulative freq ascending.
FREQ_NON_CUM_DESCENDING
          Non-cumulative freq descending.
FREQ_NON_CUM_MAIN_ASCENDING
          Non-cumulative freq ascending over main text (non-paratext).
FREQ_NON_CUM_MAIN_DESCENDING
          Non-cumulative freq descending over main text (non-paratext).
NATURAL
          The natural sorting order - first by container ascending, then by feature ascending.
 
Method Summary
static Counter.SortOption valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Counter.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 Counter.SortOption NATURAL
The natural sorting order - first by container ascending, then by feature ascending.


CONTAINER_ASCENDING

public static final Counter.SortOption CONTAINER_ASCENDING
Container ascending.


CONTAINER_DESCENDING

public static final Counter.SortOption CONTAINER_DESCENDING
Container descending.


FEATURE_ASCENDING

public static final Counter.SortOption FEATURE_ASCENDING
Feature ascending.


FEATURE_DESCENDING

public static final Counter.SortOption FEATURE_DESCENDING
Feature descending.


COUNT_CUM_ASCENDING

public static final Counter.SortOption COUNT_CUM_ASCENDING
Cumulative count ascending.


COUNT_CUM_DESCENDING

public static final Counter.SortOption COUNT_CUM_DESCENDING
Cumulative count descending.


COUNT_NON_CUM_ASCENDING

public static final Counter.SortOption COUNT_NON_CUM_ASCENDING
Non-cumulative count ascending.


COUNT_NON_CUM_DESCENDING

public static final Counter.SortOption COUNT_NON_CUM_DESCENDING
Non-cumulative count descending.


FREQ_CUM_ASCENDING

public static final Counter.SortOption FREQ_CUM_ASCENDING
Cumulative freq ascending.


FREQ_CUM_DESCENDING

public static final Counter.SortOption FREQ_CUM_DESCENDING
Cumulative freq descending.


FREQ_NON_CUM_ASCENDING

public static final Counter.SortOption FREQ_NON_CUM_ASCENDING
Non-cumulative freq ascending.


FREQ_NON_CUM_DESCENDING

public static final Counter.SortOption FREQ_NON_CUM_DESCENDING
Non-cumulative freq descending.


COUNT_CUM_MAIN_ASCENDING

public static final Counter.SortOption COUNT_CUM_MAIN_ASCENDING
Cumulative count ascending over main text (non-paratext).


COUNT_CUM_MAIN_DESCENDING

public static final Counter.SortOption COUNT_CUM_MAIN_DESCENDING
Cumulative count descending over main text (non-paratext).


COUNT_NON_CUM_MAIN_ASCENDING

public static final Counter.SortOption COUNT_NON_CUM_MAIN_ASCENDING
Non-cumulative count ascending over main text (non-paratext).


COUNT_NON_CUM_MAIN_DESCENDING

public static final Counter.SortOption COUNT_NON_CUM_MAIN_DESCENDING
Non-cumulative count descending over main text (non-paratext).


FREQ_CUM_MAIN_ASCENDING

public static final Counter.SortOption FREQ_CUM_MAIN_ASCENDING
Cumulative freq ascending over main text (non-paratext).


FREQ_CUM_MAIN_DESCENDING

public static final Counter.SortOption FREQ_CUM_MAIN_DESCENDING
Cumulative freq descending over main text (non-paratext).


FREQ_NON_CUM_MAIN_ASCENDING

public static final Counter.SortOption FREQ_NON_CUM_MAIN_ASCENDING
Non-cumulative freq ascending over main text (non-paratext).


FREQ_NON_CUM_MAIN_DESCENDING

public static final Counter.SortOption FREQ_NON_CUM_MAIN_DESCENDING
Non-cumulative freq descending over main text (non-paratext).

Method Detail

values

public static final Counter.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(Counter.SortOption c : Counter.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 Counter.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