net.sf.saxon.pattern

Class MultipleNodeKindTest

java.lang.Object

net.sf.saxon.pattern.NodeTest

net.sf.saxon.pattern.MultipleNodeKindTest

All Implemented Interfaces:

ItemType, ItemType.WithSequenceTypeCache

public final class MultipleNodeKindTest
extends NodeTest

An MultipleNodeKindTest is a nodetest that matches nodes belonging to any subset of possible node kinds, for example element and document nodes, or attribute and namespace nodes

Nested Class Summary

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

ItemType.WithSequenceTypeCache

Field Summary

Fields

Modifier and Type	Field and Description
static MultipleNodeKindTest	DOC_ELEM_ATTR
static MultipleNodeKindTest	LEAF
(package private) int	nodeKindMask
static MultipleNodeKindTest	PARENT_NODE
(package private) UType	uType

Constructor Summary

Constructors

Constructor and Description
MultipleNodeKindTest(UType u)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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 to use if this pattern appears as a match pattern for a template with no explicit priority attribute.
IntPredicate	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.
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) Test whether this node test is satisfied by a given node.
String	toExportString() Return a string representation of this ItemType suitable for use in stylesheet export files.
String	toString()

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

copy, explainMismatch, generateJavaScriptItemTypeAcceptor, getAlphaCode, getAtomizedItemType, getContentType, getFingerprint, getGenre, getMatchingNodeName, getPrimitiveItemType, getPrimitiveType, 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

Field Detail

PARENT_NODE

public static final MultipleNodeKindTest PARENT_NODE

DOC_ELEM_ATTR

public static final MultipleNodeKindTest DOC_ELEM_ATTR

LEAF

public static final MultipleNodeKindTest LEAF

uType

UType uType

nodeKindMask

int nodeKindMask

Constructor Detail

MultipleNodeKindTest

public MultipleNodeKindTest(UType u)

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

getMatcher

public IntPredicate 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.

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

getDefaultPriority

public double getDefaultPriority()

Determine the default priority to use if this pattern appears as a match pattern for a template with no explicit priority attribute.

Specified by:

getDefaultPriority in class NodeTest

Returns:

the default priority for the pattern

toString

public String toString()

Specified by:

toString in interface ItemType

Overrides:

toString in class Object

toExportString

public String toExportString()

Description copied from interface: ItemType

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 Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

generateJavaScriptItemTypeTest

public String generateJavaScriptItemTypeTest(ItemType knownToBe,
                                             int targetVersion)

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

Parameters:

knownToBe - An item type that the supplied item is known to conform to; the generated code can assume that the item is an instance of this type.

targetVersion - The version of Saxon-JS for which code is being generated. Currently either 1 or 2.

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.