Class ElementWithAttributes

    • Field Detail

      • namespaceList

        protected int[] namespaceList
      • sequence

        protected int sequence
    • Constructor Detail

      • ElementWithAttributes

        public ElementWithAttributes()
    • Method Detail

      • initialise

        public void initialise​(int nameCode,
                               AttributeCollection atts,
                               NodeInfo parent,
                               String baseURI,
                               int lineNumber,
                               int sequenceNumber)
        Initialise a new ElementWithAttributes with an element name and attribute list
        Overrides:
        initialise in class ElementImpl
        Parameters:
        name - The element name, with namespaces resolved
        atts - The attribute list, after namespace processing
        parent - The parent node
      • setNamespaceDeclarations

        public void setNamespaceDeclarations​(int[] namespaces,
                                             int namespacesUsed)
        Set the namespace declarations for the element
      • getURICodeForPrefix

        public short getURICodeForPrefix​(String prefix)
                                  throws NamespaceException
        Search the NamespaceList for a given prefix, returning the corresponding URI.
        Overrides:
        getURICodeForPrefix in class ElementImpl
        Parameters:
        prefix - The prefix to be matched. To find the default namespace, supply ""
        Returns:
        The URI code corresponding to this namespace. If it is an unnamed default namespace, return Namespace.NULL_CODE.
        Throws:
        NamespaceException - if the prefix has not been declared on this NamespaceList.
      • getPrefixForURI

        public String getPrefixForURI​(String uri)
        Search the NamespaceList for a given URI, returning the corresponding prefix.
        Overrides:
        getPrefixForURI in class ElementImpl
        Parameters:
        uri - The URI to be matched.
        Returns:
        The prefix corresponding to this URI. If not found, return null. If there is more than one prefix matching the URI, the first one found is returned. If the URI matches the default namespace, return an empty string.
      • addNamespaceNodes

        public void addNamespaceNodes​(ElementImpl owner,
                                      Vector list,
                                      boolean addXML)
        Make the set of all namespace nodes associated with this element.
        Overrides:
        addNamespaceNodes in class ElementImpl
        Parameters:
        owner - The element owning these namespace nodes.
        list - a Vector containing NamespaceImpl objects representing the namespaces in scope for this element; the method appends nodes to this Vector, which should initially be empty. Note that the returned list will never contain the XML namespace (to get this, the NamespaceEnumeration class adds it itself). The list WILL include an entry for the undeclaration xmlns=""; again it is the job of NamespaceEnumeration to ignore this, since it doesn't represent a true namespace node.
        addXML - Add a namespace node for the XML namespace
      • getNamespaceCodes

        protected int[] getNamespaceCodes()
        Get the list of in-scope namespaces for this element as an array of namespace codes. (Used by LiteralResultElement)
      • getAttributeList

        public AttributeCollection getAttributeList()
        Get the attribute list for this element.
        Overrides:
        getAttributeList in class ElementImpl
        Returns:
        The attribute list. This will not include any namespace attributes. The attribute names will be in expanded form, with prefixes replaced by URIs
      • hasAttributes

        public boolean hasAttributes()
        Returns whether this node (if it is an element) has any attributes.
        Specified by:
        hasAttributes in interface Node
        Overrides:
        hasAttributes in class NodeImpl
        Returns:
        true if this node has any attributes, false otherwise.
        Since:
        DOM Level 2
      • getAttributeValue

        public String getAttributeValue​(String uri,
                                        String localName)
        Find the value of a given attribute of this node.
        This method is defined on all nodes to meet XSL requirements, but for nodes other than elements it will always return null.
        Specified by:
        getAttributeValue in interface NodeInfo
        Overrides:
        getAttributeValue in class NodeImpl
        Parameters:
        uri - the namespace uri of an attribute
        localName - the local name of an attribute
        Returns:
        the value of the attribute, if it exists, otherwise null
      • getAttributeValue

        public String getAttributeValue​(String name)
        Find the value of a given attribute of this element.
        This is a short-cut method; the full capability to examine attributes is offered via the getAttributeList() method.
        The attribute may either be one that was present in the original XML document, or one that has been set by the application using setAttribute().
        Overrides:
        getAttributeValue in class ElementImpl
        Parameters:
        name - the name of an attribute. There must be no prefix in the name.
        Returns:
        the value of the attribute, if it exists, otherwise null
      • getAttributeValue

        public String getAttributeValue​(int fingerprint)
        Get the value of a given attribute of this node
        Specified by:
        getAttributeValue in interface NodeInfo
        Overrides:
        getAttributeValue in class NodeImpl
        Parameters:
        fingerprint - The fingerprint of the attribute name
        Returns:
        the attribute value if it exists or null if not
      • setAttribute

        public void setAttribute​(String name,
                                 String value)
                          throws DOMException
        Set the value of an attribute on the current element. This affects subsequent calls of getAttribute() for that element.
        Specified by:
        setAttribute in interface Element
        Overrides:
        setAttribute in class ElementImpl
        Parameters:
        name - The name of the attribute to be set. Any prefix is interpreted relative to the namespaces defined for this element.
        value - The new value of the attribute. Set this to null to remove the attribute.
        Throws:
        DOMException - (always): Saxon trees are immutable.
      • copy

        public void copy​(Outputter out,
                         boolean allNamespaces)
                  throws TransformerException
        Copy this node to a given outputter (supporting xsl:copy-of)
        Overrides:
        copy in class ElementImpl
        Parameters:
        out - The outputter
        allNamespaces - true if namespaces for ancestor nodes must be output
        Throws:
        TransformerException
      • getAttribute

        public String getAttribute​(String name)
        Retrieves an attribute value by name. Namespace declarations are not returned.
        Specified by:
        getAttribute in interface Element
        Overrides:
        getAttribute in class AbstractNode
        Parameters:
        name - The name of the attribute to retrieve.
        Returns:
        The Attr value as a string, or the empty string if that attribute does not have a specified or default value. (Note the difference from getAttributeValue(), which returns null if there is no value).
      • getAttributes

        public NamedNodeMap getAttributes()
        A NamedNodeMap containing the attributes of this element. This is a DOM method, so the list of attributes includes namespace declarations.
        Specified by:
        getAttributes in interface Node
        Overrides:
        getAttributes in class NodeImpl
      • getAttributeNode

        public Attr getAttributeNode​(String name)
        Retrieves an attribute node by name. Namespace declarations are not returned.
        To retrieve an attribute node by qualified name and namespace URI, use the getAttributeNodeNS method.
        Specified by:
        getAttributeNode in interface Element
        Overrides:
        getAttributeNode in class AbstractNode
        Parameters:
        name - The name (nodeName ) of the attribute to retrieve.
        Returns:
        The Attr node with the specified name ( nodeName ) or null if there is no such attribute.
      • getAttributeNS

        public String getAttributeNS​(String namespaceURI,
                                     String localName)
        Retrieves an attribute value by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.
        Specified by:
        getAttributeNS in interface Element
        Overrides:
        getAttributeNS in class AbstractNode
        Parameters:
        namespaceURI - The namespace URI of the attribute to retrieve.
        localName - The local name of the attribute to retrieve.
        Returns:
        The Attr value as a string, or the empty string if that attribute does not have a specified or default value.
        Since:
        DOM Level 2
      • setAttributeNS

        public void setAttributeNS​(String namespaceURI,
                                   String qualifiedName,
                                   String value)
                            throws DOMException
        Adds a new attribute. Always fails.
        Specified by:
        setAttributeNS in interface Element
        Overrides:
        setAttributeNS in class AbstractNode
        Parameters:
        namespaceURI - The namespace URI of the attribute to create or alter.
        qualifiedName - The qualified name of the attribute to create or alter.
        value - The value to set in string form.
        Throws:
        DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
      • getAttributeNodeNS

        public Attr getAttributeNodeNS​(String namespaceURI,
                                       String localName)
        Retrieves an Attr node by local name and namespace URI. DOM method, so namespace declarations count as attributes.
        Specified by:
        getAttributeNodeNS in interface Element
        Overrides:
        getAttributeNodeNS in class AbstractNode
        Parameters:
        namespaceURI - The namespace URI of the attribute to retrieve.
        localName - The local name of the attribute to retrieve.
        Returns:
        The Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.
        Since:
        DOM Level 2
      • setAttributeNodeNS

        public Attr setAttributeNodeNS​(Attr newAttr)
                                throws DOMException
        Add a new attribute. Always fails.
        Specified by:
        setAttributeNodeNS in interface Element
        Overrides:
        setAttributeNodeNS in class AbstractNode
        Parameters:
        newAttr - The Attr node to add to the attribute list.
        Returns:
        If the newAttr attribute replaces an existing attribute with the same local name and namespace URI , the replaced Attr node is returned, otherwise null is returned.
        Throws:
        DOMException -
        NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
        Since:
        DOM Level 2
      • hasAttribute

        public boolean hasAttribute​(String name)
        Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. Namespace declarations are not included.
        Specified by:
        hasAttribute in interface Element
        Overrides:
        hasAttribute in class AbstractNode
        Parameters:
        name - The name of the attribute to look for.
        Returns:
        true if an attribute with the given name is specified on this element or has a default value, false otherwise.
        Since:
        DOM Level 2
      • hasAttributeNS

        public boolean hasAttributeNS​(String namespaceURI,
                                      String localName)
        Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise. This is a DOM method so namespace declarations are treated as attributes.
        Specified by:
        hasAttributeNS in interface Element
        Overrides:
        hasAttributeNS in class AbstractNode
        Parameters:
        namespaceURI - The namespace URI of the attribute to look for.
        localName - The local name of the attribute to look for.
        Returns:
        true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise.
        Since:
        DOM Level 2
      • getNamedItem

        public Node getNamedItem​(String name)
        Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.
        Specified by:
        getNamedItem in interface NamedNodeMap
      • item

        public Node item​(int index)
        Get n'th attribute (DOM NamedNodeMap method). Namespace declarations are not returned.
        Specified by:
        item in interface NamedNodeMap
      • getLength

        public int getLength()
        Get number of attributes (DOM NamedNodeMap method). Treats namespace declarations as attributes.
        Specified by:
        getLength in interface NamedNodeMap
        Overrides:
        getLength in class AbstractNode
      • getNamedItemNS

        public Node getNamedItemNS​(String uri,
                                   String localName)
        Get named attribute (DOM NamedNodeMap method) Treats namespace declarations as attributes.
        Specified by:
        getNamedItemNS in interface NamedNodeMap
      • getSequenceNumber

        protected final 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.
        Overrides:
        getSequenceNumber in class NodeImpl
      • hasChildNodes

        public final boolean hasChildNodes()
        Determine if the node has any children.
        Specified by:
        hasChildNodes in interface Node
        Specified by:
        hasChildNodes in interface NodeInfo
        Overrides:
        hasChildNodes in class NodeImpl
        Returns:
        true if the node has any children, false if the node has no children.
      • enumerateChildren

        public final AxisEnumeration enumerateChildren​(NodeTest test)
        Get an enumeration of the children of this node
      • getFirstChild

        public final Node getFirstChild()
        Get the first child node of the element
        Specified by:
        getFirstChild in interface Node
        Overrides:
        getFirstChild in class NodeImpl
        Returns:
        the first child node of the required type, or null if there are no children
      • getLastChild

        public final Node getLastChild()
        Get the last child node of the element
        Specified by:
        getLastChild in interface Node
        Overrides:
        getLastChild in class NodeImpl
        Returns:
        the last child of the element, or null if there are no children
      • getChildNodes

        public final NodeList getChildNodes()
        Return a NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.
        Specified by:
        getChildNodes in interface Node
        Overrides:
        getChildNodes in class NodeImpl
      • getNthChild

        protected final NodeImpl getNthChild​(int n)
        Get the nth child node of the element (numbering from 0)
        Returns:
        the last child of the element, or null if there is no n'th child
      • getStringValue

        public String getStringValue()
        Return the string-value of the node, that is, the concatenation of the character content of all descendent elements and text nodes.
        Returns:
        the accumulated character content of the element, including descendant elements.
      • useChildrenArray

        public void useChildrenArray​(NodeImpl[] array)
        Supply an array to be used for the array of children. For system use only.
      • addChild

        public void addChild​(NodeImpl node,
                             int index)
        Add a child node to this node. For system use only. Note: normalizing adjacent text nodes is the responsibility of the caller.
      • removeChild

        public void removeChild​(int index)
        Remove node at given index. Will always be followed by a renumberChildren().
      • renumberChildren

        public void renumberChildren()
        Renumber the children of a given parent node. For system use only
      • dropChildren

        public void dropChildren()
        Drop a branch of the tree. The target element remains in the tree, but its children are disconnected from the parent. Unless there are other references to the children (e.g. in a variable) they will be deleted from memory next time the garbage collector comes round.
      • compact

        public void compact​(int size)
        Compact the space used by this node
      • getNodeValue

        public String getNodeValue()
        Get the node value as defined in the DOM. This is not the same as the XPath string-value.
        Specified by:
        getNodeValue in interface Node
        Overrides:
        getNodeValue in class AbstractNode