org.apache.ws.commons.serialize

Class DOMSerializer

public class DOMSerializer extends Object

Serializes a DOM node into a stream of SAX events.
Method Summary
protected voiddoSerialize(Node pNode, ContentHandler pHandler)
Converts the given node pNode into a stream of SAX events, which are fired into the content handler pHandler.
protected voiddoSerializeChilds(Node pNode, ContentHandler pHandler)
Serializes the childs of pNode.
booleanisNamespaceDeclarationAttribute()
Returns whether XML declarations are being serialized as attributes or as SAX events (default).
booleanisParentsNamespaceDeclarationDisabled()
Sets whether XML declarations present in the parent nodes are being serialized (default) or not.
booleanisStartingDocument()
Returns, whether startDocument and endDocument events are generated for document nodes.
voidserialize(Node pNode, ContentHandler pHandler)
Converts the given node pNode into a stream of SAX events, which are fired into the content handler pHandler.
voidsetNamespaceDeclarationAttribute(boolean pXmlDeclarationAttribute)
Sets whether XML namespace declarations are being serialized as attributes or as SAX events (default).
voidsetParentsNamespaceDeclarationDisabled(boolean pParentsXmlDeclarationDisabled)
Returns whether XML declarations present in the parent nodes are being serialized (default) or not.
voidsetStartingDocument(boolean pStartingDocument)
Sets, whether startDocument and endDocument events are generated for document nodes.

Method Detail

doSerialize

protected void doSerialize(Node pNode, ContentHandler pHandler)
Converts the given node pNode into a stream of SAX events, which are fired into the content handler pHandler. Unlike DOMSerializer, this method doesn't call DOMSerializer, and DOMSerializer.

Parameters: pNode The node being serialized. pHandler The target handler.

Throws: SAXException The target handler reported an error.

doSerializeChilds

protected void doSerializeChilds(Node pNode, ContentHandler pHandler)
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.

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.

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.

serialize

public void serialize(Node pNode, ContentHandler pHandler)
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.

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.

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.

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.

Copyright © 2005-2009 Apache Software Foundation. All Rights Reserved.