net.sf.saxon.pattern.NameTest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation
Show all versions of Saxon-HE Show documentation
The XSLT and XQuery Processor
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2015 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.pattern;
import net.sf.saxon.om.*;
import net.sf.saxon.tree.tiny.TinyTree;
import net.sf.saxon.type.SchemaType;
import net.sf.saxon.type.Type;
import net.sf.saxon.type.UType;
import net.sf.saxon.z.IntSet;
import net.sf.saxon.z.IntSingletonSet;
/**
* NodeTest is an interface that enables a test of whether a node has a particular
* name and type. A NameTest matches the node kind and the namespace URI and the local
* name. Note that unlike the XPath production called NameTest, this is a test for a specific
* name, and does not include wildcard matches.
*
* @author Michael H. Kay
*/
public class NameTest extends NodeTest implements QNameTest {
private int nodeKind;
private int fingerprint;
private UType uType;
private NamePool namePool;
/*@Nullable*/ private String uri = null; // the URI corresponding to the fingerprint - computed lazily
/*@Nullable*/ private String localName = null; //the local name corresponding to the fingerprint - computed lazily
/**
* Create a NameTest to match nodes by name
*
* @param nodeKind the kind of node, for example {@link Type#ELEMENT}
* @param uri the namespace URI of the required nodes. Supply "" to match nodes that are in
* no namespace
* @param localName the local name of the required nodes. Supply "" to match unnamed nodes
* @param namePool the namePool holding the name codes
* @since 9.0
*/
public NameTest(int nodeKind, String uri, String localName, NamePool namePool) {
this.uri = uri;
this.localName = localName;
this.nodeKind = nodeKind;
this.fingerprint = namePool.allocate("", uri, localName) & NamePool.FP_MASK;
this.namePool = namePool;
this.uType = UType.fromTypeCode(nodeKind);
}
/**
* Create a NameTest to match nodes by their nameCode allocated from the NamePool
*
* @param nodeKind the kind of node, for example {@link Type#ELEMENT}
* @param nameCode the nameCode representing the name of the node
* @param namePool the namePool holding the name codes
* @since 8.4
*/
public NameTest(int nodeKind, int nameCode, NamePool namePool) {
this.nodeKind = nodeKind;
this.fingerprint = nameCode & 0xfffff;
this.namePool = namePool;
this.uType = UType.fromTypeCode(nodeKind);
}
/**
* Create a NameTest to match nodes by name
*
* @param nodeKind the kind of node, for example {@link Type#ELEMENT}
* @param name the name of the nodes that this NameTest will match
* @param pool the namePool holding the name codes
* @since 9.4
*/
public NameTest(int nodeKind, NodeName name, NamePool pool) {
this.uri = name.getURI();
this.localName = name.getLocalPart();
this.nodeKind = nodeKind;
this.fingerprint = name.allocateNameCode(pool) & NamePool.FP_MASK;
this.namePool = pool;
this.uType = UType.fromTypeCode(nodeKind);
}
/**
* Get the NamePool associated with this NameTest
*
* @return the NamePool
*/
public NamePool getNamePool() {
return namePool;
}
/**
* Get the node kind that this name test matches
*
* @return the matching node kind
*/
public int getNodeKind() {
return nodeKind;
}
/**
* Get the corresponding {@link net.sf.saxon.type.UType}. A UType is a union of primitive item
* types.
*
* @return the smallest UType that subsumes this item type
*/
public UType getUType() {
return uType;
}
/**
* 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.
*
* @param nodeKind The kind of node to be matched
* @param name identifies the expanded name of the node to be matched.
* The value should be null for a node with no name.
* @param annotation The actual content type of the node
*/
@Override
public boolean matches(int nodeKind, NodeName name, SchemaType annotation) {
if (nodeKind != this.nodeKind) {
return false;
}
if (name.hasFingerprint()) {
return name.getFingerprint() == this.fingerprint;
} else {
computeUriAndLocal();
return name.hasURI(uri) && name.getLocalPart().equals(localName);
}
}
/**
* 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.
*
* @param tree the TinyTree containing the node
* @param nodeNr the number of the node within the TinyTree
* @return true if the node matches the NodeTest, otherwise false
*/
public boolean matches(TinyTree tree, int nodeNr) {
return (tree.getNameCode(nodeNr) & 0xfffff) == this.fingerprint && tree.getNodeKind(nodeNr) == this.nodeKind;
}
/**
* 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.
*
* @param node the node to be matched
*/
public boolean matchesNode(NodeInfo node) {
if (node.getNodeKind() != nodeKind) {
return false;
}
// Two different algorithms are used for name matching. If the fingerprint of the node is readily
// available, we use it to do an integer comparison. Otherwise, we do string comparisons on the URI
// and local name. In practice, Saxon's native node implementations use fingerprint matching, while
// DOM and JDOM nodes use string comparison of names
if (node instanceof FingerprintedNode) {
return ((FingerprintedNode)node).getFingerprint() == fingerprint;
} else {
computeUriAndLocal();
return localName.equals(node.getLocalPart()) && uri.equals(node.getURI());
}
}
private void computeUriAndLocal() {
if (uri == null) {
uri = namePool.getURI(fingerprint);
}
if (localName == null) {
localName = namePool.getLocalName(fingerprint);
}
}
/**
* Test whether the NameTest matches a given QName
*
* @param qname the QName to be matched
* @return true if the name matches
*/
public boolean matches(StructuredQName qname) {
computeUriAndLocal();
return qname.getLocalPart().equals(localName) && qname.hasURI(uri);
}
/**
* Determine the default priority of this node test when used on its own as a Pattern
*/
public final double getDefaultPriority() {
return 0.0;
}
/**
* Get the fingerprint required
*/
public int getFingerprint() {
return fingerprint;
}
/**
* Get the name of the nodes matched by this nodetest, if it matches a specific name.
* Return null if the node test matches nodes of more than one name
*/
@Override
public StructuredQName getMatchingNodeName() {
computeUriAndLocal();
return new StructuredQName("", uri, localName);
}
/**
* Determine the types of nodes to which this pattern applies. Used for optimisation.
* For patterns that match nodes of several types, return Type.NODE
*
* @return the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT
*/
public int getPrimitiveType() {
return nodeKind;
}
/**
* Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination
* of bits: 1<© 2015 - 2025 Weber Informatics LLC | Privacy Policy