net.sf.saxon.pattern

Class AnyNodeTest

java.lang.Object

net.sf.saxon.pattern.NodeTest

net.sf.saxon.pattern.AnyNodeTest

All Implemented Interfaces:

QNameTest, ItemType

public final class AnyNodeTest
extends NodeTest
implements QNameTest

NodeTest is an interface that enables a test of whether a node has a particular name and type. An AnyNodeTest matches any node.

Author:

Michael H. Kay

Method Summary

Modifier and Type	Method and Description
String	generateJavaScriptItemTypeTest(ItemType knownToBe) Generate Javascript code to test whether an item conforms to this item type
String	generateJavaScriptNameTest() Generate Javascript code to test if a name matches the test.
double	getDefaultPriority() Determine the default priority of this node test when used on its own as a Pattern
static AnyNodeTest	getInstance() Get an instance of AnyNodeTest
int	getNodeKindMask() Get a mask indicating which kinds of nodes this NodeTest can match.
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	matches(StructuredQName qname) Test whether this QNameTest matches a given QName
boolean	matches(TinyTree tree, int nodeNr) Test whether this node test is satisfied by a given node on a TinyTree.
boolean	matchesNode(NodeInfo node) Test whether this node test is satisfied by a given node.
String	toString()

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

copy, generateJavaScriptItemTypeAcceptor, getAtomizedItemType, getContentType, getFingerprint, getMatchingNodeName, getPrimitiveItemType, getPrimitiveType, getRequiredNodeNames, isAtomicType, isAtomizable, isNillable, isPlainType, matches, visitNamedSchemaComponents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static AnyNodeTest getInstance()

Get an instance of AnyNodeTest

Returns:

the singleton instance of this class

getUType

public UType getUType()

Get the corresponding UType. A UType is a union of primitive item types.

Specified by:

getUType in interface ItemType

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

matches

public boolean matches(TinyTree tree,
                       int nodeNr)

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.

Overrides:

matches in class NodeTest

Parameters:

tree - the TinyTree containing the node

nodeNr - the number of the node within the TinyTree

Returns:

true if the node matches the NodeTest, otherwise false

matchesNode

public boolean matchesNode(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.

Overrides:

matchesNode in class NodeTest

Parameters:

node - the node to be matched

Returns:

true if the node test is satisfied by the supplied node, false otherwise

matches

public boolean matches(StructuredQName qname)

Test whether this QNameTest matches a given QName

Specified by:

matches in interface QNameTest

Parameters:

qname - the QName to be matched

Returns:

true if the name matches, false if not

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

getNodeKindMask

public int getNodeKindMask()

Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1<

Overrides:

getNodeKindMask in class NodeTest

Returns:

a combination of bits: 1<

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class Object

generateJavaScriptNameTest

public String generateJavaScriptNameTest()

Generate Javascript code to test if a name matches the test.

Specified by:

generateJavaScriptNameTest in interface QNameTest

Returns:

JS code as a string. The generated code will be used as the body of a JS function in which the argument name "q" is an XdmQName object holding the name. The XdmQName object has properties uri and local.

generateJavaScriptItemTypeTest

public String generateJavaScriptItemTypeTest(ItemType knownToBe)
                                      throws XPathException

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

Specified by:

generateJavaScriptItemTypeTest in interface ItemType

Parameters:

knownToBe -

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.