Package net.sf.saxon.pattern
Class AnyNodeTest
java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.AnyNodeTest
- 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. An AnyNodeTest matches any node.
-
Method Summary
Modifier and TypeMethodDescriptionExport 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 Patternstatic AnyNodeTest
Get an instance of AnyNodeTestgetMatcher
(NodeVectorTree tree) Get a matching function that can be used to test whether numbered nodes in a TinyTree or DominoTree satisfy the node test.getUType()
Get the correspondingUType
.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 this QNameTest 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, getFingerprint, getGenre, getMatchingNodeName, getPrimitiveItemType, getPrimitiveType, getRequiredNodeNames, isAtomicType, isAtomizable, isNillable, isPlainType, matches, one, oneOrMore, toShortString, zeroOrMore, zeroOrOne
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.saxon.type.ItemType
getFullAlphaCode, getNormalizedDefaultPriority, toExportString
-
Method Details
-
getInstance
Get an instance of AnyNodeTest- Returns:
- the singleton instance of this class
-
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 this QNameTest matches a given QName -
matchesFingerprint
Test whether the QNameTest matches a given fingerprint- Specified by:
matchesFingerprint
in interfaceQNameTest
- Parameters:
namePool
-fp
- 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
-
toString
-
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'.
-