net.sf.saxon.pattern
Class NameTest

java.lang.Object
  |
  +--net.sf.saxon.pattern.NodeTest
        |
        +--net.sf.saxon.pattern.NameTest
All Implemented Interfaces:
ItemType, java.io.Serializable

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 kind and the namespace URI and the local name.

See Also:
Serialized Form

Constructor Summary
NameTest(int nodeType, int nameCode, NamePool namePool)
           
NameTest(NodeInfo node)
          Create a NameTest for nodes of the same type and name as a given node
 
Method Summary
 boolean allowsTextNodes()
          Indicate whether this NodeTest is capable of matching text nodes
 double getDefaultPriority()
          Determine the default priority of this node test when used on its own as a Pattern
 int getFingerprint()
          Get the fingerprint required
 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.
 java.util.Set getRequiredNodeNames()
          Get the set of node names allowed by this NodeTest.
 int hashCode()
          Returns a hash code value for the object.
 boolean matches(int nodeKind, int nameCode, int annotation)
          Test whether this node test is satisfied by a given node
 boolean matches(NodeInfo node)
          Test whether this node test is satisfied by a given node.
 java.lang.String toString()
           
 java.lang.String toString(NamePool pool)
          Display the type descriptor for diagnostics
 
Methods inherited from class net.sf.saxon.pattern.NodeTest
getAtomizedItemType, getContentType, getPrimitiveItemType, getSuperType, matchesItem
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NameTest

public NameTest(int nodeType,
                int nameCode,
                NamePool namePool)

NameTest

public NameTest(NodeInfo node)
Create a NameTest for nodes of the same type and name as a given node

Method Detail

matches

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

Specified by:
matches in class NodeTest
Parameters:
nodeKind - The type of node to be matched
nameCode - identifies the expanded name of the node to be matched
annotation - The actual content type of the node

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.

Specified by:
matches in class NodeTest
Parameters:
node - 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

Specified by:
getDefaultPriority in class NodeTest

getFingerprint

public int getFingerprint()
Get the fingerprint required

Overrides:
getFingerprint in class NodeTest

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

Specified by:
getPrimitiveType in interface ItemType
Overrides:
getPrimitiveType in class NodeTest
Returns:
the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT

allowsTextNodes

public boolean allowsTextNodes()
Indicate whether this NodeTest is capable of matching text nodes

Specified by:
allowsTextNodes in class NodeTest

getNodeKindMask

public int getNodeKindMask()
Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1<
Specified by:
getNodeKindMask in class NodeTest

getRequiredNodeNames

public java.util.Set getRequiredNodeNames()
Get the set of node names allowed by this NodeTest. This is returned as a set of Integer fingerprints. A null value indicates that all names are permitted (i.e. that there are no constraints on the node name. The default implementation returns null.

Overrides:
getRequiredNodeNames in class NodeTest

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toString

public java.lang.String toString(NamePool pool)
Description copied from class: NodeTest
Display the type descriptor for diagnostics

Specified by:
toString in interface ItemType
Overrides:
toString in class NodeTest

hashCode

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

Overrides:
hashCode in class java.lang.Object