package net.sf.saxon.pattern;
import net.sf.saxon.om.NamePool;
import net.sf.saxon.om.NodeInfo;
import net.sf.saxon.type.ItemType;
import net.sf.saxon.type.TypeHierarchy;
import net.sf.saxon.tinytree.TinyTree;
/**
* NodeTest is an interface that enables a test of whether a node has a particular
* name and type. A NamespaceTest matches the node type and the namespace URI.
*
* @author Michael H. Kay
*/
public final class NamespaceTest extends NodeTest {
private NamePool namePool;
private int nodeKind;
private short uriCode;
private String uri;
public NamespaceTest(NamePool pool, int nodeKind, String uri) {
namePool = pool;
this.nodeKind = nodeKind;
this.uri = uri;
this.uriCode = pool.allocateCodeForURI(uri);
}
/**
* Test whether this node test is satisfied by a given node
* @param nodeType The type of node to be matched
* @param fingerprint identifies the expanded name of the node to be matched
*/
public boolean matches(int nodeType, int fingerprint, int annotation) {
if (fingerprint == -1) return false;
if (nodeType != nodeKind) return false;
return uriCode == namePool.getURICode(fingerprint);
}
/**
* 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
*/
public boolean matches(TinyTree tree, int nodeNr) {
int fingerprint = tree.getNameCode(nodeNr) & NamePool.FP_MASK;
if (fingerprint == -1) return false;
if (tree.getNodeKind(nodeNr) != nodeKind) return false;
return uriCode == namePool.getURICode(fingerprint);
}
/**
* 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 matches(NodeInfo node) {
return node.getNodeKind()==nodeKind && node.getURI().equals(uri);
}
/**
* Determine the default priority of this node test when used on its own as a Pattern
*/
public final double getDefaultPriority() {
return -0.25;
}
/**
* 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 the type from which this item type is derived by restriction. This
* is the supertype in the XPath type heirarchy, as distinct from the Schema
* base type: this means that the supertype of xs:boolean is xdt:anyAtomicType,
* whose supertype is item() (rather than xs:anySimpleType).
* <p>
* In fact the concept of "supertype" is not really well-defined, because the types
* form a lattice rather than a hierarchy. The only real requirement on this function
* is that it returns a type that strictly subsumes this type, ideally as narrowly
* as possible.
* @return the supertype, or null if this type is item()
* @param th
*/
public ItemType getSuperType(TypeHierarchy th) {
return NodeKindTest.makeNodeKindTest(nodeKind);
}
/**
* Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination
* of bits: 1<<Type.ELEMENT for element nodes, 1<<Type.TEXT for text nodes, and so on.
*/
public int getNodeKindMask() {
return 1<<nodeKind;
}
public String toString() {
return '{' + namePool.getURIFromURICode(uriCode) + "}:*";
}
/**
* Returns a hash code value for the object.
*/
public int hashCode() {
return uriCode << 5 + nodeKind;
}
/**
* Indicates whether some other object is "equal to" this one.
*/
public boolean equals(Object other) {
return other instanceof NamespaceTest &&
((NamespaceTest)other).namePool == namePool &&
((NamespaceTest)other).nodeKind == nodeKind &&
((NamespaceTest)other).uriCode == uriCode;
}
}
//
// The contents of this file are subject to the Mozilla Public License Version 1.0 (the "License");
// you may not use this file except in compliance with the License. You may obtain a copy of the
// License at http://www.mozilla.org/MPL/
//
// Software distributed under the License is distributed on an "AS IS" basis,
// WITHOUT WARRANTY OF ANY KIND, either express or implied.
// See the License for the specific language governing rights and limitations under the License.
//
// The Original Code is: all this file.
//
// The Initial Developer of the Original Code is Michael H. Kay.
//
// Portions created by (your name) are Copyright (C) (your legal entity). All Rights Reserved.
//
// Contributor(s): none.
//
|