Package net.sf.saxon.pattern
Class ContentTypeTest
java.lang.Object
net.sf.saxon.pattern.NodeTest
net.sf.saxon.pattern.ContentTypeTest
- All Implemented Interfaces:
Serializable
,ItemType
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.
- Author:
- Michael H. Kay
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionContentTypeTest
(int nodeKind, SchemaType schemaType, Configuration config) Create a ContentTypeTest -
Method Summary
Modifier and TypeMethodDescriptionboolean
Indicates whether some other object is "equal to" this one.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 Patternint
int
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 type from which this item type is derived by restriction.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
Test whether this node test is satisfied by a given node.boolean
Test whether this node test is satisfied by a given node.boolean
Test whether this node test is satisfied by a given node on a TinyTree.void
setNillable
(boolean nillable) Indicate whether nilled elements should be matched (the default is false)toString()
void
Visit all the schema components used in this ItemType definitionMethods inherited from class net.sf.saxon.pattern.NodeTest
getFingerprint, getPrimitiveItemType, getRequiredNodeNames, isAtomicType, isPlainType, matches, matchesItem, toString
-
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 information
-
-
Method Details
-
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() -
getSuperType
Description copied from class:NodeTest
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()
-
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. -
getDefaultPriority
public final double getDefaultPriority()Determine the default priority of this node test when used on its own as a Pattern- Returns:
- the default priority
-
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
-
getNodeKindMask
public int getNodeKindMask()Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1invalid input: '<'invalid input: '<'Type.ELEMENT for element nodes, 1invalid input: '<'invalid input: '<'Type.TEXT for text nodes, and so on.- Overrides:
getNodeKindMask
in classNodeTest
- Returns:
- a combination of bits: 1invalid input: '<'invalid input: '<'Type.ELEMENT for element nodes, 1invalid input: '<'invalid input: '<'Type.TEXT for text nodes, and so on
-
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
-
isAtomizable
public boolean isAtomizable()Ask whether values of this type are atomizable- Specified by:
isAtomizable
in interfaceItemType
- Overrides:
isAtomizable
in classNodeTest
- Returns:
- true unless it is known that these items will be elements with element-only content, in which case return false
-
visitNamedSchemaComponents
Visit all the schema components used in this ItemType definition- Specified by:
visitNamedSchemaComponents
in interfaceItemType
- Overrides:
visitNamedSchemaComponents
in classNodeTest
- Parameters:
visitor
- the visitor class to be called when each component is visited- Throws:
XPathException
- if an error occurs
-
toString
-
hashCode
public int hashCode()Returns a hash code value for the object. -
equals
Indicates whether some other object is "equal to" this one.
-