Class DOMSerializer

java.lang.Object
org.apache.ws.commons.serialize.DOMSerializer

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

    • namespaceDeclarationAttribute

      private boolean namespaceDeclarationAttribute
    • parentsNamespaceDeclarationDisabled

      private boolean parentsNamespaceDeclarationDisabled
    • startingDocument

      private boolean startingDocument
  • Constructor Details

    • DOMSerializer

      public DOMSerializer()
  • Method Details

    • 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(Node pNode, ContentHandler pHandler) throws SAXException
      Serializes the childs of pNode.
      Parameters:
      pNode - The parent node, whose childs are being serialized.
      pHandler - The target handler.
      Throws:
      SAXException - The target handler reported an error.
    • parentsStartPrefixMappingEvents

      private void parentsStartPrefixMappingEvents(Node pNode, ContentHandler pHandler) throws 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:
      SAXException - The target handler reported an error.
    • parentsEndPrefixMappingEvents

      private void parentsEndPrefixMappingEvents(Node pNode, ContentHandler pHandler) throws 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:
      SAXException - The target handler reported an error.
    • startPrefixMappingEvents

      private void startPrefixMappingEvents(Node pNode, ContentHandler pHandler) throws SAXException
      Creates startPrefixMapping events for the node pNode.
      Parameters:
      pNode - The node being serialized.
      pHandler - The target handler.
      Throws:
      SAXException - The target handler reported an error.
    • endPrefixMappingEvents

      private void endPrefixMappingEvents(Node pNode, ContentHandler pHandler) throws SAXException
      Creates endPrefixMapping events for the node pNode.
      Parameters:
      pNode - The node being serialized.
      pHandler - The target handler.
      Throws:
      SAXException - The target handler reported an error.
    • characters

      private void characters(ContentHandler pHandler, String pValue, boolean pCdata) throws SAXException
      Throws:
      SAXException
    • serialize

      public void serialize(Node pNode, ContentHandler pHandler) throws 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:
      SAXException - The target handler reported an error.
    • doSerialize

      protected void doSerialize(Node pNode, ContentHandler pHandler) throws SAXException
      Converts the given node pNode into a stream of SAX events, which are fired into the content handler pHandler. Unlike serialize(Node, ContentHandler), this method doesn't call parentsStartPrefixMappingEvents(Node, ContentHandler), and parentsEndPrefixMappingEvents(Node, ContentHandler).
      Parameters:
      pNode - The node being serialized.
      pHandler - The target handler.
      Throws:
      SAXException - The target handler reported an error.