net.sf.saxon.pattern
Class DocumentNodeTest
- ItemType, Serializable
public class DocumentNodeTest
A DocumentNodeTest implements the test document-node(element(~,~))
boolean | equals(Object other)
|
double | getDefaultPriority() - Determine the default priority of this node test when used on its own as a Pattern
|
NodeTest | getElementTest() - Get the element test contained within this document test
|
int | getNodeKindMask() - Get a mask indicating which kinds of nodes this NodeTest can match.
|
int | getPrimitiveType() - Determine the types of nodes to which this pattern applies.
|
int | hashCode() - Returns a hash code value for the object.
|
boolean | matches(int nodeKind, int fingerprint, int annotation) - Test whether this node test is satisfied by a given node
|
boolean | matches(NodeInfo node) - Determine whether this Pattern matches the given Node.
|
boolean | matches(TinyTree tree, int nodeNr) - Test whether this node test is satisfied by a given node on a TinyTree.
|
String | toString()
|
String | toString(NamePool pool) - Display the type descriptor for diagnostics
|
getAtomizedItemType , getContentType , getDefaultPriority , getFingerprint , getNodeKindMask , getPrimitiveItemType , getPrimitiveType , getRequiredNodeNames , getSuperType , isAtomicType , isNillable , matches , matches , matches , matchesItem , toString |
DocumentNodeTest
public DocumentNodeTest(NodeTest elementTest)
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
- getDefaultPriority in interface NodeTest
getElementTest
public NodeTest getElementTest()
Get the element test contained within this document test
- 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<<Type.ELEMENT for element nodes, 1<<Type.TEXT for text nodes, and so on.
- getNodeKindMask in interface NodeTest
getPrimitiveType
public int getPrimitiveType()
Determine the types of nodes to which this pattern applies. Used for optimisation.
- getPrimitiveType in interface ItemType
- getPrimitiveType in interface NodeTest
- 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
- matches in interface NodeTest
nodeKind
- The type of node to be matchedfingerprint
- identifies the expanded name of the node to be matched
matches
public boolean matches(NodeInfo node)
Determine whether this Pattern matches the given Node.
- matches in interface NodeTest
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().
- true if the node matches the Pattern, false otherwise
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.
- matches in interface NodeTest
tree
- the TinyTree containing the nodenodeNr
- the number of the node within the TinyTree
- true if the node matches the NodeTest, otherwise false
toString
public String toString()