Class AttributeImpl

  • All Implemented Interfaces:
    javax.xml.transform.Source, javax.xml.transform.SourceLocator, ActiveSource, GroundedValue, Item, MutableNodeInfo, NodeInfo, Sequence, Location, SteppingNode, SiblingCountingNode, org.xml.sax.Locator

    public class AttributeImpl
    extends NodeImpl
    A node in the "linked" tree representing an attribute. Note that this is generated only "on demand", when the attribute is selected by a path expression.

    It is possible for multiple AttributeImpl objects to represent the same attribute node. The identity of an attribute node is determined by the identity of the element, and the index position of the attribute within the element. Index positions are not reused when an attribute is deleted, and are retained when an attribute is renamed.

    This object no longer caches information such as the name code and string value, because these would become invalid when the element node is modified.

    • Constructor Detail

      • AttributeImpl

        public AttributeImpl​(ElementImpl element,
                             int index)
        Construct an Attribute node for the n'th attribute of a given element
        element - The element containing the relevant attribute
        index - The index position of the attribute starting at zero
    • Method Detail

      • getNodeName

        public NodeName getNodeName()
        Get the name of the node. Returns null for an unnamed node
        getNodeName in class NodeImpl
        the name of the node
      • getFingerprint

        public int getFingerprint()
        Get the fingerprint of the node. This is used to compare whether two nodes have equivalent names. Return -1 for a node with no name.
        Specified by:
        getFingerprint in interface NodeInfo
        getFingerprint in class NodeImpl
        an integer fingerprint; two nodes with the same fingerprint have the same expanded QName. For unnamed nodes (text nodes, comments, document nodes, and namespace nodes for the default namespace), returns -1.
      • isId

        public boolean isId()
        Determine whether this node has the is-id property
        true if the node is an ID
      • isIdref

        public boolean isIdref()
        Determine whether this node has the is-idref property
        true if the node is an IDREF or IDREFS element or attribute
      • equals

        public boolean equals​(java.lang.Object other)
        Determine whether this is the same node as another node
        Specified by:
        equals in interface NodeInfo
        equals in class NodeImpl
        other - the node to be compared with this node
        true if this Node object and the supplied Node object represent the same node in the tree.
      • hashCode

        public int hashCode()
        The hashCode() method obeys the contract for hashCode(): that is, if two objects are equal (represent the same node) then they must have the same hashCode()
        Specified by:
        hashCode in interface NodeInfo
        hashCode in class NodeImpl
      • getSequenceNumber

        protected long getSequenceNumber()
        Get the node sequence number (in document order). Sequence numbers are monotonic but not consecutive. In the current implementation, parent nodes (elements and roots) have a zero least-significant word, while namespaces, attributes, text nodes, comments, and PIs have the top word the same as their owner and the bottom half reflecting their relative position.
        getSequenceNumber in class NodeImpl
        the sequence number if there is one, or -1L otherwise.
      • getNodeKind

        public final int getNodeKind()
        Return the type of node.
        See Also:
      • getUnicodeStringValue

        public UnicodeString getUnicodeStringValue()
        Return the character value of the node.
        the attribute value
      • getStringValue

        public java.lang.String getStringValue()
        Description copied from interface: Item
        Get the value of the item as a Java string. For nodes, this is the string value of the node as defined in the XPath 2.0 data model, except that all nodes are treated as being untyped: it is not an error to get the string value of a node with a complex type. For atomic values, the method returns the result of casting the atomic value to a string.
        the string value of the item
      • getNextSibling

        public NodeImpl getNextSibling()
        Get next sibling - not defined for attributes
        Specified by:
        getNextSibling in interface SteppingNode
        getNextSibling in class NodeImpl
        The next sibling node of the required type. Returns null if the current node is the last child of its parent.
      • getPreviousSibling

        public NodeImpl getPreviousSibling()
        Get previous sibling - not defined for attributes
        Specified by:
        getPreviousSibling in interface SteppingNode
        getPreviousSibling in class NodeImpl
        The previous sibling node. Returns null if the current node is the first child of its parent.
      • getPreviousInDocument

        public NodeImpl getPreviousInDocument()
        Get the previous node in document order (skipping attributes)
        getPreviousInDocument in class NodeImpl
        the previous node in the document, or null if there is no such node
      • getNextInDocument

        public NodeImpl getNextInDocument​(NodeImpl anchor)
        Get the next node in document order (skipping attributes)
        getNextInDocument in class NodeImpl
        anchor - the scan stops when it reaches a node that is not a descendant of the specified anchor node
        the next node in the document, or null if there is no such node
      • generateId

        public void generateId​(java.lang.StringBuilder buffer)
        Get sequential key. Returns key of owning element with the attribute index as a suffix
        Specified by:
        generateId in interface NodeInfo
        generateId in class NodeImpl
        buffer - a buffer to which the generated ID will be written
      • copy

        public void copy​(Receiver out,
                         int copyOptions,
                         Location locationId)
                  throws XPathException
        Copy this node to a given outputter.
        out - the Receiver to which the node should be copied. It is the caller's responsibility to ensure that this Receiver is open before the method is called (or that it is self-opening), and that it is closed after use.
        copyOptions - a selection of the options defined in CopyOptions
        locationId - If non-null, identifies the location of the instruction that requested this copy. If null, indicates that the location information is not available
        java.lang.IllegalArgumentException - this method is not supported for attribute nodes
        XPathException - if any downstream error occurs
      • delete

        public void delete()
        Delete this node (that is, detach it from its parent)
        Specified by:
        delete in interface MutableNodeInfo
        delete in class NodeImpl
      • isDeleted

        public boolean isDeleted()
        Test whether this MutableNodeInfo object represents a node that has been deleted. Generally, such a node is unusable, and any attempt to use it will result in an exception being thrown
        Specified by:
        isDeleted in interface MutableNodeInfo
        isDeleted in class NodeImpl
        true if this node has been deleted
      • replace

        public void replace​(NodeInfo[] replacement,
                            boolean inherit)
        Replace this node with a given sequence of nodes
        Specified by:
        replace in interface MutableNodeInfo
        replace in class NodeImpl
        replacement - the replacement nodes (which for this version of the method must be attribute nodes - they may use any implementation of the NodeInfo interface). The target attribute node is deleted, and the replacement nodes are added to the parent element; if they have the same names as existing nodes, then the existing nodes will be overwritten.
        inherit - set to true if new child elements are to inherit the in-scope namespaces of their new parent. Not used when replacing attribute nodes.
        java.lang.IllegalArgumentException - if any of the replacement nodes is not an attribute
        java.lang.IllegalStateException - if this node has been deleted or has no parent node or if two of the replacement nodes have the same name
      • rename

        public void rename​(NodeName newNameCode,
                           boolean inherit)
        Rename this node
        Specified by:
        rename in interface MutableNodeInfo
        rename in class NodeImpl
        newNameCode - the NamePool code of the new name
        inherit - true if any new namespace binding is to be inherited
      • replaceStringValue

        public void replaceStringValue​(UnicodeString stringValue)
        Description copied from interface: MutableNodeInfo
        Replace the string-value of this node. If applied to an element or document node, this causes all existing children to be deleted, and replaced with a new text node whose string value is the value supplied. The caller is responsible for checking that the value is valid, for example that comments do not contain a double hyphen; the implementation is not required to check for such conditions.
        stringValue - the new string value
      • removeTypeAnnotation

        public void removeTypeAnnotation()
        Remove type information from this node (and its ancestors, recursively). This method implements the upd:removeType() primitive defined in the XQuery Update specification
        Specified by:
        removeTypeAnnotation in interface MutableNodeInfo
        removeTypeAnnotation in class NodeImpl
      • setTypeAnnotation

        public void setTypeAnnotation​(SchemaType type)
        Set the type annotation on a node. This must only be called when the caller has verified (by validation) that the node is a valid instance of the specified type. The call is ignored if the node is not an element or attribute node.
        Specified by:
        setTypeAnnotation in interface MutableNodeInfo
        setTypeAnnotation in class NodeImpl
        type - the type annotation (possibly including high bits set to indicate the isID, isIDREF, and isNilled properties)