org.apache.xml.serialize

Class DOMSerializerImpl

public class DOMSerializerImpl extends Object implements LSSerializer, DOMConfiguration

EXPERIMENTAL: Implemenatation of DOM Level 3 org.w3c.ls.LSSerializer by delegating serialization calls to XMLSerializer. LSSerializer provides an API for serializing (writing) a DOM document out in an XML document. The XML data is written to an output stream. During serialization of XML data, namespace fixup is done when possible as defined in DOM Level 3 Core, Appendix B.

Version: $Id: DOMSerializerImpl.java,v 1.36 2005/06/13 22:26:42 nddelima Exp $

Author: Elena Litani, IBM Gopal Sharma, Sun Microsystems Arun Yadav, Sun Microsystems

Field Summary
protected static shortCDATA
protected static shortCOMMENTS
protected static shortDISCARDDEFAULT
protected static shortDOM_ELEMENT_CONTENT_WHITESPACE
protected static shortENTITIES
protected shortfeatures
REVISIT: Currently we handle 3 different configurations, would be nice just have one configuration that has different recognized parameters depending if it is used in Core/LS.
protected static shortINFOSET
protected static shortNAMESPACES
protected static shortNSDECL
protected static shortSPLITCDATA
protected static shortWELLFORMED
protected static shortXMLDECL
Constructor Summary
DOMSerializerImpl()
Constructs a new LSSerializer.
Method Summary
booleancanSetParameter(String name, Object state)
DOM L3-EXPERIMENTAL: Check if parameter can be set
DOMConfigurationgetDomConfig()
LSSerializerFiltergetFilter()
When the application provides a filter, the serializer will call out to the filter before serializing each Node.
StringgetNewLine()
DOM L3 EXPERIMENTAL: The end-of-line sequence of characters to be used in the XML being written out.
ObjectgetParameter(String name)
DOM L3-EXPERIMENTAL: Getter for boolean and object parameters
DOMStringListgetParameterNames()
DOM Level 3 Core CR - Experimental.
voidsetFilter(LSSerializerFilter filter)
When the application provides a filter, the serializer will call out to the filter before serializing each Node.
voidsetNewLine(String newLine)
DOM L3 EXPERIMENTAL: The end-of-line sequence of characters to be used in the XML being written out.
voidsetParameter(String name, Object value)
DOM L3-EXPERIMENTAL: Setter for boolean and object parameters
booleanwrite(Node node, LSOutput destination)
Serialize the specified node as described above in the general description of the LSSerializer interface.
StringwriteToString(Node wnode)
DOM L3 EXPERIMENTAL: Serialize the specified node as described above in the description of LSSerializer.
booleanwriteToURI(Node node, String URI)
Serialize the specified node as described above in the general description of the LSSerializer interface.

Field Detail

CDATA

protected static final short CDATA

COMMENTS

protected static final short COMMENTS

DISCARDDEFAULT

protected static final short DISCARDDEFAULT

DOM_ELEMENT_CONTENT_WHITESPACE

protected static final short DOM_ELEMENT_CONTENT_WHITESPACE

ENTITIES

protected static final short ENTITIES

features

protected short features
REVISIT: Currently we handle 3 different configurations, would be nice just have one configuration that has different recognized parameters depending if it is used in Core/LS.

INFOSET

protected static final short INFOSET

NAMESPACES

protected static final short NAMESPACES

NSDECL

protected static final short NSDECL

SPLITCDATA

protected static final short SPLITCDATA

WELLFORMED

protected static final short WELLFORMED

XMLDECL

protected static final short XMLDECL

Constructor Detail

DOMSerializerImpl

public DOMSerializerImpl()
Constructs a new LSSerializer. The constructor turns on the namespace support in XMLSerializer and initializes the following fields: fNSBinder, fLocalNSBinder, fSymbolTable, fEmptySymbol, fXmlSymbol, fXmlnsSymbol, fNamespaceCounter, fFeatures.

Method Detail

canSetParameter

public boolean canSetParameter(String name, Object state)
DOM L3-EXPERIMENTAL: Check if parameter can be set

getDomConfig

public DOMConfiguration getDomConfig()

getFilter

