net.sf.saxon.pattern

Class NodeTestPattern

public class NodeTestPattern extends Pattern

A NodeTestPattern is a pattern that consists simply of a NodeTest.

Author: Michael H. Kay

Constructor Summary
NodeTestPattern()
NodeTestPattern(NodeTest test)
Method Summary
booleanequals(Object other)
Determine whether this pattern is the same as another pattern
doublegetDefaultPriority()
Determine the default priority of this node test when used on its own as a Pattern
intgetFingerprint()
Determine the name fingerprint of nodes to which this pattern applies.
intgetNodeKind()
Determine the types of nodes to which this pattern applies.
NodeTestgetNodeTest()
Get a NodeTest that all the nodes matching this pattern must satisfy
inthashCode()
Hashcode supporting equals()
booleanmatches(NodeInfo node, XPathContext context)
Determine whether this Pattern matches the given Node.
voidsetNodeTest(NodeTest test)
StringtoString()
Display the pattern for diagnostics

Constructor Detail

NodeTestPattern

public NodeTestPattern()

NodeTestPattern

public NodeTestPattern(NodeTest test)

Method Detail

equals

public boolean equals(Object other)
Determine whether this pattern is the same as another pattern

Parameters: other the other object

getDefaultPriority

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

getFingerprint

public int getFingerprint()
Determine the name fingerprint of nodes to which this pattern applies. Used for optimisation.

Returns: A fingerprint that the nodes must match, or -1 if it can match multiple fingerprints

getNodeKind

public int getNodeKind()
Determine the types of nodes to which this pattern applies. Used for optimisation. For patterns that match nodes of several types, return Type.NODE

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

getNodeTest

public NodeTest getNodeTest()
Get a NodeTest that all the nodes matching this pattern must satisfy

hashCode

public int hashCode()
Hashcode supporting equals()

matches

public boolean matches(NodeInfo node, XPathContext context)
Determine whether this Pattern matches the given Node. This is the main external interface for matching patterns: it sets current() to the node being tested

Parameters: node The NodeInfo representing the Element or other node to be tested against the Pattern context 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(). Not used (and can be set to null) in the case of patterns that are NodeTests

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

setNodeTest

public void setNodeTest(NodeTest test)

toString

public String toString()
Display the pattern for diagnostics