Package net.sf.saxon.pattern

Class SameNameTest

  • All Implemented Interfaces:
    NodePredicate, QNameTest, ItemType, ItemTypeWithSequenceTypeCache
    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.

    • 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 IntPredicateProxy 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.

      • test

        public boolean test​(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.
        Specified by:
        test in interface NodePredicate
        Overrides:
        test 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

      • matchesFingerprint

        public boolean matchesFingerprint​(NamePool namePool,
                                  int fp)
        Test whether the QNameTest matches a given fingerprint
        Specified by:
        matchesFingerprint in interface QNameTest
        Parameters:
        namePool - the name pool
        fp - the fingerprint of 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
        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 java.util.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 NamespaceUri getNamespaceURI()
        Get the namespace URI matched by this nametest
        Returns:
        the namespace URI (using "" for the "null namepace")

      • getLocalPart

        public java.lang.String getLocalPart()
        Get the local name matched by this nametest
        Returns:
        the local name

      • 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

      • equals

        public boolean equals​(java.lang.Object other)
        Determines whether two NameTests are equal
        Overrides:
        equals in class java.lang.Object

      • getEquivalentNameTest

        public NameTest getEquivalentNameTest()
        Generate an equivalent NameTest
        Returns:
        a NameTest that matches the same node kind and name

      • exportQNameTest

        public java.lang.String exportQNameTest()
        Export the QNameTest as a string for use in a SEF file (typically in a catch clause).
        Specified by:
        exportQNameTest in interface QNameTest
        Returns:
        a string representation of the QNameTest, suitable for use in export files. The format is a sequence of alternatives separated by vertical bars, where each alternative is one of '*', '*:localname', 'Q{uri}*', or 'Q{uri}local'.