net.sf.saxon.pattern

Class DocumentNodeTest

public class DocumentNodeTest extends NodeTest

A DocumentNodeTest implements the test document-node(element(~,~))
Constructor Summary
DocumentNodeTest(NodeTest elementTest)
Method Summary
booleanequals(Object other)
doublegetDefaultPriority()
Determine the default priority of this node test when used on its own as a Pattern
NodeTestgetElementTest()
Get the element test contained within this document test
intgetNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match.
intgetPrimitiveType()
Determine the types of nodes to which this pattern applies.
inthashCode()
Returns a hash code value for the object.
booleanmatches(int nodeKind, int fingerprint, int annotation)
Test whether this node test is satisfied by a given node
booleanmatches(TinyTree tree, int nodeNr)
Test whether this node test is satisfied by a given node on a TinyTree.
booleanmatches(NodeInfo node)
Determine whether this Pattern matches the given Node.
StringtoString(NamePool pool)
StringtoString()

Constructor Detail

DocumentNodeTest

public DocumentNodeTest(NodeTest elementTest)

Method Detail

equals

public boolean equals(Object other)

getDefaultPriority

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

getElementTest

public NodeTest getElementTest()
Get the element test contained within this document test

Returns: the contained element test

getNodeKindMask

public int getNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1<

getPrimitiveType

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

Returns: the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT

hashCode

public int hashCode()
Returns a hash code value for the object.

matches

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

Parameters: nodeKind The type of node to be matched fingerprint identifies the expanded name of the node to be matched

matches

public boolean matches(TinyTree tree, int nodeNr)
Test whether this node test is satisfied by a given node on a TinyTree. The node must be a document, element, text, comment, or processing instruction node. This method is provided so that when navigating a TinyTree a node can be rejected without actually instantiating a NodeInfo object.

Parameters: tree the TinyTree containing the node nodeNr the number of the node within the TinyTree

Returns: true if the node matches the NodeTest, otherwise false

matches

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

Parameters: node The NodeInfo representing the Element or other node to be tested against the Pattern uses variables, or contains calls on functions such as document() or key().

Returns: true if the node matches the Pattern, false otherwise

toString

public String toString(NamePool pool)

toString

public String toString()