net.sf.saxon.pattern

Class LocalNameTest

public final class LocalNameTest extends NodeTest implements QNameTest

NodeTest is an interface that enables a test of whether a node has a particular name and type. A LocalNameTest matches the node type and the local name, it represents an XPath 2.0 test of the form *:name.

Author: Michael H. Kay

Constructor Summary
LocalNameTest(NamePool pool, int nodeKind, String localName)
Method Summary
booleanequals(Object other)
Indicates whether some other object is "equal to" this one.
doublegetDefaultPriority()
Determine the default priority of this node test when used on its own as a Pattern
StringgetLocalName()
Get the local name used in this LocalNameTest
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 nodeType, 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)
Test whether this node test is satisfied by a given node.
booleanmatches(StructuredQName qname)
Test whether this QNameTest matches a given QName
StringtoString()

Constructor Detail

LocalNameTest

public LocalNameTest(NamePool pool, int nodeKind, String localName)

Method Detail

equals

public boolean equals(Object other)
Indicates whether some other object is "equal to" this one.

getDefaultPriority

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

getLocalName

public String getLocalName()
Get the local name used in this LocalNameTest

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. 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

hashCode

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

matches

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

Parameters: nodeType 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)
Test whether this node test is satisfied by a given node. This alternative method is used in the case of nodes where calculating the fingerprint is expensive, for example DOM or JDOM nodes.

Parameters: node the node to be matched

matches

public boolean matches(StructuredQName qname)
Test whether this QNameTest matches a given QName

Parameters: qname the QName to be matched

Returns: true if the name matches, false if not

toString

public String toString()