Class CombinedNodeTest

  • All Implemented Interfaces:
    java.io.Serializable, ItemType

    public class CombinedNodeTest
    extends NodeTest
    A CombinedNodeTest combines two nodetests using one of the operators union (=or), intersect (=and), difference (= "and not"). This arises when optimizing a union (etc) of two path expressions using the same axis. A CombinedNodeTest is also used to support constructs such as element(N,T), which can be expressed as (element(N,*) AND element(*,T))
    Author:
    Michael H. Kay
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)
      Indicates whether some other object is "equal to" this one.
      AtomicType getAtomizedItemType()
      Get the item type of the atomic values that will be produced when an item of this type is atomized (assuming that atomization succeeds)
      NodeTest[] getComponentNodeTests()
      Get the two parts of the combined node test
      SchemaType getContentType()
      Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes).
      double getDefaultPriority()
      get the default priority of this nodeTest when used as a pattern
      int getFingerprint()
      Get the name of the nodes matched by this nodetest, if it matches a specific name.
      int getNodeKindMask()
      Get a mask indicating which kinds of nodes this NodeTest can match.
      int getPrimitiveType()
      Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node, or Type.Node if it matches different kinds of nodes.
      IntHashSet getRequiredNodeNames()
      Get the set of node names allowed by this NodeTest.
      ItemType getSuperType​(TypeHierarchy th)
      Get the supertype of this type.
      int hashCode()
      Returns a hash code value for the object.
      boolean isNillable()
      Determine whether the content type (if present) is nillable
      boolean matches​(int nodeType, int fingerprint, int annotation)
      Test whether this node test is satisfied by a given node.
      boolean matches​(NodeInfo node)
      Test whether this node test is satisfied by a given node.
      boolean matches​(TinyTree tree, int nodeNr)
      Test whether this node test is satisfied by a given node on a TinyTree.
      void setGlobalComponentTest​(boolean global)
      Indicate whether this CombinedNodeTest actually represents a SequenceType of the form schema-element(X) or schema-attribute(X).
      java.lang.String toString​(NamePool pool)
      Display the type descriptor for diagnostics
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CombinedNodeTest

        public CombinedNodeTest​(NodeTest nt1,
                                int operator,
                                NodeTest nt2)
    • Method Detail

      • setGlobalComponentTest

        public void setGlobalComponentTest​(boolean global)
        Indicate whether this CombinedNodeTest actually represents a SequenceType of the form schema-element(X) or schema-attribute(X). This information is used only when reconstructing a string representation of the NodeTest for diagnostics.
      • matches

        public boolean matches​(int nodeType,
                               int fingerprint,
                               int annotation)
        Test whether this node test is satisfied by a given node.
        Specified by:
        matches in class NodeTest
        Parameters:
        nodeType - The type of node to be matched
        fingerprint - identifies the expanded name of the node to be matched.
        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.
        Specified by:
        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.
        Specified by:
        matches in class NodeTest
        Parameters:
        node - the node to be matched
      • getSuperType

        public ItemType getSuperType​(TypeHierarchy th)
        Get the supertype of this type. This isn't actually a well-defined concept: the types form a lattice rather than a strict hierarchy.
        Specified by:
        getSuperType in interface ItemType
        Overrides:
        getSuperType in class NodeTest
        Parameters:
        th -
        Returns:
        the supertype, or null if this type is item()
      • getNodeKindMask

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

        public int getPrimitiveType()
        Get the basic kind of object that this ItemType matches: for a NodeTest, this is the kind of node, or Type.Node if it matches different kinds of nodes.
        Specified by:
        getPrimitiveType in interface ItemType
        Overrides:
        getPrimitiveType in class NodeTest
        Returns:
        the node kind matched by this node test
      • getRequiredNodeNames

        public IntHashSet getRequiredNodeNames()
        Get the set of node names allowed by this NodeTest. This is returned as a set of Integer fingerprints. A null value indicates that all names are permitted (i.e. that there are no constraints on the node name. The default implementation returns null.
        Overrides:
        getRequiredNodeNames in class NodeTest
      • getContentType

        public SchemaType getContentType()
        Get the content type allowed by this NodeTest (that is, the type annotation of the matched nodes). Return AnyType if there are no restrictions. The default implementation returns AnyType.
        Overrides:
        getContentType in class NodeTest
      • getFingerprint

        public int getFingerprint()
        Get the name of the nodes matched by this nodetest, if it matches a specific name. Return -1 if the node test matches nodes of more than one name
        Overrides:
        getFingerprint in class NodeTest
      • isNillable

        public boolean isNillable()
        Determine whether the content type (if present) is nillable
        Overrides:
        isNillable in class NodeTest
        Returns:
        true if the content test (when present) can match nodes that are nilled
      • 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)
        Indicates whether some other object is "equal to" this one.
        Overrides:
        equals in class java.lang.Object
      • getDefaultPriority

        public double getDefaultPriority()
        get the default priority of this nodeTest when used as a pattern
        Specified by:
        getDefaultPriority in class NodeTest
      • getComponentNodeTests

        public NodeTest[] getComponentNodeTests()
        Get the two parts of the combined node test