Package net.sf.saxon.pattern
Class ContentTypeTest
java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.ContentTypeTest
- All Implemented Interfaces:
NodePredicate
,ItemType
,ItemTypeWithSequenceTypeCache
NodeTest is an interface that enables a test of whether a node matches particular
conditions. ContentTypeTest tests for an element or attribute node with a particular
type annotation, regardless of the node name.
-
Constructor Summary
ConstructorsConstructorDescriptionContentTypeTest
(int nodeKind, SchemaType schemaType, Configuration config, boolean nillable) Create a ContentTypeTest -
Method Summary
Modifier and TypeMethodDescriptionboolean
Indicates whether some other object is "equal to" this one.explainMismatch
(Item item, TypeHierarchy th) Get extra diagnostic information about why a supplied item does not conform to this item type, if available.Get the item type of the atomic values that will be produced when an item of this type is atomized (assuming that atomization succeeds)Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes).final double
Determine the default priority of this node test when used on its own as a PatterngetMatcher
(NodeVectorTree tree) Get a matching function that can be used to test whether numbered nodes in a TinyTree or DominoTree satisfy the node test.int
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
Ask whether values of this type are atomizableboolean
The test is nillable if a question mark was specified as the occurrence indicatorboolean
matches
(int nodeKind, NodeName name, SchemaType annotation) Test whether this node test is satisfied by a given node.void
setNillable
(boolean nillable) Indicate whether nilled elements should be matched (the default is false)boolean
Test whether this node test is satisfied by a given node.Return a string representation of this ItemType suitable for use in stylesheet export files.toString()
Methods inherited from class net.sf.saxon.pattern.NodeTest
copy, getBasicAlphaCode, getFingerprint, getGenre, getMatchingNodeName, getPrimitiveItemType, getRequiredNodeNames, isAtomicType, 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
-
Constructor Details
-
ContentTypeTest
Create a ContentTypeTest- Parameters:
nodeKind
- the kind of nodes to be matched: always elements or attributesschemaType
- the required type annotation, as a simple or complex schema typeconfig
- the Configuration, supplied because this KindTest needs access to schema informationnillable
- indicates whether an element with xsi:nil=true satisifies the test
-
-
Method Details
-
getUType
Get the correspondingUType
. A UType is a union of primitive item types.- Returns:
- the smallest UType that subsumes this item type
-
setNillable
public void setNillable(boolean nillable) Indicate whether nilled elements should be matched (the default is false)- Parameters:
nillable
- true if nilled elements should be matched
-
isNillable
public boolean isNillable()The test is nillable if a question mark was specified as the occurrence indicator- Overrides:
isNillable
in classNodeTest
- Returns:
- true if the test is nillable
-
getSchemaType
-
getNodeKind
public int getNodeKind() -
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
-
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
-
getContentType
Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes). Return AnyType if there are no restrictions. The default implementation returns AnyType.- Overrides:
getContentType
in classNodeTest
- Returns:
- the type annotation that all nodes matching this NodeTest must satisfy
-
getAtomizedItemType
Get the item type of the atomic values that will be produced when an item of this type is atomized (assuming that atomization succeeds)- Specified by:
getAtomizedItemType
in interfaceItemType
- Overrides:
getAtomizedItemType
in classNodeTest
- Returns:
- the best available item type of the atomic values that will be produced when an item of this type is atomized, or null if it is known that atomization will throw an error.
-
isAtomizable
Ask whether values of this type are atomizable- Specified by:
isAtomizable
in interfaceItemType
- Overrides:
isAtomizable
in classNodeTest
- Parameters:
th
- The type hierarchy cache- Returns:
- true unless it is known that these items will be elements with element-only content, in which case return false
-
toString
-
toExportString
Return a string representation of this ItemType suitable for use in stylesheet export files. This differs from the result of toString() in that it will not contain any references to anonymous types. Note that it may also use the Saxon extended syntax for union types and tuple types. The default implementation returns the result of callingtoString()
.- Returns:
- the string representation as an instance of the XPath SequenceType construct
-
hashCode
public int hashCode()Returns a hash code value for the object. -
equals
Indicates whether some other object is "equal to" this one. -
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
-