net.sf.saxon.pattern.NodeKindTest 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
An OSGi bundle for Saxon-HE
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2013 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.NodeInfo;
import net.sf.saxon.om.NodeName;
import net.sf.saxon.tree.tiny.TinyTree;
import net.sf.saxon.type.*;
/**
* NodeTest is an interface that enables a test of whether a node has a particular
* name and kind. A NodeKindTest matches the node kind only.
*
* @author Michael H. Kay
*/
public class NodeKindTest extends NodeTest {
public static final NodeKindTest DOCUMENT = new NodeKindTest(Type.DOCUMENT);
public static final NodeKindTest ELEMENT = new NodeKindTest(Type.ELEMENT);
public static final NodeKindTest ATTRIBUTE = new NodeKindTest(Type.ATTRIBUTE);
public static final NodeKindTest TEXT = new NodeKindTest(Type.TEXT);
public static final NodeKindTest COMMENT = new NodeKindTest(Type.COMMENT);
public static final NodeKindTest PROCESSING_INSTRUCTION = new NodeKindTest(Type.PROCESSING_INSTRUCTION);
public static final NodeKindTest NAMESPACE = new NodeKindTest(Type.NAMESPACE);
private int kind;
private NodeKindTest(int nodeKind) {
kind = nodeKind;
}
/**
* Get the node kind matched by this test
* @return the matching node kind
*/
public int getNodeKind() {
return kind;
}
/**
* Make a test for a given kind of node
*/
public static NodeTest makeNodeKindTest(int kind) {
switch (kind) {
case Type.DOCUMENT:
return DOCUMENT;
case Type.ELEMENT:
return ELEMENT;
case Type.ATTRIBUTE:
return ATTRIBUTE;
case Type.COMMENT:
return COMMENT;
case Type.TEXT:
return TEXT;
case Type.PROCESSING_INSTRUCTION:
return PROCESSING_INSTRUCTION;
case Type.NAMESPACE:
return NAMESPACE;
case Type.NODE:
return AnyNodeTest.getInstance();
default:
throw new IllegalArgumentException("Unknown node kind " + kind + " in NodeKindTest");
}
}
/**
* 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, int annotation) {
return (kind == nodeKind);
}
/**
* 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.getNodeKind(nodeNr) == kind;
}
/**
* 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() == kind;
}
/**
* Determine the default priority of this node test when used on its own as a Pattern
*/
public final double getDefaultPriority() {
return -0.5;
}
/**
* Determine the types of nodes to which this pattern applies. Used for optimisation.
* @return the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT
*/
public int getPrimitiveType() {
return kind;
}
/**
* Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination
* of bits: 1<