public LSSerializerFilter getFilter()
When the application provides a filter, the serializer will call out to the filter before serializing each Node. Attribute nodes are never passed to the filter. The filter implementation can choose to remove the node from the stream or to terminate the serialization early.

getNewLine

public String getNewLine()
DOM L3 EXPERIMENTAL: The end-of-line sequence of characters to be used in the XML being written out. The only permitted values are these:
null
Use a default end-of-line sequence. DOM implementations should choose the default to match the usual convention for text files in the environment being used. Implementations must choose a default sequence that matches one of those allowed by 2.11 "End-of-Line Handling".
CR
The carriage-return character (#xD).
CR-LF
The carriage-return and line-feed characters (#xD #xA).
LF
The line-feed character (#xA).

The default value for this attribute is null.

getParameter

public Object getParameter(String name)
DOM L3-EXPERIMENTAL: Getter for boolean and object parameters

getParameterNames

public DOMStringList getParameterNames()
DOM Level 3 Core CR - Experimental. The list of the parameters supported by this DOMConfiguration object and for which at least one value can be set by the application. Note that this list can also contain parameter names defined outside this specification.

setFilter

public void setFilter(LSSerializerFilter filter)
When the application provides a filter, the serializer will call out to the filter before serializing each Node. Attribute nodes are never passed to the filter. The filter implementation can choose to remove the node from the stream or to terminate the serialization early.

setNewLine

public void setNewLine(String newLine)
DOM L3 EXPERIMENTAL: The end-of-line sequence of characters to be used in the XML being written out. The only permitted values are these:
null
Use a default end-of-line sequence. DOM implementations should choose the default to match the usual convention for text files in the environment being used. Implementations must choose a default sequence that matches one of those allowed by 2.11 "End-of-Line Handling".
CR
The carriage-return character (#xD).
CR-LF
The carriage-return and line-feed characters (#xD #xA).
LF
The line-feed character (#xA).

The default value for this attribute is null.

setParameter

public void setParameter(String name, Object value)
DOM L3-EXPERIMENTAL: Setter for boolean and object parameters

write

public boolean write(Node node, LSOutput destination)
Serialize the specified node as described above in the general description of the LSSerializer interface. The output is written to the supplied LSOutput.
When writing to a LSOutput, the encoding is found by looking at the encoding information that is reachable through the LSOutput and the item to be written (or its owner document) in this order:
  1. LSOutput.encoding,
  2. Document.actualEncoding,
  3. Document.xmlEncoding.

If no encoding is reachable through the above properties, a default encoding of "UTF-8" will be used.
If the specified encoding is not supported an "unsupported-encoding" error is raised.
If no output is specified in the LSOutput, a "no-output-specified" error is raised.

Parameters: node The node to serialize. destination The destination for the serialized DOM.

Returns: Returns true if node was successfully serialized and false in case the node couldn't be serialized.

writeToString

public String writeToString(Node wnode)
DOM L3 EXPERIMENTAL: Serialize the specified node as described above in the description of LSSerializer. The result of serializing the node is returned as a string. Writing a Document or Entity node produces a serialized form that is well formed XML. Writing other node types produces a fragment of text in a form that is not fully defined by this document, but that should be useful to a human for debugging or diagnostic purposes.

Parameters: wnode The node to be written.

Returns: Returns the serialized data

Throws: DOMException DOMSTRING_SIZE_ERR: The resulting string is too long to fit in a DOMString. LSException SERIALIZE_ERR: Unable to serialize the node. DOM applications should attach a DOMErrorHandler using the parameter "error-handler" to get details on error.

writeToURI

public boolean writeToURI(Node node, String URI)
Serialize the specified node as described above in the general description of the LSSerializer interface. The output is written to the supplied URI.
When writing to a URI, the encoding is found by looking at the encoding information that is reachable through the item to be written (or its owner document) in this order:
  1. Document.inputEncoding,
  2. Document.xmlEncoding.

If no encoding is reachable through the above properties, a default encoding of "UTF-8" will be used.
If the specified encoding is not supported an "unsupported-encoding" error is raised.

Parameters: node The node to serialize. URI The URI to write to.

Returns: Returns true if node was successfully serialized and false in case the node couldn't be serialized.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.