|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.icl.saxon.axis.Axis
An axis, that is a direction of navigation in the document structure.
Field Summary | |
static int |
ANCESTOR
|
static int |
ANCESTOR_OR_SELF
|
static int |
ATTRIBUTE
|
protected int |
axisNumber
|
static int |
CHILD
|
static int |
DESCENDANT
|
static int |
DESCENDANT_OR_SELF
|
static int |
FOLLOWING
|
static int |
FOLLOWING_SIBLING
|
static int |
NAMESPACE
|
protected NameTest |
nodeName
|
protected int |
nodeType
|
static int |
PARENT
|
static int |
PRECEDING
|
static int |
PRECEDING_SIBLING
|
static int |
SELF
|
Constructor Summary | |
Axis()
|
Method Summary | |
int |
getAxisNumber()
Get the axis number (e.g. |
abstract NodeEnumeration |
getEnumeration(NodeInfo node)
Return an enumeration over the nodes reached by the given axis from a specified node |
int |
getPrincipalNodeType()
Get the principal node type for the axis. |
abstract boolean |
isPeer()
An axis has the peer property if no node in the result is an ancestor of another (redundant: if this is true the sibling property will also be true) |
boolean |
isReverseSorted()
If an axis is not in document order, then it is in reverse document order |
abstract boolean |
isSibling()
An Axis has the sibling property if all the nodes it returns have the same parent |
abstract boolean |
isSorted()
An Axis has the sorted property if it returns nodes in document order |
abstract boolean |
isWithinSubtree()
An axis has the withinSubtree property if all the nodes it returns are in the subtree rooted at the start node, that is if it is a subset of the descendants-of-self axis |
static int |
lookup(java.lang.String name)
resolve an axis name into a symbolic constant representing the axis |
static Axis |
make(int axisNumber,
int nodeType,
NameTest nameTest)
Factory method to make an axis of the specified type. |
static Axis |
makeAxis(int axisNumber)
|
void |
setNameTest(NameTest test)
Set the name test required by the axis. |
void |
setNodeType(int type)
Set the node type required by the axis. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int ANCESTOR
public static final int ANCESTOR_OR_SELF
public static final int ATTRIBUTE
public static final int CHILD
public static final int DESCENDANT
public static final int DESCENDANT_OR_SELF
public static final int FOLLOWING
public static final int FOLLOWING_SIBLING
public static final int NAMESPACE
public static final int PARENT
public static final int PRECEDING
public static final int PRECEDING_SIBLING
public static final int SELF
protected int axisNumber
protected int nodeType
protected NameTest nodeName
Constructor Detail |
public Axis()
Method Detail |
public static int lookup(java.lang.String name) throws org.xml.sax.SAXException
public static Axis make(int axisNumber, int nodeType, NameTest nameTest) throws org.xml.sax.SAXException
public static Axis makeAxis(int axisNumber) throws org.xml.sax.SAXException
public int getAxisNumber()
public void setNodeType(int type)
nodeType
- e.g. NodeInfo.ELEMENT for an element, NodeInfo.NODE for any node typepublic int getPrincipalNodeType()
public void setNameTest(NameTest test)
nodeType
- e.g. NodeInfo.ELEMENT for an element, NodeInfo.NODE for any node typepublic abstract NodeEnumeration getEnumeration(NodeInfo node) throws org.xml.sax.SAXException
node
- NodeInfo representing the node from which the enumeration startsnodeType
- the type(s) of node to be included, e.g. NodeInfo.ELEMENT, NodeInfo.TEXT.
The value NodeInfo.NODE means include any type of node.nodeNameTest
- include only nodes with this name (e.g. an element name). Set this to null
to include nodes of any name.org.xml.sax.SAXException
- if an invalid axis is specifiedpublic abstract boolean isSorted()
public boolean isReverseSorted()
public abstract boolean isSibling()
public abstract boolean isPeer()
public abstract boolean isWithinSubtree()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |