net.sf.saxon.pattern

Class NodeTestPattern

Implemented Interfaces:
Container, PatternFinder, Serializable, SourceLocator

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

double
getDefaultPriority()
Determine the default priority of this node test when used on its own as a Pattern
int
getFingerprint()
Determine the name fingerprint of nodes to which this pattern applies.
int
getNodeKind()
Determine the types of nodes to which this pattern applies.
NodeTest
getNodeTest()
Get a NodeTest that all the nodes matching this pattern must satisfy
boolean
matches(NodeInfo node, XPathContext context)
Determine whether this Pattern matches the given Node.
void
setNodeTest(NodeTest test)
String
toString()
Display the pattern for diagnostics

Methods inherited from class net.sf.saxon.pattern.Pattern

allocateSlots, analyze, getColumnNumber, getDefaultPriority, getDependencies, getExecutable, getFingerprint, getHostLanguage, getLineNumber, getLocationProvider, getNodeKind, getNodeTest, getPublicId, getSystemId, internalMatches, iterateSubExpressions, make, makeSearchExpression, matches, promote, replaceSubExpression, selectNodes, setExecutable, setLineNumber, setOriginalText, setSystemId, simplify, toString

Constructor Details

NodeTestPattern

public NodeTestPattern()

NodeTestPattern

public NodeTestPattern(NodeTest test)

Method Details

getDefaultPriority

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

getFingerprint

public int getFingerprint()
Determine the name fingerprint of nodes to which this pattern applies. Used for optimisation.
Overrides:
getFingerprint in interface Pattern
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
Overrides:
getNodeKind in interface Pattern
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
Overrides:
getNodeTest in interface Pattern

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
Overrides:
matches in interface Pattern
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
Overrides:
toString in interface Pattern