Class NameTest

java.lang.Object

com.icl.saxon.pattern.Pattern

com.icl.saxon.pattern.NodeTest

com.icl.saxon.pattern.NameTest

public class NameTest
extends NodeTest

NodeTest is an interface that enables a test of whether a node has a particular name and type. A NameTest matches the node type and the namespace URI and the local name.

Author:

Michael H. Kay

Field Summary

Fields inherited from class Pattern

originalText, staticContext

Constructor Summary

Constructors

Constructor	Description
NameTest(short nodeType, int nameCode)
NameTest(NodeInfo node)	Create a NameTest for nodes of the same type and name as a given node

Method Summary

Modifier and Type	Method	Description
final double	getDefaultPriority()	Determine the default priority of this node test when used on its own as a Pattern
int	getFingerprint()	Get the fingerprint required
short	getNodeType()	Determine the types of nodes to which this pattern applies.
boolean	matches(short nodeType, int nameCode)	Test whether this node test is satisfied by a given node
final boolean	matches(NodeInfo node)	Test whether this node test is satisfied by a given node

Methods inherited from class NodeTest

matches

Methods inherited from class Pattern

getLineNumber, getStaticContext, getSystemId, make, setOriginalText, setStaticContext, simplify, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

NameTest

public NameTest(short nodeType,
 int nameCode)

NameTest

public NameTest(NodeInfo node)

Create a NameTest for nodes of the same type and name as a given node

Method Details

matches

public final boolean matches(NodeInfo node)

Test whether this node test is satisfied by a given node

Specified by:

matches in class NodeTest

matches

public boolean matches(short nodeType,
 int nameCode)

Test whether this node test is satisfied by a given node

Specified by:

matches in class NodeTest

Parameters:

nodeType - The type of node to be matched

nameCode - identifies the expanded name of the node to be matched. The value should be -1 for a node with no name.

fingerprint - identifies the expanded name of the node to be matched

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

getFingerprint

public int getFingerprint()

Get the fingerprint required

Overrides:

getFingerprint in class Pattern

Returns:

A fingerprint that the nodes must match, or null Otherwise return null.

getNodeType

public short getNodeType()

Determine the types of nodes to which this pattern applies. Used for optimisation. For patterns that match nodes of several types, return NodeInfo.NODE

Overrides:

getNodeType in class Pattern

Returns:

the type of node matched by this pattern. e.g. NodeInfo.ELEMENT or NodeInfo.TEXT