Package net.sf.saxon.pattern

Class AnyNodeTest

  • All Implemented Interfaces:
    java.io.Serializable, QNameTest, ItemType
    public final class AnyNodeTest
extends NodeTest
implements QNameTest
    NodeTest is an interface that enables a test of whether a node has a particular name and type. An AnyNodeTest matches any node.
    Author:
    Michael H. Kay
    See Also:
    Serialized Form

    • Method Detail

      • getInstance

        public static AnyNodeTest getInstance()
        Get an instance of AnyNodeTest

      • matchesItem

        public boolean matchesItem​(Item item,
                           boolean allowURIPromotion,
                           Configuration config)
        Test whether a given item conforms to this type
        Specified by:
        matchesItem in interface ItemType
        Overrides:
        matchesItem in class NodeTest
        Parameters:
        item - The item to be tested
        allowURIPromotion -
        config -
        Returns:
        true if the item is an instance of this type; false otherwise

      • getSuperType

        public ItemType getSuperType​(TypeHierarchy th)
        Description copied from class: NodeTest
        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 xs:anyAtomicType, whose supertype is item() (rather than xs:anySimpleType).

        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.

        Specified by:
        getSuperType in interface ItemType
        Overrides:
        getSuperType in class NodeTest
        Parameters:
        th - the type hierarchy cache
        Returns:
        the supertype, or null if this type is item()

      • matches

        public boolean matches​(int nodeKind,
                       NodeName name,
                       int 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

      • matches

        public boolean matches​(TinyTree tree,
                       int nodeNr)
        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.
        Overrides:
        matches in class NodeTest
        Parameters:
        tree - the TinyTree containing the node
        nodeNr - the number of the node within the TinyTree
        Returns:
        true if the node matches the NodeTest, otherwise false

      • matches

        public boolean matches​(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:
        matches in class NodeTest
        Parameters:
        node - the node to be matched

      • matches

        public boolean matches​(StructuredQName qname)
        Test whether this QNameTest matches a given QName
        Specified by:
        matches in interface QNameTest
        Parameters:
        qname - the QName to be matched
        Returns:
        true if the name matches, false if not

      • 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 interface ItemType
        Returns:
        the default priority

      • getNodeKindMask

        public int getNodeKindMask()
        Get a mask indicating which kinds of nodes this NodeTest can match. This is a combination of bits: 1<
        Overrides:
        getNodeKindMask in class NodeTest
        Returns:
        a combination of bits: 1<

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • hashCode

        public int hashCode()
        Returns a hash code value for the object.
        Overrides:
        hashCode in class java.lang.Object