public abstract class

BaseMarkupSerializer

extends Object
implements DOMSerializer Serializer ContentHandler DTDHandler DocumentHandler DeclHandler LexicalHandler
java.lang.Object
   ↳ org.apache.xml.serialize.BaseMarkupSerializer
Known Direct Subclasses
Known Indirect Subclasses

This class is deprecated.
This class was deprecated in Xerces 2.9.0. It is recommended that new applications use the DOM Level 3 LSSerializer or JAXP's Transformation API for XML (TrAX) for serializing XML. See the Xerces documentation for more information.

Class Overview

Base class for a serializer supporting both DOM and SAX pretty serializing of XML/HTML/XHTML documents. Derives classes perform the method-specific serializing, this class provides the common serializing mechanisms.

The serializer must be initialized with the proper writer and output format before it can be used by calling setOutputCharStream(Writer) or setOutputByteStream(OutputStream) for the writer and setOutputFormat(OutputFormat) for the output format.

The serializer can be reused any number of times, but cannot be used concurrently by two threads.

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. DOM serializing is done by calling serialize(Document) and SAX serializing is done by firing SAX events and using the serializer as a document handler. This also applies to derived class.

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 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.

When indenting, the serializer is capable of detecting seemingly element content, and serializing these elements indented on separate lines. An element is serialized indented when it is the first or last child of an element, or immediate following or preceding another element.

See Also

Summary

Fields
protected String _docTypePublicId The system identifier of the document type, if known.
protected String _docTypeSystemId The system identifier of the document type, if known.
protected EncodingInfo _encodingInfo
protected OutputFormat _format The output format associated with this serializer.
protected boolean _indenting True if indenting printer.
protected Hashtable _prefixes Association between namespace URIs (keys) and prefixes (values).
protected Printer _printer The printer used for printing text parts.
protected boolean _started If the document has been started (header serialized), this flag is set to true so it's not started twice.
protected Node fCurrentNode Current node that is being processed
protected final DOMErrorImpl fDOMError
protected DOMErrorHandler fDOMErrorHandler
protected LSSerializerFilter fDOMFilter
protected final StringBuffer fStrBuffer Temporary buffer to store character data
protected short features
Protected Constructors
BaseMarkupSerializer(OutputFormat format)
Protected constructor can only be used by derived class.
Public Methods
ContentHandler asContentHandler()
Return a ContentHandler interface into this serializer.
DOMSerializer asDOMSerializer()
Return a DOMSerializer interface into this serializer.
DocumentHandler asDocumentHandler()
Return a DocumentHandler interface into this serializer.
void attributeDecl(String eName, String aName, String type, String valueDefault, String value)
void characters(char[] chars, int start, int length)
void comment(char[] chars, int start, int length)
void comment(String text)
void elementDecl(String name, String model)
void endCDATA()
void endDTD()
void endDocument()
Called at the end of the document to wrap it up.
void endEntity(String name)
void endNonEscaping()
void endPrefixMapping(String prefix)
void endPreserving()
void externalEntityDecl(String name, String publicId, String systemId)
void ignorableWhitespace(char[] chars, int start, int length)
void internalEntityDecl(String name, String value)
void notationDecl(String name, String publicId, String systemId)
final void processingInstruction(String target, String code)
void processingInstructionIO(String target, String code)
boolean reset()
void serialize(Element elem)
Serializes the DOM element using the previously specified writer and output format.
void serialize(Document doc)
Serializes the DOM document using the previously specified writer and output format.
void serialize(DocumentFragment frag)
Serializes the DOM document fragmnt using the previously specified writer and output format.
void setDocumentLocator(Locator locator)
void setOutputByteStream(OutputStream output)
Specifies an output stream to which the document should be serialized.
void setOutputCharStream(Writer writer)
Specifies a writer to which the document should be serialized.
void setOutputFormat(OutputFormat format)
Specifies an output format for this serializer.
void skippedEntity(String name)
void startCDATA()
final void startDTD(String name, String publicId, String systemId)
void startDocument()
void startEntity(String name)
void startNonEscaping()
void startPrefixMapping(String prefix, String uri)
void startPreserving()
void unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
Protected Methods
void characters(String text)
Called to print the text contents in the prevailing element format.
void checkUnboundNamespacePrefixedNode(Node node)
DOM level 3: Check a node to determine if it contains unbound namespace prefixes.
ElementState content()
Must be called by a method about to print any type of content.
ElementState enterElementState(String namespaceURI, String localName, String rawName, boolean preserveSpace)
Enter a new element state for the specified element.
void fatalError(String message)
ElementState getElementState()
Return the state of the current element.
abstract String getEntityRef(int ch)
Returns the suitable entity reference for this character value, or null if no such entity exists.
String getPrefix(String namespaceURI)
Returns the namespace prefix for the specified URI.
boolean isDocumentState()
Returns true if in the state of the document.
ElementState leaveElementState()
Leave the current element state and return to the state of the parent element.
DOMError modifyDOMError(String message, short severity, String type, Node node)
The method modifies global DOM error object
void prepare()
void printCDATAText(String text)
void printDoctypeURL(String url)
Print a document type public or system identifier URL.
void printEscaped(int ch)
void printEscaped(String source)
Escapes a string so it may be printed as text content or attribute value.
void printText(String text, boolean preserveSpace, boolean unescaped)
void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped)
Called to print additional text with whitespace handling.
abstract void serializeElement(Element elem)
Called to serializee the DOM element.
void serializeNode(Node node)
Serialize the DOM node.
void serializePreRoot()
Comments and PIs cannot be serialized before the root element, because the root element serializes the document type, which generally comes first.
void surrogates(int high, int low, boolean inContent)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.xml.serialize.DOMSerializer
From interface org.apache.xml.serialize.Serializer
From interface org.xml.sax.ContentHandler
From interface org.xml.sax.DTDHandler
From interface org.xml.sax.DocumentHandler
From interface org.xml.sax.ext.DeclHandler
From interface org.xml.sax.ext.LexicalHandler

