org.apache.xml.serialize
Class XMLSerializer

java.lang.Object
  |
  +--org.apache.xml.serialize.BaseMarkupSerializer
        |
        +--org.apache.xml.serialize.XMLSerializer

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.DocumentHandler, DOMSerializer, org.xml.sax.DTDHandler, org.xml.sax.ext.LexicalHandler, Serializer

public class XMLSerializer

extends BaseMarkupSerializer

Implements an XML serializer supporting both DOM and SAX pretty serializing. For usage instructions see Serializer.

If an output stream is used, the encoding is taken from the output format (defaults to UTF-8). If a writer is used, make sure the writer uses the same encoding (if applies) as specified in the output format.

The serializer supports both DOM and SAX. SAX serializing is done by firing SAX events and using the serializer as a document handler. DOM serializing is done by calling BaseMarkupSerializer.serialize(Document) or by using DOM Level 3 DOMWriter and serializing with DOMWriter.writeNode(java.io.OutputStream, org.w3c.dom.Node), DOMWriter.writeToString(org.w3c.dom.Node).

If an I/O exception occurs while serializing, the serializer will not throw an exception directly, but only throw it at the end of serializing (either DOM or SAX's DocumentHandler.endDocument().

For elements that are not specified as whitespace preserving, the serializer will potentially break long text lines at space boundaries, indent lines, and serialize elements on separate lines. Line terminators will be regarded as spaces, and spaces at beginning of line will be stripped.

Version:

$Revision: 1.45 $ $Date: 2002/09/23 13:17:15 $

Author:

Assaf Arkin, Rahul Srivastava, Elena Litani IBM

See Also:

Serializer

Field Summary

protected static boolean	DEBUG
protected boolean	fDOML1
protected org.apache.xerces.util.NamespaceSupport	fLocalNSBinder stores all namespace bindings on the current element
protected int	fNamespaceCounter
protected boolean	fNamespaces Controls whether namespace fixup should be performed during the serialization.
protected org.apache.xerces.util.NamespaceSupport	fNSBinder stores namespaces in scope
protected org.apache.xerces.util.SymbolTable	fSymbolTable symbol table for serialization
protected static java.lang.String	PREFIX

Fields inherited from class org.apache.xml.serialize.BaseMarkupSerializer

_docTypePublicId, _docTypeSystemId, _encodingInfo, _format, _indenting, _prefixes, _printer, _started, fDOMError, fDOMErrorHandler, fDOMFilter, fFeatures, fStrBuffer

Constructor Summary

XMLSerializer()
Constructs a new serializer.

XMLSerializer(OutputFormat format)
Constructs a new serializer.

XMLSerializer(java.io.OutputStream output, OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format.

XMLSerializer(java.io.Writer writer, OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format.

Method Summary

void	endElement(java.lang.String tagName) Receive notification of the end of an element.
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName) Receive notification of the end of an element.
void	endElementIO(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName)
protected java.lang.String	getEntityRef(int ch) Returns the suitable entity reference for this character value, or null if no such entity exists.
protected void	printEscaped(java.lang.String source) Escapes a string so it may be printed as text content or attribute value.
protected void	printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) Called to print additional text with whitespace handling.
protected void	printText(java.lang.String text, boolean preserveSpace, boolean unescaped)
protected void	printXMLChar(int ch)
boolean	reset()
protected void	serializeElement(org.w3c.dom.Element elem) Called to serialize a DOM element.
void	setNamespaces(boolean namespaces) Deprecated. -- functionality could be removed
void	setOutputFormat(OutputFormat format) Specifies an output format for this serializer.
protected void	startDocument(java.lang.String rootTagName) Called to serialize the document's DOCTYPE by the root element.
void	startElement(java.lang.String tagName, org.xml.sax.AttributeList attrs) Receive notification of the beginning of an element.
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attrs) Receive notification of the beginning of an element.

Methods inherited from class org.apache.xml.serialize.BaseMarkupSerializer

asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, characters, characters, comment, comment, content, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, enterElementState, externalEntityDecl, fatalError, getElementState, getPrefix, ignorableWhitespace, internalEntityDecl, isDocumentState, leaveElementState, modifyDOMError, notationDecl, prepare, printCDATAText, printDoctypeURL, printEscaped, processingInstruction, processingInstructionIO, serialize, serialize, serialize, serializeNode, serializePreRoot, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, surrogates, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

protected static final boolean DEBUG

fNSBinder

protected org.apache.xerces.util.NamespaceSupport fNSBinder

stores namespaces in scope

fLocalNSBinder

protected org.apache.xerces.util.NamespaceSupport fLocalNSBinder

stores all namespace bindings on the current element

fSymbolTable

protected org.apache.xerces.util.SymbolTable fSymbolTable

symbol table for serialization

fDOML1

protected boolean fDOML1

fNamespaceCounter

protected int fNamespaceCounter

PREFIX

protected static final java.lang.String PREFIX

fNamespaces

protected boolean fNamespaces

Controls whether namespace fixup should be performed during the serialization. NOTE: if this field is set to true the following fields need to be initialized: fNSBinder, fLocalNSBinder, fSymbolTable, XMLSymbols.EMPTY_STRING, fXmlSymbol, fXmlnsSymbol, fNamespaceCounter.

Constructor Detail

XMLSerializer

public XMLSerializer()

Constructs a new serializer. The serializer cannot be used without calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) first.

XMLSerializer

public XMLSerializer(OutputFormat format)

Constructs a new serializer. The serializer cannot be used without calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) first.

XMLSerializer

public XMLSerializer(java.io.Writer writer,
                     OutputFormat format)

Constructs a new serializer that writes to the specified writer using the specified output format. If format is null, will use a default output format.

Parameters:

writer - The writer to use

format - The output format to use, null for the default

XMLSerializer

public XMLSerializer(java.io.OutputStream output,
                     OutputFormat format)

Constructs a new serializer that writes to the specified output stream using the specified output format. If format is null, will use a default output format.

Parameters:

output - The output stream to use

format - The output format to use, null for the default

Method Detail

setOutputFormat

public void setOutputFormat(OutputFormat format)

Description copied from interface: Serializer

Specifies an output format for this serializer. It the serializer has already been associated with an output format, it will switch to the new format. This method should not be called while the serializer is in the process of serializing a document.

Overrides:

setOutputFormat in class BaseMarkupSerializer

Following copied from interface: org.apache.xml.serialize.Serializer

Parameters:

format - The output format to use

setNamespaces

public void setNamespaces(boolean namespaces)

Deprecated. -- functionality could be removed

This methods turns on namespace fixup algorithm during DOM serialization.

Parameters:

namespaces -

See Also:

DOMWriter

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName,
                         org.xml.sax.Attributes attrs)
                  throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event.

This event allows up to three name components for each element:

1. the Namespace URI;
2. the local name; and
3. the qualified (prefixed) name.

Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties:

• the Namespace URI and local name are required when the namespaces property is true (the default), and are optional when the namespaces property is false (if one is specified, both must be);
• the qualified name is required when the namespace-prefixes property is true, and is optional when the namespace-prefixes property is false (the default).

Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns* attributes) only if the http://xml.org/sax/features/namespace-prefixes property is true (it is false by default, and support for a true value is optional).

Following copied from interface: org.xml.sax.ContentHandler

Parameters:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The qualified name (with prefix), or the empty string if qualified names are not available.

atts - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Throws:

org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String), Attributes

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String rawName)
                throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.ContentHandler

Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement event for every endElement event (even when the element is empty).

For information on the names, see startElement.

Following copied from interface: org.xml.sax.ContentHandler

Parameters:

uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The qualified XML 1.0 name (with prefix), or the empty string if qualified names are not available.

Throws:

org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.

endElementIO

public void endElementIO(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName)
                  throws java.io.IOException

startElement

public void startElement(java.lang.String tagName,
                         org.xml.sax.AttributeList attrs)
                  throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.DocumentHandler

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.

If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.

Following copied from interface: org.xml.sax.DocumentHandler

Parameters:

name - The element type name.

atts - The attributes attached to the element, if any.

Throws:

org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

DocumentHandler.endElement(java.lang.String), AttributeList

endElement

public void endElement(java.lang.String tagName)
                throws org.xml.sax.SAXException

Description copied from interface: org.xml.sax.DocumentHandler

Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

If the element name has a namespace prefix, the prefix will still be attached to the name.

Following copied from interface: org.xml.sax.DocumentHandler

Parameters:

name - The element type name

Throws:

org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.

startDocument

protected void startDocument(java.lang.String rootTagName)
                      throws java.io.IOException

Called to serialize the document's DOCTYPE by the root element. The document type declaration must name the root element, but the root element is only known when that element is serialized, and not at the start of the document.

This method will check if it has not been called before (BaseMarkupSerializer._started), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see BaseMarkupSerializer.serializePreRoot()). Pre-root will be serialized even if this is not the first root element of the document.

serializeElement

protected void serializeElement(org.w3c.dom.Element elem)
                         throws java.io.IOException

Called to serialize a DOM element. Equivalent to calling startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes), endElement(java.lang.String, java.lang.String, java.lang.String) and serializing everything inbetween, but better optimized.

Overrides:

serializeElement in class BaseMarkupSerializer

Following copied from class: org.apache.xml.serialize.BaseMarkupSerializer

Parameters:

elem - The element to serialize

Throws:

java.io.IOException - An I/O exception occured while serializing

getEntityRef

protected java.lang.String getEntityRef(int ch)

Description copied from class: BaseMarkupSerializer

Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&".

Overrides:

getEntityRef in class BaseMarkupSerializer

Following copied from class: org.apache.xml.serialize.BaseMarkupSerializer

Parameters:

ch - Character value

Returns:

Character entity name, or null

printEscaped

protected void printEscaped(java.lang.String source)
                     throws java.io.IOException

Description copied from class: BaseMarkupSerializer

Escapes a string so it may be printed as text content or attribute value. Non printable characters are escaped using character references. Where the format specifies a deault entity reference, that reference is used (e.g. <).

Overrides:

printEscaped in class BaseMarkupSerializer

Following copied from class: org.apache.xml.serialize.BaseMarkupSerializer

Parameters:

source - The string to escape

printXMLChar

protected final void printXMLChar(int ch)
                           throws java.io.IOException

printText

protected void printText(java.lang.String text,
                         boolean preserveSpace,
                         boolean unescaped)
                  throws java.io.IOException

Overrides:

printText in class BaseMarkupSerializer

printText

protected void printText(char[] chars,
                         int start,
                         int length,
                         boolean preserveSpace,
                         boolean unescaped)
                  throws java.io.IOException

Description copied from class: BaseMarkupSerializer

Called to print additional text with whitespace handling. If spaces are preserved, the text is printed as if by calling BaseMarkupSerializer.printText(String,boolean,boolean) with a call to Printer.breakLine() for each new line. If spaces are not preserved, the text is broken at space boundaries if longer than the line width; Multiple spaces are printed as such, but spaces at beginning of line are removed.

Overrides:

printText in class BaseMarkupSerializer

Following copied from class: org.apache.xml.serialize.BaseMarkupSerializer

Parameters:

text - The text to print

preserveSpace - Space preserving flag

unescaped - Print unescaped

reset

public boolean reset()

Overrides:

reset in class BaseMarkupSerializer