Interface DomDocument

  • All Known Implementing Classes:
    DomDocumentImpl

    public interface DomDocument
    Encapsulates a Document. Implementations of this interface must be thread-safe.
    Author:
    Sebastian Menski
    • Method Detail

      • getRootElement

        DomElement getRootElement()
        Returns the root element of the document.
        Returns:
        the root element or null if non exists
      • setRootElement

        void setRootElement​(DomElement rootElement)
        Sets the root element of the DOM document. Replace an existing if necessary.
        Parameters:
        rootElement - the new root element
      • createElement

        DomElement createElement​(java.lang.String namespaceUri,
                                 java.lang.String localName)
        Creates a new element in the dom document.
        Parameters:
        namespaceUri - the namespaceUri of the new element
        localName - the localName of the new element
        Returns:
        the new DOM element
      • getElementById

        DomElement getElementById​(java.lang.String id)
        Gets an element by its id.
        Parameters:
        id - the id to search for
        Returns:
        the element or null if no such element exists
      • getElementsByNameNs

        java.util.List<DomElement> getElementsByNameNs​(java.lang.String namespaceUri,
                                                       java.lang.String localName)
        Gets all elements with the namespace and name.
        Parameters:
        namespaceUri - the element namespaceURI to search for
        localName - the element name to search for
        Returns:
        the list of matching elements
      • getDomSource

        javax.xml.transform.dom.DOMSource getDomSource()
        Returns a new DOMSource of the document. Note that a DOMSource wraps the underlying Document which is not thread-safe. Multiple DOMSources of the same document should be synchronized by the calling application.
        Returns:
        the new DOMSource
      • registerNamespace

        java.lang.String registerNamespace​(java.lang.String namespaceUri)
        Registers a new namespace with a generic prefix.
        Parameters:
        namespaceUri - the namespaceUri of the new namespace
        Returns:
        the used prefix
      • registerNamespace

        void registerNamespace​(java.lang.String prefix,
                               java.lang.String namespaceUri)
        Registers a new namespace for the prefix.
        Parameters:
        prefix - the prefix of the new namespace
        namespaceUri - the namespaceUri of the new namespace
      • clone

        DomDocument clone()
        Clones the DOM document.
        Returns:
        the cloned DOM document