Fields

protected String _docTypePublicId

The system identifier of the document type, if known.

protected String _docTypeSystemId

The system identifier of the document type, if known.

protected EncodingInfo _encodingInfo

protected OutputFormat _format

The output format associated with this serializer. This will never be a null reference. If no format was passed to the constructor, the default one for this document type will be used. The format object is never changed by the serializer.

protected boolean _indenting

True if indenting printer.

protected Hashtable _prefixes

Association between namespace URIs (keys) and prefixes (values). Accumulated here prior to starting an element and placing this list in the element state.

protected Printer _printer

The printer used for printing text parts.

protected boolean _started

If the document has been started (header serialized), this flag is set to true so it's not started twice.

protected Node fCurrentNode

Current node that is being processed

protected final DOMErrorImpl fDOMError

protected DOMErrorHandler fDOMErrorHandler

protected LSSerializerFilter fDOMFilter

protected final StringBuffer fStrBuffer

Temporary buffer to store character data

protected short features

Protected Constructors

protected BaseMarkupSerializer (OutputFormat format)

Protected constructor can only be used by derived class. Must initialize the serializer before serializing any document, by calling setOutputCharStream(Writer) or setOutputByteStream(OutputStream) first

Public Methods

public ContentHandler asContentHandler ()

Return a ContentHandler interface into this serializer. If the serializer does not support the ContentHandler interface, it should return null.

Throws
IOException

public DOMSerializer asDOMSerializer ()

Return a DOMSerializer interface into this serializer. If the serializer does not support the DOMSerializer interface, it should return null.

Throws
IOException

public DocumentHandler asDocumentHandler ()

Return a DocumentHandler interface into this serializer. If the serializer does not support the DocumentHandler interface, it should return null.

Throws
IOException

public void attributeDecl (String eName, String aName, String type, String valueDefault, String value)

Throws
SAXException

public void characters (char[] chars, int start, int length)

Throws
SAXException

public void comment (char[] chars, int start, int length)

Throws
SAXException

public void comment (String text)

Throws
IOException

public void elementDecl (String name, String model)

Throws
SAXException

public void endCDATA ()

public void endDTD ()

public void endDocument ()

Called at the end of the document to wrap it up. Will flush the output stream and throw an exception if any I/O error occured while serializing.

Throws
SAXException An I/O exception occured during serializing

public void endEntity (String name)

public void endNonEscaping ()

public void endPrefixMapping (String prefix)

Throws
SAXException

public void endPreserving ()

public void externalEntityDecl (String name, String publicId, String systemId)

Throws
SAXException

public void ignorableWhitespace (char[] chars, int start, int length)

Throws
SAXException

public void internalEntityDecl (String name, String value)

Throws
SAXException

public void notationDecl (String name, String publicId, String systemId)

Throws
SAXException

public final void processingInstruction (String target, String code)

Throws
SAXException

public void processingInstructionIO (String target, String code)

Throws
IOException

public boolean reset ()

public void serialize (Element elem)

Serializes the DOM element using the previously specified writer and output format. Throws an exception only if an I/O exception occured while serializing.

Parameters
elem The element to serialize
Throws
IOException An I/O exception occured while serializing

public void serialize (Document doc)

Serializes the DOM document using the previously specified writer and output format. Throws an exception only if an I/O exception occured while serializing.

Parameters
doc The document to serialize
Throws
IOException An I/O exception occured while serializing

public void serialize (DocumentFragment frag)

Serializes the DOM document fragmnt using the previously specified writer and output format. Throws an exception only if an I/O exception occured while serializing.

