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

public class ContentTypeTest
extends NodeTest

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

Constructors

Constructor	Description
ContentTypeTest(int nodeKind, SchemaType schemaType, Configuration config, boolean nillable)	Create a ContentTypeTest

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)	Indicates whether some other object is "equal to" this one.
java.util.Optional<java.lang.String>	explainMismatch(Item item, TypeHierarchy th)	Get extra diagnostic information about why a supplied item does not conform to this item type, if available.
AtomicType	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)
SchemaType	getContentType()	Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes).
double	getDefaultPriority()	Determine the default priority of this node test when used on its own as a Pattern
IntPredicateProxy	getMatcher(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	getNodeKind()
int	getPrimitiveType()	Determine the types of nodes to which this pattern applies.
SchemaType	getSchemaType()
UType	getUType()	Get the corresponding UType.
int	hashCode()	Returns a hash code value for the object.
boolean	isAtomizable(TypeHierarchy th)	Ask whether values of this type are atomizable
boolean	isNillable()	The test is nillable if a question mark was specified as the occurrence indicator
boolean	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(NodeInfo node)	Test whether this node test is satisfied by a given node.
java.lang.String	toExportString()	Return a string representation of this ItemType suitable for use in stylesheet export files.
java.lang.String	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 Detail

ContentTypeTest

public ContentTypeTest(int nodeKind,
                       SchemaType schemaType,
                       Configuration config,
                       boolean nillable)

Create a ContentTypeTest

Parameters:

nodeKind - the kind of nodes to be matched: always elements or attributes

schemaType - the required type annotation, as a simple or complex schema type

config - the Configuration, supplied because this KindTest needs access to schema information

nillable - indicates whether an element with xsi:nil=true satisifies the test

Method Detail

getUType

public UType getUType()

Get the corresponding UType. 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 class NodeTest

Returns:

true if the test is nillable

getSchemaType

public SchemaType getSchemaType()

getNodeKind

public int getNodeKind()

matches

public boolean matches(int nodeKind,
                       NodeName name,
                       SchemaType annotation)

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 class NodeTest

Parameters:

nodeKind - The kind of node to be matched

name - 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

public IntPredicateProxy getMatcher(NodeVectorTree tree)

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 calling matchesNode(tree.getNode(nodeNr)), but it may well be faster).

Overrides:

getMatcher in class NodeTest

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

public boolean test(NodeInfo node)

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 interface NodePredicate

Overrides:

test in class NodeTest

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 interface ItemType

Specified by:

getDefaultPriority in class NodeTest

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 interface ItemType

Overrides:

getPrimitiveType in class NodeTest

Returns:

the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT

getContentType

public SchemaType 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 class NodeTest

Returns:

the type annotation that all nodes matching this NodeTest must satisfy

getAtomizedItemType

public AtomicType 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 interface ItemType

Overrides:

getAtomizedItemType in class NodeTest

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

public boolean isAtomizable(TypeHierarchy th)

Ask whether values of this type are atomizable

Specified by:

isAtomizable in interface ItemType

Overrides:

isAtomizable in class NodeTest

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

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toExportString

public java.lang.String 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 calling toString().

Returns:

the string representation as an instance of the XPath SequenceType construct

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class java.lang.Object

explainMismatch

public java.util.Optional<java.lang.String> explainMismatch(Item item,
                                                            TypeHierarchy th)

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 interface ItemType

Overrides:

explainMismatch in class NodeTest

Parameters:

item - the item that doesn't match this type

th - the type hierarchy cache

Returns:

optionally, a message explaining why the item does not match the type