net.sf.saxon.pattern
Class DocumentNodeTest

java.lang.Object
  |
  +--net.sf.saxon.pattern.Pattern
        |
        +--net.sf.saxon.pattern.NodeTest
              |
              +--net.sf.saxon.pattern.DocumentNodeTest
All Implemented Interfaces:
ItemType, java.io.Serializable

public class DocumentNodeTest
extends NodeTest

A DocumentNodeTest implements the test document-node(element(~,~))

See Also:
Serialized Form

Field Summary
 
Fields inherited from class net.sf.saxon.pattern.Pattern
originalText
 
Constructor Summary
DocumentNodeTest(NodeTest elementTest)
           
 
Method Summary
 boolean allowsTextNodes()
          Indicate whether this NodeTest is capable of matching text nodes
 double getDefaultPriority()
          Determine the default priority of this node test when used on its own as a Pattern
 int getNodeKind()
          Determine the types of nodes to which this pattern applies.
 boolean matches(int nodeKind, int fingerprint, int annotation)
          Test whether this node test is satisfied by a given node
 boolean matches(NodeInfo node, Controller controller)
          Determine whether this Pattern matches the given Node.
 boolean matchesItem(Item item)
          Test whether a given item conforms to this type
 java.lang.String toString()
          Produce a representation of this type name for use in error messages.
 
Methods inherited from class net.sf.saxon.pattern.NodeTest
getNodeTest, getPrimitiveType, getSuperType, isSameType
 
Methods inherited from class net.sf.saxon.pattern.Pattern
getFingerprint, getLineNumber, getSystemId, internalMatches, make, setLineNumber, setOriginalText, setSystemId, simplify, typeCheck
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DocumentNodeTest

public DocumentNodeTest(NodeTest elementTest)
Method Detail

matchesItem

public boolean matchesItem(Item item)
Test whether a given item conforms to this type

Specified by:
matchesItem in interface ItemType
Overrides:
matchesItem in class NodeTest
Parameters:
item - The item to be tested
Returns:
true if the item is an instance of this type; false otherwise

matches

public boolean matches(int nodeKind,
                       int fingerprint,
                       int annotation)
Test whether this node test is satisfied by a given node

Specified by:
matches in class NodeTest
Parameters:
nodeKind - The type of node to be matched
fingerprint - identifies the expanded name of the node to be matched
annotation - The actual content type of the node

matches

public boolean matches(NodeInfo node,
                       Controller controller)
Determine whether this Pattern matches the given Node.

Overrides:
matches in class NodeTest
Parameters:
node - The NodeInfo representing the Element or other node to be tested against the Pattern
controller - The context in which the match is to take place. Only relevant if the pattern uses variables, or contains calls on functions such as document() or key().
Returns:
true if the node matches the Pattern, false otherwise

getDefaultPriority

public final double getDefaultPriority()
Determine the default priority of this node test when used on its own as a Pattern

Overrides:
getDefaultPriority in class Pattern

getNodeKind

public int getNodeKind()
Determine the types of nodes to which this pattern applies. Used for optimisation.

Overrides:
getNodeKind in class Pattern
Returns:
the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT

allowsTextNodes

public boolean allowsTextNodes()
Indicate whether this NodeTest is capable of matching text nodes

Specified by:
allowsTextNodes in class NodeTest

toString

public java.lang.String toString()
Description copied from interface: ItemType
Produce a representation of this type name for use in error messages. Where this is a QName, it will use conventional prefixes

Specified by:
toString in interface ItemType
Overrides:
toString in class Pattern