org.apache.xml.serialize
Class TextSerializer

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

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 TextSerializer

extends BaseMarkupSerializer

Implements a text serializer supporting both DOM and SAX 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. DOM serializing is done by calling BaseMarkupSerializer.serialize(org.w3c.dom.Element) and SAX serializing is done by firing SAX events and using the serializer as a document handler.

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

Version:

$Revision: 1.14 $ $Date: 2004/02/24 23:34:03 $

Author:

Assaf Arkin

See Also:

Serializer

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

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

Constructor Summary

TextSerializer()
Constructs a new serializer.

Method Summary

void	characters(char[] chars, int start, int length)
protected void	characters(java.lang.String text, boolean unescaped)
void	comment(char[] chars, int start, int length)
void	comment(java.lang.String text)
protected ElementState	content() Must be called by a method about to print any type of content.
void	endElement(java.lang.String tagName)
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName)
void	endElementIO(java.lang.String tagName)
protected java.lang.String	getEntityRef(int ch) Returns the suitable entity reference for this character value, or null if no such entity exists.
void	processingInstructionIO(java.lang.String target, java.lang.String code)
protected void	serializeElement(org.w3c.dom.Element elem) Called to serialize a DOM element.
protected void	serializeNode(org.w3c.dom.Node node) Serialize the DOM node.
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)
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attrs)

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

asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, characters, checkUnboundNamespacePrefixedNode, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, enterElementState, externalEntityDecl, fatalError, getElementState, getPrefix, ignorableWhitespace, internalEntityDecl, isDocumentState, leaveElementState, modifyDOMError, notationDecl, prepare, printCDATAText, printDoctypeURL, printEscaped, printEscaped, printText, printText, processingInstruction, reset, serialize, serialize, serialize, 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

Constructor Detail

TextSerializer

public TextSerializer()

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

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

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

endElement

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

startElement

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

endElement

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

endElementIO

public void endElementIO(java.lang.String tagName)
                  throws java.io.IOException

processingInstructionIO

public void processingInstructionIO(java.lang.String target,
                                    java.lang.String code)
                             throws java.io.IOException

Overrides:

processingInstructionIO in class BaseMarkupSerializer

comment

public void comment(java.lang.String text)

Overrides:

comment in class BaseMarkupSerializer

comment

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

Overrides:

comment in class BaseMarkupSerializer

characters

public void characters(char[] chars,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Overrides:

characters in class BaseMarkupSerializer

characters

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

startDocument

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

Called to serialize the document's DOCTYPE by the root element.

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

serializeNode

protected void serializeNode(org.w3c.dom.Node node)
                      throws java.io.IOException

Serialize the DOM node. This method is unique to the Text serializer.

Overrides:

serializeNode in class BaseMarkupSerializer

Parameters:

node - The node to serialize

content

protected ElementState content()

Description copied from class: BaseMarkupSerializer

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.

Overrides:

content in class BaseMarkupSerializer

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

Returns:

The current element state

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