Parameters
frag The document fragment to serialize
Throws
IOException An I/O exception occured while serializing

public void setDocumentLocator (Locator locator)

public void setOutputByteStream (OutputStream output)

Specifies an output stream to which the document should be serialized. This method should not be called while the serializer is in the process of serializing a document.

public void setOutputCharStream (Writer writer)

Specifies a writer to which the document should be serialized. This method should not be called while the serializer is in the process of serializing a document.

public void setOutputFormat (OutputFormat format)

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.

Parameters
format The output format to use

public void skippedEntity (String name)

Throws
SAXException

public void startCDATA ()

public final void startDTD (String name, String publicId, String systemId)

Throws
SAXException

public void startDocument ()

Throws
SAXException

public void startEntity (String name)

public void startNonEscaping ()

public void startPrefixMapping (String prefix, String uri)

Throws
SAXException

public void startPreserving ()

public void unparsedEntityDecl (String name, String publicId, String systemId, String notationName)

Throws
SAXException

Protected Methods

protected void characters (String text)

Called to print the text contents in the prevailing element format. Since this method is capable of printing text as CDATA, it is used for that purpose as well. White space handling is determined by the current element state. In addition, the output format can dictate whether the text is printed as CDATA or unescaped.

Parameters
text The text to print
Throws
IOException An I/O exception occured while serializing

protected void checkUnboundNamespacePrefixedNode (Node node)

DOM level 3: Check a node to determine if it contains unbound namespace prefixes.

Parameters
node The node to check for unbound namespace prefices
Throws
IOException

protected ElementState content ()

Must be called by a method about to print any type of content. If the element was just opened, the opening tag is closed and will be matched to a closing tag. Returns the current element state with empty and afterElement set to false.

Returns
  • The current element state
Throws
IOException An I/O exception occurred while serializing

protected ElementState enterElementState (String namespaceURI, String localName, String rawName, boolean preserveSpace)

Enter a new element state for the specified element. Tag name and space preserving is specified, element state is initially empty.

Returns
  • Current element state, or null

protected void fatalError (String message)

Throws
IOException

protected ElementState getElementState ()

Return the state of the current element.

Returns
  • Current element state

protected abstract String getEntityRef (int ch)

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

Parameters
ch Character value
Returns
  • Character entity name, or null

protected String getPrefix (String namespaceURI)

Returns the namespace prefix for the specified URI. If the URI has been mapped to a prefix, returns the prefix, otherwise returns null.

Parameters
namespaceURI The namespace URI
Returns
  • The namespace prefix if known, or null

protected boolean isDocumentState ()

Returns true if in the state of the document. Returns true before entering any element and after leaving the root element.

Returns
  • True if in the state of the document

protected ElementState leaveElementState ()

Leave the current element state and return to the state of the parent element. If this was the root element, return to the state of the document.

Returns
  • Previous element state

protected DOMError modifyDOMError (String message, short severity, String type, Node node)

The method modifies global DOM error object

Returns
  • a DOMError

protected void prepare ()

Throws
IOException

protected void printCDATAText (String text)

Throws
IOException

protected void printDoctypeURL (String url)

Print a document type public or system identifier URL. Encapsulates the URL in double quotes, escapes non-printing characters and print it equivalent to printText(char[], int, int, boolean, boolean).

Parameters
url The document type url to print
Throws
IOException

protected void printEscaped (int ch)

Throws
IOException

protected void printEscaped (String source)

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. <).

Parameters
source The string to escape
Throws
IOException

protected void printText (String text, boolean preserveSpace, boolean unescaped)

Throws
IOException

protected void printText (char[] chars, int start, int length, boolean preserveSpace, boolean unescaped)

Called to print additional text with whitespace handling. If spaces are preserved, the text is printed as if by calling printText(String, boolean, boolean) with a call to 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.

Parameters
chars The text to print
start The start offset
length The number of characters
preserveSpace Space preserving flag
unescaped Print unescaped
Throws
IOException

protected abstract void serializeElement (Element elem)

Called to serializee the DOM element. The element is serialized based on the serializer's method (XML, HTML, XHTML).

Parameters
elem The element to serialize
Throws
IOException An I/O exception occured while serializing

protected void serializeNode (Node node)

Serialize the DOM node. This method is shared across XML, HTML and XHTML serializers and the differences are masked out in a separate serializeElement(Element).

Parameters
node The node to serialize
Throws
IOException An I/O exception occured while serializing

protected void serializePreRoot ()

Comments and PIs cannot be serialized before the root element, because the root element serializes the document type, which generally comes first. Instead such PIs and comments are accumulated inside a vector and serialized by calling this method. Will be called when the root element is serialized and when the document finished serializing.

Throws
IOException An I/O exception occured while serializing

protected void surrogates (int high, int low, boolean inContent)

Throws
IOException