Class ElementImpl

    • Field Detail

      • nameCode

        protected int nameCode
      • sequence

        protected int sequence
    • Constructor Detail

      • ElementImpl

        public ElementImpl()
        Construct an empty ElementImpl
    • Method Detail

      • setNameCode

        public void setNameCode​(int nameCode)
        Set the name code. Used when creating a dummy element in the Stripper
      • initialise

        public void initialise​(int nameCode,
                               AttributeCollection atts,
                               NodeInfo parent,
                               String baseURI,
                               int lineNumber,
                               int sequenceNumber)
        Initialise a new ElementImpl with an element name
        Parameters:
        name - The element name, with namespaces resolved
        atts - The attribute list: always null
        parent - The parent node
      • setSystemId

        public void setSystemId​(String uri)
        Set the system ID of this node. This method is provided so that a NodeInfo implements the javax.xml.transform.Source interface, allowing a node to be used directly as the Source of a transformation
        Specified by:
        setSystemId in interface Source
        Overrides:
        setSystemId in class NodeImpl
      • getSystemId

        public final String getSystemId()
        Get the system ID of the entity containing this element node.
        Specified by:
        getSystemId in interface NodeInfo
        Specified by:
        getSystemId in interface Source
        Specified by:
        getSystemId in interface SourceLocator
        Overrides:
        getSystemId in class NodeImpl
        Returns:
        the System Identifier of the entity in the source document containing the node, or null if not known. Note this is not the same as the base URI: the base URI can be modified by xml:base, but the system ID cannot.
      • getBaseURI

        public String getBaseURI()
        Get the base URI of this element node. This will be the same as the System ID unless xml:base has been used.
        Specified by:
        getBaseURI in interface Node
        Specified by:
        getBaseURI in interface NodeInfo
        Overrides:
        getBaseURI in class NodeImpl
      • setLineNumber

        public void setLineNumber​(int line)
        Set the line number of the element within its source document entity
      • getLineNumber

        public int getLineNumber()
        Get the line number of the node within its source document entity
        Specified by:
        getLineNumber in interface NodeInfo
        Specified by:
        getLineNumber in interface SourceLocator
        Overrides:
        getLineNumber in class NodeImpl
        Returns:
        the line number of the node in its original source document; or -1 if not available
      • generateId

        public String generateId()
        Get a character string that uniquely identifies this node within this document (The calling code will prepend a document identifier)
        Specified by:
        generateId in interface NodeInfo
        Overrides:
        generateId in class NodeImpl
        Returns:
        a string.
      • getURICodeForPrefix

        public short getURICodeForPrefix​(String prefix)
                                  throws NamespaceException
        Search the NamespaceList for a given prefix, returning the corresponding URI.
        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.
        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.
      • makeNameCode

        public final int makeNameCode​(String qname,
                                      boolean useDefault)
                               throws NamespaceException
        Make a NameCode, using this Element as the context for namespace resolution. The name will be entered in the namepool: therefore this method should not be called once the name pool is sealed.
        Parameters:
        qname - The name as written, in the form "[prefix:]localname"
        Throws:
        NamespaceException
      • addNamespaceNodes

        public void addNamespaceNodes​(ElementImpl owner,
                                      Vector list,
                                      boolean addXML)
        Make the set of all namespace nodes associated with this element.
        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 the XML namespace node to the list
      • getNodeType

        public final short getNodeType()
        Return the type of node.
        Specified by:
        getNodeType in interface Node
        Specified by:
        getNodeType in interface NodeInfo
        Returns:
        NodeInfo.ELEMENT
      • getAttributeList

        public AttributeCollection getAttributeList()
        Get the attribute list for this element.
        Returns:
        The attribute list. This will not include any namespace attributes. The attribute names will be in expanded form, with prefixes replaced by URIs
      • 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().
        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
      • copy

        public void copy​(Outputter out,
                         boolean allNamespaces)
                  throws TransformerException
        Copy this node to a given outputter (supporting xsl:copy-of)
        Parameters:
        out - The outputter
        allNamespaces - true if namespaces for ancestor nodes must be output
        Throws:
        TransformerException
      • 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