Package net.sf.saxon.pattern
Class SameNameTest
java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.SameNameTest
- All Implemented Interfaces:
NodePredicate
,QNameTest
,ItemType
,ItemTypeWithSequenceTypeCache
NodeTest is an interface that enables a test of whether a node has a particular
name and type. A SameNameTest matches a node that has the same node kind and name
as a supplied node.
Note: it's not safe to use this if the supplied node is mutable.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determines whether two NameTests are equalExport the QNameTest as a string for use in a SEF file (typically in a catch clause).final double
Determine the default priority of this node test when used on its own as a PatternGenerate an equivalent NameTestint
Get the fingerprint requiredGet the local name matched by this nametestgetMatcher
(NodeVectorTree tree) Get a matching function that can be used to test whether numbered nodes in a TinyTree or DominoTree satisfy the node test.Get the namespace URI matched by this nametestint
Get the node kind that this name test matchesint
Determine the types of nodes to which this pattern applies.Get the set of node names allowed by this NodeTest.getUType()
Get the correspondingUType
.int
hashCode()
Returns a hash code value for the object.boolean
matches
(int nodeKind, NodeName name, SchemaType annotation) Test whether this node test is satisfied by a given node.boolean
matches
(StructuredQName qname) Test whether the NameTest matches a given QNameboolean
matchesFingerprint
(NamePool namePool, int fp) Test whether the QNameTest matches a given fingerprintboolean
Test whether this node test is satisfied by a given node.toString()
Methods inherited from class net.sf.saxon.pattern.NodeTest
copy, explainMismatch, getAtomizedItemType, getBasicAlphaCode, getContentType, getGenre, getMatchingNodeName, getPrimitiveItemType, isAtomicType, isAtomizable, isNillable, isPlainType, matches, one, oneOrMore, toShortString, zeroOrMore, zeroOrOne
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.saxon.type.ItemType
getFullAlphaCode, getNormalizedDefaultPriority, toExportString
-
Constructor Details
-
SameNameTest
Create a SameNameTest to match nodes by name- Parameters:
origin
- the node whose node kind and name must be matched- Since:
- 9.0
-
-
Method Details
-
getNodeKind
public int getNodeKind()Get the node kind that this name test matches- Returns:
- the matching node kind
-
getUType
Get the correspondingUType
. A UType is a union of primitive item types. -
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.- Specified by:
matches
in classNodeTest
- Parameters:
nodeKind
- The kind of node to be matchedname
- identifies the expanded name of the node to be matched. The value should be null for a node with no name.annotation
- The actual content type of the node- Returns:
- true if the node matches this node test
-
getMatcher
Description copied from class:NodeTest
Get a matching function that can be used to test whether numbered nodes in a TinyTree or DominoTree satisfy the node test. (Calling this matcher must give the same result as callingmatchesNode(tree.getNode(nodeNr))
, but it may well be faster).- Overrides:
getMatcher
in classNodeTest
- Parameters:
tree
- the tree against which the returned function will operate- Returns:
- an IntPredicate; the matches() method of this predicate takes a node number as input, and returns true if and only if the node identified by this node number matches the node test.
-
test
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:
test
in interfaceNodePredicate
- Overrides:
test
in classNodeTest
- Parameters:
node
- the node to be matched- Returns:
- true if the node test is satisfied by the supplied node, false otherwise
-
matches
Test whether the NameTest matches a given QName -
matchesFingerprint
Test whether the QNameTest matches a given fingerprint- Specified by:
matchesFingerprint
in interfaceQNameTest
- Parameters:
namePool
- the name poolfp
- the fingerprint of the QName to be matched- Returns:
- true if the name matches, false if not
-
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
- Specified by:
getDefaultPriority
in classNodeTest
- Returns:
- the default priority for the pattern
-
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
-
getRequiredNodeNames
Description copied from class:NodeTest
Get the set of node names allowed by this NodeTest. This is returned as a set of Integer fingerprints. If all names are permitted (i.e. there are no constraints on the node name), returns IntUniversalSet.getInstance(). The default implementation returns the universal set.- Overrides:
getRequiredNodeNames
in classNodeTest
- Returns:
- the set of integer fingerprints of the node names that this node test can match; or absent if the set of names cannot be represented (for example, with the name tests *:xxx or xxx:*)
-
getNamespaceURI
Get the namespace URI matched by this nametest- Returns:
- the namespace URI (using "" for the "null namepace")
-
getLocalPart
Get the local name matched by this nametest- Returns:
- the local name
-
toString
-
hashCode
public int hashCode()Returns a hash code value for the object. -
equals
Determines whether two NameTests are equal -
getEquivalentNameTest
Generate an equivalent NameTest- Returns:
- a NameTest that matches the same node kind and name
-
exportQNameTest
Export the QNameTest as a string for use in a SEF file (typically in a catch clause).- Specified by:
exportQNameTest
in interfaceQNameTest
- Returns:
- a string representation of the QNameTest, suitable for use in export files. The format is a sequence of alternatives separated by vertical bars, where each alternative is one of '*', '*:localname', 'Q{uri}*', or 'Q{uri}local'.
-