org.apache.geronimo.system.configuration
Class BaseMarkupSerializer

java.lang.Object
  org.apache.geronimo.system.configuration.BaseMarkupSerializer

Direct Known Subclasses:

XMLSerializer

public abstract class BaseMarkupSerializer
extends Object

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 #init. 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(org.w3c.dom.Element) 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 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.

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.

Author:

Assaf Arkin

See Also:

Serializer, DOMSerializer

Field Summary

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

Constructor Summary

protected

BaseMarkupSerializer(OutputFormat format) Protected constructor can only be used by derived class.

Method Summary

void	attributeDecl(String eName, String aName, String type, String valueDefault, String value)
void	characters(char[] chars, int start, int length)
protected void	characters(String text) Called to print the text contents in the prevailing element format.
void	comment(char[] chars, int start, int length)
void	comment(String text)
protected ElementState	content() Must be called by a method about to print any type of content.
void	elementDecl(String name, String model)
void	endCDATA()
void	endDocument() Called at the end of the document to wrap it up.
void	endDTD()
void	endEntity(String name)
void	endNonEscaping()
void	endPrefixMapping(String prefix)
void	endPreserving()
protected ElementState	enterElementState(String namespaceURI, String localName, String rawName, boolean preserveSpace) Enter a new element state for the specified element.
void	externalEntityDecl(String name, String publicId, String systemId)
protected ElementState	getElementState() Return the state of the current element.
protected abstract String	getEntityRef(int ch) Returns the suitable entity reference for this character value, or null if no such entity exists.
protected String	getPrefix(String namespaceURI) Returns the namespace prefix for the specified URI.
void	ignorableWhitespace(char[] chars, int start, int length)
void	internalEntityDecl(String name, String value)
protected boolean	isDocumentState() 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.
void	notationDecl(String name, String publicId, String systemId)
protected void	prepare()
protected void	printDoctypeURL(String url) Print a document type public or system identifier URL.
protected void	printEscaped(int ch)
protected void	printEscaped(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(String text, boolean preserveSpace, boolean unescaped)
void	processingInstruction(String target, String code)
void	processingInstructionIO(String target, String code)
boolean	reset()
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	serialize(Element elem) Serializes the DOM element using the previously specified writer and output format.
protected abstract void	serializeElement(Element elem) Called to serializee the DOM element.
protected void	serializeNode(Node node) Serialize the DOM node.
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.
void	setDocumentLocator(Locator locator)
void	setOutputByteStream(OutputStream output)
void	setOutputCharStream(Writer writer)
void	setOutputFormat(OutputFormat format)
void	skippedEntity(String name)
void	startCDATA()
void	startDocument()
void	startDTD(String name, String publicId, String systemId)
void	startEntity(String name)
void	startNonEscaping()
void	startPrefixMapping(String prefix, String uri)
void	startPreserving()
void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName)

Methods inherited from class java.lang.Object

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

Field Detail

started

protected boolean started

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

prefixes

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.

docTypePublicId

protected String docTypePublicId

The system identifier of the document type, if known.

docTypeSystemId

protected String docTypeSystemId

The system identifier of the document type, if known.

format

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.

printer

protected Printer printer

The printer used for printing text parts.

indenting

protected boolean indenting

True if indenting printer.

Constructor Detail

BaseMarkupSerializer

protected BaseMarkupSerializer(OutputFormat format)

Protected constructor can only be used by derived class. Must initialize the serializer before serializing any document, see #init.

Method Detail

setOutputByteStream

public void setOutputByteStream(OutputStream output)

setOutputCharStream

public void setOutputCharStream(Writer writer)

setOutputFormat

public void setOutputFormat(OutputFormat format)

reset

public boolean reset()

prepare

protected void prepare()
                throws IOException

Throws:

IOException

serialize

public void serialize(Element elem)
               throws IOException

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

serialize

public void serialize(DocumentFragment frag)
               throws IOException

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:

elem - The element to serialize

Throws:

IOException - An I/O exception occured while serializing

serialize

public void serialize(Document doc)
               throws IOException

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

startDocument

public void startDocument()
                   throws SAXException

Throws:

SAXException

characters

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

Throws:

SAXException

ignorableWhitespace

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

Throws:

SAXException

processingInstruction

public final void processingInstruction(String target,
                                        String code)
                                 throws SAXException

Throws:

SAXException

processingInstructionIO

public void processingInstructionIO(String target,
                                    String code)
                             throws IOException

Throws:

IOException

comment

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

Throws:

SAXException

comment

public void comment(String text)
             throws IOException

Throws:

IOException

startCDATA

public void startCDATA()

endCDATA

public void endCDATA()

startNonEscaping

public void startNonEscaping()

endNonEscaping

public void endNonEscaping()

startPreserving

public void startPreserving()

endPreserving

public void endPreserving()

endDocument

public void endDocument()
                 throws SAXException

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

startEntity

public void startEntity(String name)

endEntity

public void endEntity(String name)

setDocumentLocator

public void setDocumentLocator(Locator locator)

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Throws:

SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Throws:

SAXException

startDTD

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

Throws:

SAXException

endDTD

public void endDTD()

elementDecl

public void elementDecl(String name,
                        String model)
                 throws SAXException

Throws:

SAXException

attributeDecl

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

Throws:

SAXException

internalEntityDecl

public void internalEntityDecl(String name,
                               String value)
                        throws SAXException

Throws:

SAXException

externalEntityDecl

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

Throws:

SAXException

unparsedEntityDecl

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

Throws:

SAXException

notationDecl

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

Throws:

SAXException

serializeNode

protected void serializeNode(Node node)
                      throws IOException

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

Parameters:

node - The node to serialize

Throws:

IOException - An I/O exception occured while serializing

See Also:

serializeElement(org.w3c.dom.Element)

content

protected ElementState content()
                        throws IOException

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 occured while serializing

characters

protected void characters(String text)
                   throws IOException

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

unescaped - True is should print unescaped

Throws:

IOException - An I/O exception occured while serializing

getEntityRef

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

serializeElement

protected abstract void serializeElement(Element elem)
                                  throws IOException

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

serializePreRoot

protected void serializePreRoot()
                         throws IOException

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

printText

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

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

text - The text to print

preserveSpace - Space preserving flag

unescaped - Print unescaped

Throws:

IOException

printText

protected final void printText(String text,
                               boolean preserveSpace,
                               boolean unescaped)
                        throws IOException

Throws:

IOException

printDoctypeURL

protected void printDoctypeURL(String url)
                        throws IOException

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

printEscaped

protected void printEscaped(int ch)
                     throws IOException

Throws:

IOException

printEscaped

protected void printEscaped(String source)
                     throws IOException

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

getElementState

protected ElementState getElementState()

Return the state of the current element.

Returns:

Current element state

enterElementState

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

leaveElementState

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

isDocumentState

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

getPrefix

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