Package net.sf.saxon.pattern
Class DocumentNodeTest
java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.DocumentNodeTest
- All Implemented Interfaces:
NodePredicate
,ItemType
,ItemTypeWithSequenceTypeCache
A DocumentNodeTest implements the test document-node(element(~,~))
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
explainMismatch
(Item item, TypeHierarchy th) Get extra diagnostic information about why a supplied item does not conform to this item type, if available.final double
Determine the default priority of this node test when used on its own as a PatternGet the element test contained within this document testGet the full alpha code for this item type.int
Determine the types of nodes to which this pattern applies.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
Determine whether this Pattern matches the given Node.toString()
Methods inherited from class net.sf.saxon.pattern.NodeTest
copy, getAtomizedItemType, getBasicAlphaCode, getContentType, getFingerprint, getGenre, getMatcher, getMatchingNodeName, getPrimitiveItemType, getRequiredNodeNames, 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
getNormalizedDefaultPriority, toExportString
-
Constructor Details
-
DocumentNodeTest
-
-
Method Details
-
getUType
Get the correspondingUType
. A UType is a union of primitive item types.- Returns:
- the smallest UType that subsumes this item type
-
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
-
test
Determine whether this Pattern matches the given Node.- Specified by:
test
in interfaceNodePredicate
- Overrides:
test
in classNodeTest
- Parameters:
node
- The NodeInfo representing the Element or other node to be tested against the Pattern uses variables, or contains calls on functions such as document() or key().- Returns:
- true if the node matches the Pattern, false otherwise
-
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
-
getPrimitiveType
public int getPrimitiveType()Determine the types of nodes to which this pattern applies. Used for optimisation.- 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
-
getElementTest
Get the element test contained within this document test- Returns:
- the contained element test
-
toString
-
hashCode
public int hashCode()Returns a hash code value for the object. -
equals
-
getFullAlphaCode
Description copied from interface:ItemType
Get the full alpha code for this item type. As well as the basic alpha code, this contains additional information, for exampleelement(EFG)
has a basic alpha code ofNE
, but the full alpha code ofNE nQ{}EFG
.- Returns:
- the alpha code for the type
-
explainMismatch
Get extra diagnostic information about why a supplied item does not conform to this item type, if available. If extra information is returned, it should be in the form of a complete sentence, minus the closing full stop. No information should be returned for obvious cases.- Specified by:
explainMismatch
in interfaceItemType
- Overrides:
explainMismatch
in classNodeTest
- Parameters:
item
- the item that doesn't match this typeth
- the type hierarchy cache- Returns:
- optionally, a message explaining why the item does not match the type
-