Class DocumentNodeTest

    • Constructor Detail

      • DocumentNodeTest

        public DocumentNodeTest​(NodeTest elementTest)
    • Method Detail

      • getUType

        public UType getUType()
        Get the corresponding UType. A UType is a union of primitive item types.
        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
        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
        true if the node matches this node test
      • test

        public boolean test​(NodeInfo node)
        Determine whether this Pattern matches the given Node.
        Specified by:
        test in interface java.util.function.Predicate<NodeInfo>
        test in class NodeTest
        node - The NodeInfo representing the Element or other node to be tested against the Pattern uses variables, or contains calls on functions such as document() or key().
        true if the node matches the Pattern, false otherwise
      • 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
        the default priority for the pattern
      • getPrimitiveType

        public int getPrimitiveType()
        Determine the types of nodes to which this pattern applies. Used for optimisation.
        Specified by:
        getPrimitiveType in interface ItemType
        getPrimitiveType in class NodeTest
        the type of node matched by this pattern. e.g. Type.ELEMENT or Type.TEXT
      • getElementTest

        public NodeTest getElementTest()
        Get the element test contained within this document test
        the contained element test
      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface ItemType
        toString in class java.lang.Object
      • hashCode

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

        public boolean equals​(java.lang.Object other)
        equals in class java.lang.Object
      • getFullAlphaCode

        public java.lang.String getFullAlphaCode()
        Description copied from interface: ItemType
        Get the full alpha code for this item type. As well as the basic alpha code, this contains additional information, for example element(EFG) has a basic alpha code of NE, but the full alpha code of NE nQ{}EFG.
      • explainMismatch

        public java.util.Optional<java.lang.String> explainMismatch​(Item item,
                                                                    TypeHierarchy th)
        Get extra diagnostic information about why a supplied item does not conform to this item type, if available. If extra information is returned, it should be in the form of a complete sentence, minus the closing full stop. No information should be returned for obvious cases.
        Specified by:
        explainMismatch in interface ItemType
        explainMismatch in class NodeTest
        item - the item that doesn't match this type
        th - the type hierarchy cache
        optionally, a message explaining why the item does not match the type