|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xpath.Expression | +--org.apache.xpath.patterns.NodeTest | +--org.apache.xpath.axes.AxesWalker
Serves as common interface for axes Walkers, and stores common state variables.
Fields inherited from class org.apache.xpath.patterns.NodeTest |
SCORE_NONE,
SHOW_BYFUNCTION,
SHOW_NAMESPACE,
WILD |
Constructor Summary | |
AxesWalker(LocPathIterator locPathIterator)
Construct an AxesWalker using a LocPathIterator. |
Method Summary | |
short |
acceptNode(Node n)
Test whether a specified node is visible in the logical view of a TreeWalker or NodeIterator. |
java.lang.Object |
clone()
Get a cloned AxesWalker. |
Node |
firstChild()
Moves the TreeWalker to the first visible child of the
current node, and returns the new node. |
Node |
getCurrentNode()
The node at which the TreeWalker is currently positioned. |
boolean |
getExpandEntityReferences()
The value of this flag determines whether the children of entity reference nodes are visible to the TreeWalker. |
NodeFilter |
getFilter()
The filter used to screen nodes. |
int |
getLastPos(XPathContext xctxt)
|
LocPathIterator |
getLocPathIterator()
|
AxesWalker |
getNextWalker()
|
int |
getPredicateCount()
Get the number of predicates that this walker has. |
int |
getPredicateIndex()
Get which predicate is executing. |
AxesWalker |
getPrevWalker()
|
int |
getProximityPosition()
Get the current sub-context position. |
int |
getProximityPosition(XPathContext xctxt)
Get the current sub-context position. |
Node |
getRoot()
The root node of the TreeWalker, as specified in setRoot(Node root). |
void |
init(Compiler compiler,
int opPos,
int stepType)
Init an AxesWalker. |
void |
initProximityPosition(int i)
Init the proximity position to zero for a forward axes. |
boolean |
isReverseAxes()
Tells if this is a reverse axes. |
Node |
lastChild()
Moves the TreeWalker to the last visible child of the
current node, and returns the new node. |
Node |
nextNode()
Moves the TreeWalker to the next visible node in document
order relative to the current node, and returns the new node. |
Node |
nextSibling()
Moves the TreeWalker to the next sibling of the current
node, and returns the new node. |
Node |
parentNode()
Moves to and returns the closest visible ancestor node of the current node. |
Node |
previousNode()
Moves the TreeWalker to the previous visible node in
document order relative to the current node, and returns the new node. |
Node |
previousSibling()
Moves the TreeWalker to the previous sibling of the
current node, and returns the new node. |
void |
reset()
Reset the Walker. |
void |
resetProximityPositions()
Reset the proximity positions counts. |
void |
setCurrentNode(Node currentNode)
Set the current node. |
void |
setLocPathIterator(LocPathIterator li)
|
void |
setNextWalker(AxesWalker walker)
|
void |
setPredicateCount(int count)
Set the number of predicates that this walker has. |
void |
setPrevWalker(AxesWalker walker)
|
void |
setRoot(Node root)
Set the root node of the TreeWalker. |
java.lang.String |
toString()
Diagnostics. |
Methods inherited from class org.apache.xpath.patterns.NodeTest |
debugWhatToShow,
execute,
getDefaultScore,
getLocalName,
getNamespace,
getWhatToShow,
initNodeTest,
initNodeTest |
Methods inherited from class org.apache.xpath.Expression |
assert,
error,
warn |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public AxesWalker(LocPathIterator locPathIterator)
Method Detail |
public LocPathIterator getLocPathIterator()
public void setLocPathIterator(LocPathIterator li)
public void init(Compiler compiler, int opPos, int stepType) throws SAXException
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
public void reset()
public int getProximityPosition()
public int getProximityPosition(XPathContext xctxt)
public void resetProximityPositions() throws SAXException
public void initProximityPosition(int i) throws SAXException
public boolean isReverseAxes()
public int getPredicateIndex()
public int getPredicateCount()
public void setPredicateCount(int count)
public Node getRoot()
public void setRoot(Node root)
public final Node getCurrentNode()
currentNode
isnull
.public void setCurrentNode(Node currentNode) throws DOMException
public NodeFilter getFilter()
public boolean getExpandEntityReferences()
public Node parentNode()
public Node firstChild()
TreeWalker
to the first visible child of the
current node, and returns the new node. If the current node has no
visible children, returns null
, and retains the current
node.null
if the current node has no
visible children in the TreeWalker's logical view.public Node nextSibling()
TreeWalker
to the next sibling of the current
node, and returns the new node. If the current node has no visible
next sibling, returns null
, and retains the current node.null
if the current node has no
next sibling in the TreeWalker's logical view.public Node lastChild()
TreeWalker
to the last visible child of the
current node, and returns the new node. If the current node has no
visible children, returns null
, and retains the current
node.null
if the current node has no
children in the TreeWalker's logical view.public Node previousSibling()
TreeWalker
to the previous sibling of the
current node, and returns the new node. If the current node has no
visible previous sibling, returns null
, and retains the
current node.null
if the current node has no
previous sibling in the TreeWalker's logical view.public Node previousNode()
TreeWalker
to the previous visible node in
document order relative to the current node, and returns the new node.
If the current node has no previous node, or if the search for
previousNode attempts to step upward from the TreeWalker's root node,
returns null
, and retains the current node.null
if the current node has no
previous node in the TreeWalker's logical view.public void setNextWalker(AxesWalker walker)
public AxesWalker getNextWalker()
public void setPrevWalker(AxesWalker walker)
public AxesWalker getPrevWalker()
public java.lang.String toString()
public Node nextNode()
TreeWalker
to the next visible node in document
order relative to the current node, and returns the new node. If the
current node has no next node, or if the search for nextNode attempts
to step upward from the TreeWalker's root node, returns
null
, and retains the current node.null
if the current node has no
next node in the TreeWalker's logical view.public int getLastPos(XPathContext xctxt)
public short acceptNode(Node n)
n
- The node to check to see if it passes the filter or not.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |