|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xml.serialize.DOMSerializerImpl
Implemenatation of DOM Level 3 org.w3c.ls.DOMSerializer by delegating serialization
calls to XMLSerializer
.
DOMSerializer 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.
Constructor Summary | |
DOMSerializerImpl()
Constructs a new DOMSerializer. |
Method Summary | |
boolean |
canSetParameter(java.lang.String name,
java.lang.Object state)
DOM L3-EXPERIMENTAL: Check if parameter can be set |
org.w3c.dom.DOMConfiguration |
getConfig()
The DOMConfiguration object used by the
DOMSerializer when serializing a DOM node. |
org.w3c.dom.ls.DOMSerializerFilter |
getFilter()
When the application provides a filter, the serializer will call out to the filter before serializing each Node. |
java.lang.String |
getNewLine()
DOM L3 EXPERIMENTAL: The end-of-line sequence of characters to be used in the XML being written out. |
java.lang.Object |
getParameter(java.lang.String name)
DOM L3-EXPERIMENTAL: Getter for boolean and object parameters |
void |
setFilter(org.w3c.dom.ls.DOMSerializerFilter filter)
When the application provides a filter, the serializer will call out to the filter before serializing each Node. |
void |
setNewLine(java.lang.String newLine)
DOM L3 EXPERIMENTAL: The end-of-line sequence of characters to be used in the XML being written out. |
void |
setParameter(java.lang.String name,
java.lang.Object value)
DOM L3-EXPERIMENTAL: Setter for boolean and object parameters |
boolean |
write(org.w3c.dom.Node node,
org.w3c.dom.ls.DOMOutput destination)
Serialize the specified node as described above in the general description of the DOMSerializer interface. |
java.lang.String |
writeToString(org.w3c.dom.Node wnode)
DOM L3 EXPERIMENTAL: Serialize the specified node as described above in the description of DOMSerializer . |
boolean |
writeURI(org.w3c.dom.Node node,
java.lang.String URI)
Serialize the specified node as described above in the general description of the DOMSerializer interface. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DOMSerializerImpl()
XMLSerializer
and
initializes the following fields: fNSBinder, fLocalNSBinder, fSymbolTable,
fEmptySymbol, fXmlSymbol, fXmlnsSymbol, fNamespaceCounter, fFeatures.
Method Detail |
public org.w3c.dom.DOMConfiguration getConfig()
org.w3c.dom.ls.DOMSerializer
DOMConfiguration
object used by the
DOMSerializer
when serializing a DOM node.
DOMConfiguration
objects for
DOMSerializer
adds, or modifies, the following
parameters:
"canonical-form"
true
true
will set the parameter "
format-pretty-print" to false
. false
"discard-default-content"
true
Attr.specified
attribute to decide what attributes
should be discarded. Note that some implementations might use
whatever information available to the implementation (i.e. XML
schema, DTD, the Attr.specified
attribute, and so on) to
determine what attributes and content to discard if this parameter is
set to true
. false
"format-pretty-print"
true
true
will set the parameter "
canonical-form" to false
. false
"ignore-unknown-character-denormalizations"
true
"unknown-character-denormalization"
warning (instead of
raising an error, if this parameter is not set) and ignore any
possible denormalizations caused by these characters. IMO it would
make sense to move this parameter into the DOM Level 3 Core spec, and
the error/warning should be defined there. false
"normalize-characters"
DOMConfiguration
in [DOM Level 3 Core]
. Unlike in the Core, the default value for this parameter is
true
. While DOM implementations are not required to
support fully normalizing the characters in the document according to
the rules defined in [CharModel]
supplemented by the definitions of relevant constructs from Section
2.13 of [XML 1.1], this
parameter must be activated by default if supported. "xml-declaration"
true
Document
, Element
, or Entity
node is serialized, the XML declaration, or text declaration, should
be included. The version (Document.xmlVersion
if the
document is a Level 3 document, and the version is non-null,
otherwise use the value "1.0"), and possibly an encoding (
DOMSerializer.encoding
, or
Document.actualEncoding
or
Document.xmlEncoding
if the document is a Level 3
document) is specified in the serialized XML declaration. false
"xml-declaration-needed"
warning if this will cause
problems (i.e. the serialized data is of an XML version other than [XML 1.0], or an
encoding would be needed to be able to re-parse the serialized data). false
.
getConfig
in interface org.w3c.dom.ls.DOMSerializer
public void setParameter(java.lang.String name, java.lang.Object value) throws org.w3c.dom.DOMException
setParameter
in interface org.w3c.dom.DOMConfiguration
name
- The name of the parameter to set.value
- The new value or null
if the user wishes to
unset the parameter. While the type of the value parameter is
defined as DOMUserData
, the object type must match the
type defined by the definition of the parameter. For example, if
the parameter is "error-handler", the value must be of type
DOMErrorHandler
.
org.w3c.dom.DOMException
public boolean canSetParameter(java.lang.String name, java.lang.Object state)
canSetParameter
in interface org.w3c.dom.DOMConfiguration
name
- The name of the parameter to check.state
- An object. if null
, the returned value is
true
.
true
if the parameter could be successfully set
to the specified value, or false
if the parameter is
not recognized or the requested value is not supported. This does
not change the current value of the parameter itself.public java.lang.Object getParameter(java.lang.String name) throws org.w3c.dom.DOMException
getParameter
in interface org.w3c.dom.DOMConfiguration
name
- The name of the parameter.
null
if no object has been associated or if the
parameter is not supported.
org.w3c.dom.DOMException
public java.lang.String writeToString(org.w3c.dom.Node wnode) throws org.w3c.dom.DOMException
DOMSerializer
. 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.
writeToString
in interface org.w3c.dom.ls.DOMSerializer
wnode
- The node to be written.
null
in case a
failure occured and the failure wasn't canceled by the error
handler.
org.w3c.dom.DOMException
- DOMSTRING_SIZE_ERR: The resulting string is too long to fit in a
DOMString
.public void setNewLine(java.lang.String newLine)
null
null
.
setNewLine
in interface org.w3c.dom.ls.DOMSerializer
public java.lang.String getNewLine()
null
null
.
getNewLine
in interface org.w3c.dom.ls.DOMSerializer
public org.w3c.dom.ls.DOMSerializerFilter getFilter()
getFilter
in interface org.w3c.dom.ls.DOMSerializer
public void setFilter(org.w3c.dom.ls.DOMSerializerFilter filter)
setFilter
in interface org.w3c.dom.ls.DOMSerializer
public boolean write(org.w3c.dom.Node node, org.w3c.dom.ls.DOMOutput destination)
DOMSerializer
interface. The output
is written to the supplied DOMOutput
.
DOMOutput
, the encoding is found by
looking at the encoding information that is reachable through the
DOMOutput
and the item to be written (or its owner
document) in this order:
DOMOutput.encoding
,
Document.actualEncoding
,
Document.xmlEncoding
.
DOMOutput
, a
"no-output-specified" error is raised.
write
in interface org.w3c.dom.ls.DOMSerializer
node
- The node to serialize.destination
- The destination for the serialized DOM.
true
if node
was
successfully serialized and false
in case the node
couldn't be serialized.public boolean writeURI(org.w3c.dom.Node node, java.lang.String URI)
DOMSerializer
interface. The output
is written to the supplied URI.
Document.actualEncoding
,
Document.xmlEncoding
.
writeURI
in interface org.w3c.dom.ls.DOMSerializer
node
- The node to serialize.URI
- The URI to write to.
true
if node
was
successfully serialized and false
in case the node
couldn't be serialized.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |