Package org.apache.ws.commons.serialize

Class DOMSerializer

  • public class DOMSerializer
extends java.lang.Object
    Serializes a DOM node into a stream of SAX events.

    • Constructor Summary

      Constructors 
      Constructor Description
      DOMSerializer()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private void characters​(org.xml.sax.ContentHandler pHandler, java.lang.String pValue, boolean pCdata)  
      protected void doSerialize​(org.w3c.dom.Node pNode, org.xml.sax.ContentHandler pHandler)
      Converts the given node pNode into a stream of SAX events, which are fired into the content handler pHandler.
      protected void doSerializeChilds​(org.w3c.dom.Node pNode, org.xml.sax.ContentHandler pHandler)
      Serializes the childs of pNode.
      private void endPrefixMappingEvents​(org.w3c.dom.Node pNode, org.xml.sax.ContentHandler pHandler)
      Creates endPrefixMapping events for the node pNode.
      boolean isNamespaceDeclarationAttribute()
      Returns whether XML declarations are being serialized as attributes or as SAX events (default).
      boolean isParentsNamespaceDeclarationDisabled()
      Sets whether XML declarations present in the parent nodes are being serialized (default) or not.
      boolean isStartingDocument()
      Returns, whether startDocument and endDocument events are generated for document nodes.
      private void parentsEndPrefixMappingEvents​(org.w3c.dom.Node pNode, org.xml.sax.ContentHandler pHandler)
      Finally creates endPrefixMapping events for the nodes parents.
      private void parentsStartPrefixMappingEvents​(org.w3c.dom.Node pNode, org.xml.sax.ContentHandler pHandler)
      Initially creates startPrefixMapping events for the nodes parents.
      void serialize​(org.w3c.dom.Node pNode, org.xml.sax.ContentHandler pHandler)
      Converts the given node pNode into a stream of SAX events, which are fired into the content handler pHandler.
      void setNamespaceDeclarationAttribute​(boolean pXmlDeclarationAttribute)
      Sets whether XML namespace declarations are being serialized as attributes or as SAX events (default).
      void setParentsNamespaceDeclarationDisabled​(boolean pParentsXmlDeclarationDisabled)
      Returns whether XML declarations present in the parent nodes are being serialized (default) or not.
      void setStartingDocument​(boolean pStartingDocument)
      Sets, whether startDocument and endDocument events are generated for document nodes.
      private void startPrefixMappingEvents​(org.w3c.dom.Node pNode, org.xml.sax.ContentHandler pHandler)
      Creates startPrefixMapping events for the node pNode.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • namespaceDeclarationAttribute

        private boolean namespaceDeclarationAttribute

      • parentsNamespaceDeclarationDisabled

        private boolean parentsNamespaceDeclarationDisabled

      • startingDocument

        private boolean startingDocument

    • Constructor Detail

      • DOMSerializer

        public DOMSerializer()

    • Method Detail

      • setNamespaceDeclarationAttribute

        public void setNamespaceDeclarationAttribute​(boolean pXmlDeclarationAttribute)
        Sets whether XML namespace declarations are being serialized as attributes or as SAX events (default).
        Parameters:
        pXmlDeclarationAttribute - True, if a namespace declaration is being transmitted as an XML attribute. False otherwise.

      • isNamespaceDeclarationAttribute

        public boolean isNamespaceDeclarationAttribute()
        Returns whether XML declarations are being serialized as attributes or as SAX events (default).
        Returns:
        True, if a namespace declaration is being transmitted as an XML attribute. False otherwise.

      • setParentsNamespaceDeclarationDisabled

        public void setParentsNamespaceDeclarationDisabled​(boolean pParentsXmlDeclarationDisabled)
        Returns whether XML declarations present in the parent nodes are being serialized (default) or not. This option takes effect only if the namespace declarations are sent as events. In other words, if the namespaceDeclarationAttribute properts is false.
        Parameters:
        pParentsXmlDeclarationDisabled - True, if namespace declarations of the parent nodes are disabled, false otherwise.

      • isParentsNamespaceDeclarationDisabled

        public boolean isParentsNamespaceDeclarationDisabled()
        Sets whether XML declarations present in the parent nodes are being serialized (default) or not. This option takes effect only if the namespace declarations are sent as events. In other words, if the namespaceDeclarationAttribute properts is false.
        Returns:
        True, if namespace declarations of the parent nodes are disabled, false otherwise.

      • isStartingDocument

        public boolean isStartingDocument()
        Returns, whether startDocument and endDocument events are generated for document nodes.
        Returns:
        True (default), if startDocument and endDocument events are being generated. False otherwise.

      • setStartingDocument

        public void setStartingDocument​(boolean pStartingDocument)
        Sets, whether startDocument and endDocument events are generated for document nodes.
        Parameters:
        pStartingDocument - True (default), if startDocument and endDocument events are being generated. False otherwise.

      • doSerializeChilds

        protected void doSerializeChilds​(org.w3c.dom.Node pNode,
                                 org.xml.sax.ContentHandler pHandler)
                          throws org.xml.sax.SAXException
        Serializes the childs of pNode.
        Parameters:
        pNode - The parent node, whose childs are being serialized.
        pHandler - The target handler.
        Throws:
        org.xml.sax.SAXException - The target handler reported an error.

      • parentsStartPrefixMappingEvents

        private void parentsStartPrefixMappingEvents​(org.w3c.dom.Node pNode,
                                             org.xml.sax.ContentHandler pHandler)
                                      throws org.xml.sax.SAXException
        Initially creates startPrefixMapping events for the nodes parents. This is invoked only, if isNamespaceDeclarationAttribute(), and isParentsNamespaceDeclarationDisabled() are false.
        Parameters:
        pNode - The node, for which namespace declarations are being created.
        pHandler - The target handler.
        Throws:
        org.xml.sax.SAXException - The target handler reported an error.

      • parentsEndPrefixMappingEvents

        private void parentsEndPrefixMappingEvents​(org.w3c.dom.Node pNode,
                                           org.xml.sax.ContentHandler pHandler)
                                    throws org.xml.sax.SAXException
        Finally creates endPrefixMapping events for the nodes parents. This is invoked only, if isNamespaceDeclarationAttribute(), and isParentsNamespaceDeclarationDisabled() are false.
        Parameters:
        pNode - The node, for which namespace declarations are being created.
        pHandler - The target handler.
        Throws:
        org.xml.sax.SAXException - The target handler reported an error.

      • startPrefixMappingEvents

        private void startPrefixMappingEvents​(org.w3c.dom.Node pNode,
                                      org.xml.sax.ContentHandler pHandler)
                               throws org.xml.sax.SAXException
        Creates startPrefixMapping events for the node pNode.
        Parameters:
        pNode - The node being serialized.
        pHandler - The target handler.
        Throws:
        org.xml.sax.SAXException - The target handler reported an error.

      • endPrefixMappingEvents

        private void endPrefixMappingEvents​(org.w3c.dom.Node pNode,
                                    org.xml.sax.ContentHandler pHandler)
                             throws org.xml.sax.SAXException
        Creates endPrefixMapping events for the node pNode.
        Parameters:
        pNode - The node being serialized.
        pHandler - The target handler.
        Throws:
        org.xml.sax.SAXException - The target handler reported an error.

      • characters

        private void characters​(org.xml.sax.ContentHandler pHandler,
                        java.lang.String pValue,
                        boolean pCdata)
                 throws org.xml.sax.SAXException
        Throws:
        org.xml.sax.SAXException

      • serialize

        public void serialize​(org.w3c.dom.Node pNode,
                      org.xml.sax.ContentHandler pHandler)
               throws org.xml.sax.SAXException
        Converts the given node pNode into a stream of SAX events, which are fired into the content handler pHandler.
        Parameters:
        pNode - The node being serialized.
        pHandler - The target handler.
        Throws:
        org.xml.sax.SAXException - The target handler reported an error.