net.sf.saxon.pattern

Class SameNameTest

java.lang.Object

net.sf.saxon.pattern.NodeTest

net.sf.saxon.pattern.SameNameTest

All Implemented Interfaces:

QNameTest, ItemType, ItemType.WithSequenceTypeCache

public class SameNameTest
extends NodeTest
implements QNameTest

NodeTest is an interface that enables a test of whether a node has a particular name and type. A SameNameTest matches a node that has the same node kind and name as a supplied node.

Note: it's not safe to use this if the supplied node is mutable.

Author:

Michael H. Kay

Nested Class Summary

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

ItemType.WithSequenceTypeCache

Constructor Summary

Constructors

Constructor and Description
SameNameTest(NodeInfo origin) Create a SameNameTest to match nodes by name

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Determines whether two NameTests are equal
String	generateJavaScriptItemTypeTest(ItemType knownToBe, int targetVersion) Generate Javascript code to test whether an item conforms to this item type
String	generateJavaScriptNameTest(int targetVersion) 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
NameTest	getEquivalentNameTest() Generate an equivalent NameTest
int	getFingerprint() Get the fingerprint required
String	getLocalPart() Get the local name matched by this nametest
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.
String	getNamespaceURI() Get the namespace URI matched by this nametest
int	getNodeKind() Get the node kind that this name test matches
int	getPrimitiveType() Determine the types of nodes to which this pattern applies.
Optional<IntSet>	getRequiredNodeNames() Get the set of node names allowed by this NodeTest.
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 the NameTest matches a given QName
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, explainMismatch, generateJavaScriptItemTypeAcceptor, getAlphaCode, getAtomizedItemType, getContentType, getGenre, getMatchingNodeName, getPrimitiveItemType, 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

SameNameTest

public SameNameTest(NodeInfo origin)

Create a SameNameTest to match nodes by name

Parameters:

origin - the node whose node kind and name must be matched

Since:

9.0

Method Detail

getNodeKind

public int getNodeKind()

Get the node kind that this name test matches

Returns:

the matching node kind

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

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

matches

public boolean matches(StructuredQName qname)

Test whether the NameTest matches a given QName

Specified by:

matches in interface QNameTest

Parameters:

qname - the QName to be matched

Returns:

true if the name matches

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

getFingerprint

public int getFingerprint()

Get the fingerprint required

Overrides:

getFingerprint in class NodeTest

getPrimitiveType

public int getPrimitiveType()

Determine the types of nodes to which this pattern applies. Used for optimisation. For patterns that match nodes of several types, return Type.NODE

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

getRequiredNodeNames

public Optional<IntSet> getRequiredNodeNames()

Description copied from class: NodeTest

Get the set of node names allowed by this NodeTest. This is returned as a set of Integer fingerprints. If all names are permitted (i.e. there are no constraints on the node name), returns IntUniversalSet.getInstance(). The default implementation returns the universal set.

Overrides:

getRequiredNodeNames in class NodeTest

Returns:

the set of integer fingerprints of the node names that this node test can match; or absent if the set of names cannot be represented (for example, with the name tests *:xxx or xxx:*)

getNamespaceURI

public String getNamespaceURI()

Get the namespace URI matched by this nametest

Returns:

the namespace URI (using "" for the "null namepace")

getLocalPart

public String getLocalPart()

Get the local name matched by this nametest

Returns:

the local name

toString

public String toString()

Specified by:

toString in interface ItemType

Overrides:

toString in class Object

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Determines whether two NameTests are equal

Overrides:

equals in class Object

getEquivalentNameTest

public NameTest getEquivalentNameTest()

Generate an equivalent NameTest

Returns:

a NameTest that matches the same node kind and name

generateJavaScriptNameTest

public String generateJavaScriptNameTest(int targetVersion)

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

Specified by:

generateJavaScriptNameTest in interface QNameTest

Parameters:

targetVersion - the version of Saxon-JS being targeted

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,
                                             int targetVersion)
                                      throws XPathException

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

Specified by:

generateJavaScriptItemTypeTest in interface ItemType

Parameters:

knownToBe - an item type that the value is known to conform to

targetVersion - the version of Saxon-JS 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.