com.virtualweaver.xotics.datamodel.datatype
Class XdpAnt

java.lang.Object
  extended bycom.virtualweaver.xotics.datamodel.datatype.XdpAnt
All Implemented Interfaces:
java.lang.Cloneable, XoDataType

public final class XdpAnt
extends java.lang.Object
implements XoDataType, java.lang.Cloneable

This class represents an XPath Axis / node test part used in a step. This class is exclusively used in XPath request processing, particularly in XoRequestToolkit.computeSteps(XdpNode, XdpAnt[]) and related methods.

Version:
4.1

Field Summary
static byte ANCESTOR_AXIS
           
static byte ANCESTOR_OR_SELF_AXIS
           
static byte ATTRIBUTE_AXIS
           
static byte ATTRIBUTE_KT
           
static byte CHILD_AXIS
           
static byte DESCENDANT_AXIS
           
static byte DESCENDANT_OR_SELF_AXIS
           
static byte ELEMENT_KT
           
static byte FOLLOWING_AXIS
           
static byte FOLLOWING_SIBLING_AXIS
           
static byte NAMESPACE_AXIS
           
static byte NODE_KT
           
static byte PARENT_AXIS
           
static byte PRECEDING_AXIS
           
static byte PRECEDING_SIBLING_AXIS
           
static byte QNAME_KT
           
static byte SELF_AXIS
           
static byte TEXT_KT
           
 
Constructor Summary
protected XdpAnt()
          For internal use only
  XdpAnt(java.lang.String axisStr, java.lang.String kindTestStr, java.lang.String nameTest)
          Creates a new instance of XdpAnt, composed with arequired axis, a required kind test and, if kind test is QNAME, a name test which can be one of : "localname" "*" "*:localname" "*:*" "prefix:* "prefix:localname Possible values for axisStr are : child descendant attribute self descendant-or-self following-sibling following namespace parent ancestor preceding-sibling preceding ancestor-or-self Possible values for kindTestStr are : node() attribute() text() element() QNAME
 
Method Summary
 java.lang.Object clone()
           
 byte getAxis()
           
 byte getKindTest()
           
 java.lang.String getNameTestLocalPart()
           
 java.lang.String getNameTestPrefix()
           
 boolean isForwardAxis()
           
 boolean isReverseAxis()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CHILD_AXIS

public static final byte CHILD_AXIS
See Also:
Constant Field Values

DESCENDANT_AXIS

public static final byte DESCENDANT_AXIS
See Also:
Constant Field Values

ATTRIBUTE_AXIS

public static final byte ATTRIBUTE_AXIS
See Also:
Constant Field Values

SELF_AXIS

public static final byte SELF_AXIS
See Also:
Constant Field Values

DESCENDANT_OR_SELF_AXIS

public static final byte DESCENDANT_OR_SELF_AXIS
See Also:
Constant Field Values

FOLLOWING_SIBLING_AXIS

public static final byte FOLLOWING_SIBLING_AXIS
See Also:
Constant Field Values

FOLLOWING_AXIS

public static final byte FOLLOWING_AXIS
See Also:
Constant Field Values

NAMESPACE_AXIS

public static final byte NAMESPACE_AXIS
See Also:
Constant Field Values

PARENT_AXIS

public static final byte PARENT_AXIS
See Also:
Constant Field Values

ANCESTOR_AXIS

public static final byte ANCESTOR_AXIS
See Also:
Constant Field Values

PRECEDING_SIBLING_AXIS

public static final byte PRECEDING_SIBLING_AXIS
See Also:
Constant Field Values

PRECEDING_AXIS

public static final byte PRECEDING_AXIS
See Also:
Constant Field Values

ANCESTOR_OR_SELF_AXIS

public static final byte ANCESTOR_OR_SELF_AXIS
See Also:
Constant Field Values

NODE_KT

public static final byte NODE_KT
See Also:
Constant Field Values

ATTRIBUTE_KT

public static final byte ATTRIBUTE_KT
See Also:
Constant Field Values

TEXT_KT

public static final byte TEXT_KT
See Also:
Constant Field Values

ELEMENT_KT

public static final byte ELEMENT_KT
See Also:
Constant Field Values

QNAME_KT

public static final byte QNAME_KT
See Also:
Constant Field Values
Constructor Detail

XdpAnt

public XdpAnt(java.lang.String axisStr,
              java.lang.String kindTestStr,
              java.lang.String nameTest)
       throws java.lang.IllegalArgumentException
Creates a new instance of XdpAnt, composed with arequired axis, a required kind test and, if kind test is QNAME, a name test which can be one of : Possible values for axisStr are : Possible values for kindTestStr are :

Parameters:
axisStr - required XPath step axis name (child, descendant, parent, ancestor, ...)
kindTestStr - required kind test
nameTest -
Throws:
java.lang.IllegalArgumentException

XdpAnt

protected XdpAnt()
For internal use only

Method Detail

getNameTestPrefix

public java.lang.String getNameTestPrefix()
Returns:
name test prefix or null if not exists

getNameTestLocalPart

public java.lang.String getNameTestLocalPart()
Returns:
name test local name or null if not exists

isForwardAxis

public boolean isForwardAxis()
Returns:
true if current axis is a forward axis

isReverseAxis

public boolean isReverseAxis()
Returns:
true if current axis is a reverse axis

getAxis

public byte getAxis()
Returns:
current axis as XdpAnt axis constant

getKindTest

public byte getKindTest()
Returns:
current kind test as XdpAnt kind test constant

clone

public java.lang.Object clone()