net.sf.saxon.pattern

Class DocumentNodeTest

java.lang.Object

net.sf.saxon.pattern.NodeTest

net.sf.saxon.pattern.DocumentNodeTest

All Implemented Interfaces:

ItemType, ItemType.WithSequenceTypeCache

public class DocumentNodeTest
extends NodeTest

A DocumentNodeTest implements the test document-node(element(~,~))

Nested Class Summary

Nested classes/interfaces inherited from interface net.sf.saxon.type.ItemType

ItemType.WithSequenceTypeCache

Constructor Summary

Constructors

Constructor and Description
DocumentNodeTest(NodeTest elementTest)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
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.
java.lang.String	generateJavaScriptItemTypeTest(ItemType knownToBe, int targetVersion) Generate Javascript code to test whether an item conforms to this item type
double	getDefaultPriority() Determine the default priority of this node test when used on its own as a Pattern
NodeTest	getElementTest() Get the element test contained within this document test
int	getPrimitiveType() Determine the types of nodes to which this pattern applies.
UType	getUType() Get the corresponding UType.
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	matchesNode(NodeInfo node) Determine whether this Pattern matches the given Node.
java.lang.String	toString()

Methods inherited from class net.sf.saxon.pattern.NodeTest

copy, generateJavaScriptItemTypeAcceptor, getAlphaCode, getAtomizedItemType, 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

isTrueItemType, toExportString

Constructor Detail

DocumentNodeTest

public DocumentNodeTest(NodeTest elementTest)

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

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

matchesNode

public boolean matchesNode(NodeInfo node)

Determine whether this Pattern matches the given Node.

Overrides:

matchesNode in class NodeTest

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

getElementTest

public NodeTest getElementTest()

Get the element test contained within this document test

Returns:

the contained element test

toString

public java.lang.String toString()

Specified by:

toString in interface ItemType

Overrides:

toString in class java.lang.Object

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)

Overrides:

equals in class java.lang.Object

generateJavaScriptItemTypeTest

public java.lang.String generateJavaScriptItemTypeTest(ItemType knownToBe,
                                                       int targetVersion)
                                                throws XPathException

Generate Javascript code to test whether an item conforms to this item type

Parameters:

knownToBe - a type that the item is known to conform to, without further testing

targetVersion - the Saxon-JS version being targeted

Returns:

a Javascript instruction or sequence of instructions, which can be used as the body of a Javascript function, and which returns a boolean indication whether the value of the variable "item" is an instance of this item type.

Throws:

XPathException - if JS code cannot be generated for this item type, for example because the test is schema-aware.

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