org.basex.query.xpath.locpath
Enum Axis

java.lang.Object
  extended by java.lang.Enum<Axis>
      extended by org.basex.query.xpath.locpath.Axis
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Axis>

public enum Axis
extends java.lang.Enum<Axis>

Defined Axes in XPath.

Author:
Workgroup DBIS, University of Konstanz 2005-08, ISC License, Tim Petrowsky, Christian Gruen

Enum Constant Summary
ANC
          Ancestor.
ANCORSELF
          AncOrSelf.
ATTR
          Attribute.
CHILD
          Child.
DESC
          Descendant.
DESCORSELF
          DescOrSelf.
FOLL
          Following.
FOLLSIBL
          FollSibl.
PARENT
          Parent.
PREC
          Preceding.
PRECSIBL
          PrecSibl.
SELF
          Self.
 
Method Summary
static Step create(Axis a, Test test)
          Returns a location step instance.
static Step create(Axis a, Test test, Preds preds)
          Returns a location step instance.
static Axis find(java.lang.String c)
          Returns the specified command.
static Axis valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Axis[] values()
          Returns an array containing the constants of this enum type, in the order they are 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

ANC

public static final Axis ANC
Ancestor.


ANCORSELF

public static final Axis ANCORSELF
AncOrSelf.


ATTR

public static final Axis ATTR
Attribute.


CHILD

public static final Axis CHILD
Child.


DESC

public static final Axis DESC
Descendant.


DESCORSELF

public static final Axis DESCORSELF
DescOrSelf.


FOLL

public static final Axis FOLL
Following.


FOLLSIBL

public static final Axis FOLLSIBL
FollSibl.


PARENT

public static final Axis PARENT
Parent.


PREC

public static final Axis PREC
Preceding.


PRECSIBL

public static final Axis PRECSIBL
PrecSibl.


SELF

public static final Axis SELF
Self.

Method Detail

values

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

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

valueOf

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

find

public static Axis find(java.lang.String c)
Returns the specified command.

Parameters:
c - command to be found
Returns:
command

create

public static Step create(Axis a,
                          Test test)
Returns a location step instance.

Parameters:
a - axis
test - node test
Returns:
step

create

public static Step create(Axis a,
                          Test test,
                          Preds preds)
Returns a location step instance.

Parameters:
a - axis
test - node test
preds - predicates
Returns:
step