org.treetank.service.xml.xpath

Enum OrdState

java.lang.Object

java.lang.Enum<OrdState>

org.treetank.service.xml.xpath.OrdState

All Implemented Interfaces:

Serializable, Comparable<OrdState>

public enum OrdState
extends Enum<OrdState>

Enum represents different states of the result order that help to specify, if the result query will be in document order or not.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GEN State of the HiddersMichiels - automaton.
GENSIB State of the HiddersMichiels - automaton.
LIN State of the HiddersMichiels - automaton.
MAX1 State of the HiddersMichiels - automaton.
SIB State of the HiddersMichiels - automaton.
UNORD State of the HiddersMichiels - automaton.

Method Summary

Methods

Modifier and Type	Method and Description
void	init() Initializes the order state.
OrdState	updateOrdAncestor() Changes the state according to a ancestor step.
OrdState	updateOrdChild() Changes the state according to a child step.
OrdState	updateOrdDesc() Changes the state according to a descendant/ descendant-or.self step.
OrdState	updateOrdFollPre() Changes the state according to a following/preceding step.
OrdState	updateOrdFollPreSib() Changes the state according to a following-sibling/preceding-sibling step.
OrdState	updateOrdParent() Changes the state according to a parent step.
OrdState	updateOrdUnion() Changes the state according to a union step.
static OrdState	valueOf(String name) Returns the enum constant of this type with the specified name.
static OrdState[]	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

LIN

public static final OrdState LIN

State of the HiddersMichiels - automaton.

MAX1

public static final OrdState MAX1

State of the HiddersMichiels - automaton.

GENSIB

public static final OrdState GENSIB

State of the HiddersMichiels - automaton.

GEN

public static final OrdState GEN

State of the HiddersMichiels - automaton.

SIB

public static final OrdState SIB

State of the HiddersMichiels - automaton.

UNORD

public static final OrdState UNORD

State of the HiddersMichiels - automaton.

Method Detail

values

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

Returns:

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

valueOf

public static OrdState 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

updateOrdChild

public OrdState updateOrdChild()

Changes the state according to a child step.

Returns:

the updated order state

updateOrdUnion

public OrdState updateOrdUnion()

Changes the state according to a union step.

Returns:

the updated order state

updateOrdParent

public OrdState updateOrdParent()

Changes the state according to a parent step.

Returns:

the updated order state

updateOrdDesc

public OrdState updateOrdDesc()

Changes the state according to a descendant/ descendant-or.self step.

Returns:

the updated order state

updateOrdFollPre

public OrdState updateOrdFollPre()

Changes the state according to a following/preceding step.

Returns:

the updated order state

updateOrdFollPreSib

public OrdState updateOrdFollPreSib()

Changes the state according to a following-sibling/preceding-sibling step.

Returns:

the updated order state

updateOrdAncestor

public OrdState updateOrdAncestor()

Changes the state according to a ancestor step.

Returns:

the updated order state

init

public void init()

Initializes the order state.