Xerces 3.1.1 API: Class BaseMarkupSerializer

Overview

Package

Class

Tree

Deprecated

Index

Help

Xerces 3.1.1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.xml.serialize
Class BaseMarkupSerializer

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

All Implemented Interfaces:: ContentHandler, DeclHandler, DocumentHandler, DOMSerializer, DTDHandler, LexicalHandler, Serializer

Direct Known Subclasses:: HTMLSerializer, TextSerializer, XMLSerializer

public abstract class BaseMarkupSerializer
extends java.lang.Object
implements ContentHandler, DocumentHandler, LexicalHandler, DTDHandler, DeclHandler, DOMSerializer, Serializer

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.

Version:: $Revision: 1.20 $ $Date: 2000/09/08 01:45:49 $
See Also:: Serializer, DOMSerializer

Field Summary

protected java.lang.String _docTypePublicId
          The system identifier of the document type, if known.

protected java.lang.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 java.util.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

ContentHandler asContentHandler()
          Return a ContentHandler interface into this serializer.

DocumentHandler asDocumentHandler()
          Return a DocumentHandler interface into this serializer.

DOMSerializer asDOMSerializer()
          Return a DOMSerializer interface into this serializer.

void attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String valueDefault, java.lang.String value)
          Report an attribute type declaration.

void characters(char[] chars, int start, int length)
          Receive notification of character data.

protected void characters(java.lang.String text)
          Called to print the text contents in the prevailing element format.

void comment(char[] chars, int start, int length)
          Report an XML comment anywhere in the document.

void comment(java.lang.String text)


protected org.apache.xml.serialize.ElementState content()
          Must be called by a method about to print any type of content.

void elementDecl(java.lang.String name, java.lang.String model)
          Report an element type declaration.

void endCDATA()
          Report the end of a CDATA section.

void endDocument()
          Called at the end of the document to wrap it up.

void endDTD()
          Report the end of DTD declarations.

void endEntity(java.lang.String name)
          Report the end of an entity.

void endNonEscaping()


void endPrefixMapping(java.lang.String prefix)
          End the scope of a prefix-URI mapping.

void endPreserving()


protected org.apache.xml.serialize.ElementState enterElementState(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, boolean preserveSpace)
          Enter a new element state for the specified element.

void externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
          Report a parsed external entity declaration.

protected org.apache.xml.serialize.ElementState getElementState()
          Return the state of the current element.

protected abstract java.lang.String getEntityRef(char ch)
          Returns the suitable entity reference for this character value, or null if no such entity exists.

protected java.lang.String getPrefix(java.lang.String namespaceURI)
          Returns the namespace prefix for the specified URI.

void ignorableWhitespace(char[] chars, int start, int length)
          Receive notification of ignorable whitespace in element content.

void internalEntityDecl(java.lang.String name, java.lang.String value)
          Report an internal entity declaration.

protected boolean isDocumentState()
          Returns true if in the state of the document.

protected org.apache.xml.serialize.ElementState leaveElementState()
          Leave the current element state and return to the state of the parent element.

void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
          Receive notification of a notation declaration event.

protected void prepare()


protected void printDoctypeURL(java.lang.String url)
          Print a document type public or system identifier URL.

protected void printEscaped(char ch)


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)


void processingInstruction(java.lang.String target, java.lang.String code)
          Receive notification of a processing instruction.

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)
          Receive an object for locating the origin of SAX document events.

void setOutputByteStream(java.io.OutputStream output)
          Specifies an output stream to which the document should be serialized.

void setOutputCharStream(java.io.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(java.lang.String name)
          Receive notification of a skipped entity.

void startCDATA()
          Report the start of a CDATA section.

void startDocument()
          Receive notification of the beginning of a document.

void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
          Report the start of DTD declarations, if any.

void startEntity(java.lang.String name)
          Report the beginning of an entity in content.

void startNonEscaping()


void startPrefixMapping(java.lang.String prefix, java.lang.String uri)
          Begin the scope of a prefix-URI Namespace mapping.

void startPreserving()


void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)
          Receive notification of an unparsed entity declaration event.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

endElement, startElement

Methods inherited from interface org.xml.sax.DocumentHandler

endElement, startElement

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 java.util.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 java.lang.String _docTypePublicId

The system identifier of the document type, if known.

_docTypeSystemId

protected java.lang.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