Package net.sf.saxon.pattern
Class NameTest
java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.NameTest
- All Implemented Interfaces:
Serializable
,ItemType
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.
- Author:
- Michael H. Kay
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determines whether two NameTests are equalfinal double
Determine the default priority of this node test when used on its own as a Patternint
Get the fingerprint requiredint
Get a mask indicating which kinds of nodes this NodeTest can match.int
Determine the types of nodes to which this pattern applies.Get the set of node names allowed by this NodeTest.Get the type from which this item type is derived by restriction.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 nodeboolean
Test whether this node test is satisfied by a given node.boolean
Test whether this node test is satisfied by a given node on a TinyTree.toString()
Display the type descriptor for diagnosticsMethods inherited from class net.sf.saxon.pattern.NodeTest
getAtomizedItemType, getContentType, getPrimitiveItemType, isAtomicType, isNillable, matchesItem
-
Constructor Details
-
NameTest
-
NameTest
Create a NameTest for nodes of the same type and name as a given node
-
-
Method Details
-
matches
public boolean matches(int nodeKind, int nameCode, int annotation) Test whether this node test is satisfied by a given node -
matches
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. -
matches
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. -
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 classNodeTest
-
getFingerprint
public int getFingerprint()Get the fingerprint required- Overrides:
getFingerprint
in classNodeTest
-
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 interfaceItemType
- Overrides:
getPrimitiveType
in classNodeTest
- Returns:
- the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT
-
getSuperType
Get the type from which this item type is derived by restriction. This is the supertype in the XPath type heirarchy, as distinct from the Schema base type: this means that the supertype of xs:boolean is xdt:anyAtomicType, whose supertype is item() (rather than xs:anySimpleType).In fact the concept of "supertype" is not really well-defined, because the types form a lattice rather than a hierarchy. The only real requirement on this function is that it returns a type that strictly subsumes this type, ideally as narrowly as possible.
- Specified by:
getSuperType
in interfaceItemType
- Overrides:
getSuperType
in classNodeTest
- Parameters:
th
-- Returns:
- the supertype, or null if this type is item()
-
getNodeKindMask
public int getNodeKindMask()Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1invalid input: '<'invalid input: '<'Type.ELEMENT for element nodes, 1invalid input: '<'invalid input: '<'Type.TEXT for text nodes, and so on.- Specified by:
getNodeKindMask
in classNodeTest
-
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 classNodeTest
-
toString
-
toString
Description copied from class:NodeTest
Display the type descriptor for diagnostics -
hashCode
public int hashCode()Returns a hash code value for the object. -
equals
Determines whether two NameTests are equal
-