Package org.corpus_tools.graphannis

Enum CorpusStorageManager.ResultOrder

java.lang.Object

java.lang.Enum<CorpusStorageManager.ResultOrder>

org.corpus_tools.graphannis.CorpusStorageManager.ResultOrder

All Implemented Interfaces:

Serializable, Comparable<CorpusStorageManager.ResultOrder>

Enclosing class:

CorpusStorageManager

public static enum CorpusStorageManager.ResultOrder
extends Enum<CorpusStorageManager.ResultOrder>

Defines the order of results of a "find" query. *

Enum Constant Summary

Enum Constants

Enum Constant	Description
Inverted	Inverted the order of Normal
Normal	Order results by their document name and the the text position of the match.
NotSorted	Results are not ordered at all, but also not actively randomized.
Randomized	A random ordering which is not stable.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	capiVal

Method Summary

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

Normal

public static final CorpusStorageManager.ResultOrder Normal

Order results by their document name and the the text position of the match.

Inverted

public static final CorpusStorageManager.ResultOrder Inverted

Inverted the order of Normal

Randomized

public static final CorpusStorageManager.ResultOrder Randomized

A random ordering which is not stable. Each new query will result in a different order.

NotSorted

public static final CorpusStorageManager.ResultOrder NotSorted

Results are not ordered at all, but also not actively randomized. Each new query might result in a different order.

Field Detail

capiVal

protected final int capiVal

Method Detail

values

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

Returns:

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

valueOf

public static CorpusStorageManager.ResultOrder 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