com.novell.xml.xpath
Class AxisAttribute

java.lang.Object
  extended bycom.novell.xml.xpath.Axis
      extended bycom.novell.xml.xpath.AxisAttribute
All Implemented Interfaces:
ContextNodeList

public class AxisAttribute
extends Axis

class representing XPath "attribute" axis


Nested Class Summary
protected  class AxisAttribute.Mark
           
 
Nested classes inherited from class com.novell.xml.xpath.Axis
Axis.AxisMark
 
Field Summary
 
Fields inherited from class com.novell.xml.xpath.Axis
stripper
 
Fields inherited from interface com.novell.xml.xpath.ContextNodeList
DOCUMENT_ORDER, REVERSE_DOCUMENT_ORDER, UNKNOWN_ORDER
 
Constructor Summary
AxisAttribute()
           
 
Method Summary
 void done()
          stop referencing resources that are no longer needed
 Node first()
          Return the first member of the axis in axis-defined order.
 ContextListMark getMark()
          Return a marker to current position in this axis This marker can be used later in a call to returnToMark() to return to the marked position
 Node next()
          Return subsequent nodes in the axis.
 int principalNodeType()
          Return the principal node type for the axis.
 Node returnToMark(ContextListMark mark)
          Go to a position in a ContextNodeList previously marked with getMark()
 String toString()
          Provide a readable description of the axis for debugging.
 
Methods inherited from class com.novell.xml.xpath.Axis
count, getContextNode, incPosition, init, order, position, setup, stripNode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AxisAttribute

public AxisAttribute()
Method Detail

toString

public String toString()
Provide a readable description of the axis for debugging.

Specified by:
toString in class Axis
Returns:
String representation of the axis (the axis name)

first

public Node first()
Return the first member of the axis in axis-defined order. setup() must be called first

Returns:
The first node in the axis, or null if the axis is empty.

done

public void done()
stop referencing resources that are no longer needed

Overrides:
done in class Axis

next

public Node next()
Return subsequent nodes in the axis. first() must be called before next() to setup the context. The nodes are returned in axis dependent order.

Returns:
The next node in the axis, or null if there are no more nodes in the axis.

principalNodeType

public int principalNodeType()
Return the principal node type for the axis. For the attribute axis, this is org.w3c.dom.Node.ATTRIBUTE_NODE

Specified by:
principalNodeType in class Axis
Returns:
node type for axis

getMark

public ContextListMark getMark()
Return a marker to current position in this axis This marker can be used later in a call to returnToMark() to return to the marked position

Returns:
an opaque marker

returnToMark

public Node returnToMark(ContextListMark mark)
Go to a position in a ContextNodeList previously marked with getMark()

Parameters:
mark - mark returned from getMark()
Returns:
The node at the mark