com.caucho.xpath.pattern
Class FromRoot

java.lang.Object
  extended by com.caucho.xpath.pattern.AbstractPattern
      extended by com.caucho.xpath.pattern.FromRoot

public class FromRoot
extends AbstractPattern

Represents a match with the document root.


Field Summary
 
Fields inherited from class com.caucho.xpath.pattern.AbstractPattern
_child, _parent, log, XMLNS
 
Constructor Summary
FromRoot()
           
 
Method Summary
 AbstractPattern copyAxis()
          Returns the node itself for the axis.
 AbstractPattern copyPosition()
          Returns null since the axis isn't part of the position pattern.
 int count(org.w3c.dom.Node node, Env env, AbstractPattern pattern)
          Counts the nodes within the axis matching the pattern.
 NodeIterator createNodeIterator(org.w3c.dom.Node node, ExprEnvironment env, AbstractPattern match)
          Creates a new node iterator.
 boolean equals(java.lang.Object b)
          Returns true if the two patterns are equal.
 org.w3c.dom.Node firstNode(org.w3c.dom.Node node, ExprEnvironment env)
          Returns the first node in the selection order.
 boolean isStrictlyAscending()
          The root is strictly ascending.
 boolean isUnique()
          Returns true if the pattern's selector returns unique nodes.
 boolean match(org.w3c.dom.Node node, ExprEnvironment env)
          Matches the owner document.
 org.w3c.dom.Node nextNode(org.w3c.dom.Node node, org.w3c.dom.Node lastNode)
          Returns the next node in the selection order.
 int position(org.w3c.dom.Node node, Env env, AbstractPattern pattern)
          Calculates the position of the node in its context.
 java.lang.String toString()
           
 
Methods inherited from class com.caucho.xpath.pattern.AbstractPattern
findAny, getNodeName, getParent, getPrefix, getPriority, isAscending, lastNode, select, selectUnique, toPatternString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FromRoot

public FromRoot()
Method Detail

match

public boolean match(org.w3c.dom.Node node,
                     ExprEnvironment env)
Matches the owner document.

Specified by:
match in class AbstractPattern
Parameters:
node - the current node
env - the variable environment
Returns:
true if the node is the owner document.

firstNode

public org.w3c.dom.Node firstNode(org.w3c.dom.Node node,
                                  ExprEnvironment env)
Returns the first node in the selection order.

Overrides:
firstNode in class AbstractPattern
Parameters:
node - the current node
Returns:
the first node

nextNode

public org.w3c.dom.Node nextNode(org.w3c.dom.Node node,
                                 org.w3c.dom.Node lastNode)
Returns the next node in the selection order.

Overrides:
nextNode in class AbstractPattern
Parameters:
node - the current node
lastNode - the last node
Returns:
the next node

isStrictlyAscending

public boolean isStrictlyAscending()
The root is strictly ascending.


equals

public boolean equals(java.lang.Object b)
Returns true if the two patterns are equal.

Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

position

public int position(org.w3c.dom.Node node,
                    Env env,
                    AbstractPattern pattern)
             throws XPathException
Calculates the position of the node in its context.

Overrides:
position in class AbstractPattern
Parameters:
node - the current node
env - the variable environment
pattern - the position pattern
Returns:
the node's position.
Throws:
XPathException

count

public int count(org.w3c.dom.Node node,
                 Env env,
                 AbstractPattern pattern)
          throws XPathException
Counts the nodes within the axis matching the pattern.

Overrides:
count in class AbstractPattern
Parameters:
node - the current node
env - the variable environment
pattern - the position pattern
Returns:
the count of the node list.
Throws:
XPathException

createNodeIterator

public NodeIterator createNodeIterator(org.w3c.dom.Node node,
                                       ExprEnvironment env,
                                       AbstractPattern match)
                                throws XPathException
Creates a new node iterator.

Overrides:
createNodeIterator in class AbstractPattern
Parameters:
node - the starting node
env - the variable environment
match - the axis match pattern
Returns:
the node iterator
Throws:
XPathException

copyAxis

public AbstractPattern copyAxis()
Returns the node itself for the axis.

Overrides:
copyAxis in class AbstractPattern

copyPosition

public AbstractPattern copyPosition()
Returns null since the axis isn't part of the position pattern.

Overrides:
copyPosition in class AbstractPattern

isUnique

public boolean isUnique()
Returns true if the pattern's selector returns unique nodes.

Overrides:
isUnique in class AbstractPattern