Package net.sf.saxon.pattern
Class NameTest
java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.NameTest
- All Implemented Interfaces:
Serializable
,QNameTest
,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
ConstructorsConstructorDescriptionCreate a NameTest to match nodes by their nameCode allocated from the NamePoolCreate a NameTest to match nodes by nameCreate a NameTest to match nodes by nameCreate a NameTest for nodes of the same type and name as a given node -
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 requiredGet the NamePool associated with this NameTestint
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
Test whether this node test is satisfied by a given node.boolean
Test whether this node test is satisfied by a given node.boolean
matches
(StructuredQName qname) Test whether the NameTest matches a given QNameboolean
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, isAtomizable, isNillable, isPlainType, matches, matchesItem, visitNamedSchemaComponents
-
Constructor Details
-
NameTest
Create a NameTest to match nodes by name- Parameters:
nodeKind
- the kind of node, for exampleType.ELEMENT
uri
- the namespace URI of the required nodes. Supply "" to match nodes that are in no namespacelocalName
- the local name of the required nodes. Supply "" to match unnamed nodesnamePool
- the namePool holding the name codes- Since:
- 9.0
-
NameTest
Create a NameTest to match nodes by their nameCode allocated from the NamePool- Parameters:
nodeKind
- the kind of node, for exampleType.ELEMENT
nameCode
- the nameCode representing the name of the nodenamePool
- the namePool holding the name codes- Since:
- 8.4
-
NameTest
Create a NameTest to match nodes by name- Parameters:
nodeKind
- the kind of node, for exampleType.ELEMENT
name
- the name of the nodes that this NameTest will matchpool
- the namePool holding the name codes- Since:
- 9.4
-
NameTest
Create a NameTest for nodes of the same type and name as a given node- Parameters:
node
- the node whose node kind and node name will form the basis of the NameTest
-
-
Method Details
-
getNamePool
Get the NamePool associated with this NameTest- Returns:
- the NamePool
-
matches
Test whether this node test is satisfied by a given node. This method is only fully supported for a subset of NodeTests, because it doesn't provide all the information needed to evaluate all node tests. In particular (a) it can't be used to evaluate a node test of the form element(N,T) or schema-element(E) where it is necessary to know whether the node is nilled, and (b) it can't be used to evaluate a node test of the form document-node(element(X)). This in practice means that it is used (a) to evaluate the simple node tests found in the XPath 1.0 subset used in XML Schema, and (b) to evaluate node tests where the node kind is known to be an attribute. -
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. -
matches
Test whether the NameTest matches a given QName -
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 interfaceItemType
- Returns:
- the default priority
-
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 xs: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
- the type hierarchy cache- 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: 1<<Type.ELEMENT for element nodes, 1<<Type.TEXT for text nodes, and so on.- Overrides:
getNodeKindMask
in classNodeTest
- Returns:
- a combination of bits: 1<<Type.ELEMENT for element nodes, 1<<Type.TEXT for text nodes, and so on
-
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
- Returns:
- the set of integer fingerprints of the node names that this node test can match.
-
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
-