org.apache.xml.serialize
Class BaseMarkupSerializer

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

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:

Author:

Assaf Arkin

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 java.io.IOException	_exception Holds the exception thrown by the serializer.
protected OutputFormat	_format The output format associated with this serializer.
protected java.util.Hashtable	_prefixes Association between namespace URIs (keys) and prefixes (values).
protected boolean	_started If the document has been started (header serialized), this flag is set to true so it's not started twice.
protected java.io.Writer	_writer The writer to which the document is written.

Constructor Summary

protected

BaseMarkupSerializer() 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.
protected void	breakLine() Called to print a line consisting of the text accumulated so far.
protected void	breakLine(boolean preserveSpace)
void	characters(char[] chars, int start, int length) Receive notification of character data.
protected void	characters(java.lang.String text, boolean unescaped) 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	endPrefixMapping(java.lang.String prefix) End the scope of a prefix-URI mapping.
protected void	enterDTD() Called by any of the DTD handlers to enter DTD mode.
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.
protected java.lang.String	escape(java.lang.String source) Escapes a string so it may be printed as text content or attribute value.
void	externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Report a parsed external entity declaration.
void	flush() Flush the output stream.
protected org.apache.xml.serialize.ElementState	getElementState() Return the state of the current element, or null if not within any element (e.g.
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)
void	ignorableWhitespace(char[] chars, int start, int length) Receive notification of ignorable whitespace in element content.
protected void	indent() Increment the indentation for the next line.
void	internalEntityDecl(java.lang.String name, java.lang.String value) Report an internal entity declaration.
protected java.lang.String	leaveDTD() Called by the root element to leave DTD mode and if any DTD parts were printer, will return a string with their textual content.
protected org.apache.xml.serialize.ElementState	leaveElementState() Leave the current element state and return to the state of the parent element, or no state if this is the root element.
void	notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Receive notification of a notation declaration event.
protected void	printDoctypeURL(java.lang.String url) Print a document type public or system identifier URL.
protected void	printSpace() Called to print a single space between text parts that may be broken into separate lines.
protected void	printText(char[] chars, int start, int end)
protected void	printText(java.lang.String text) Called to print additional text.
protected void	printText(java.lang.String text, boolean preserveSpace) Called to print additional text with whitespace handling.
protected void	printText(java.lang.StringBuffer text, boolean preserveSpace)
void	processingInstruction(java.lang.String target, java.lang.String code) Receive notification of a processing instruction.
protected void	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 output) 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	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.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Begin the scope of a prefix-URI Namespace mapping.
protected void	unindent() Decrement the indentation for the next line.
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

Field Detail

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

_writer

protected java.io.Writer _writer

The writer to which the document is written.

_exception

protected java.io.IOException _exception

Holds the exception thrown by the serializer. Exceptions do not cause the serializer to quit, but are held and one is thrown at the end.

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

Constructor Detail

BaseMarkupSerializer

protected BaseMarkupSerializer()

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

Method Detail

asDocumentHandler

public DocumentHandler asDocumentHandler()

Description copied from interface: Serializer

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

Specified by:

asDocumentHandler in interface Serializer

asContentHandler

public ContentHandler asContentHandler()

Description copied from interface: Serializer

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

Specified by:

asContentHandler in interface Serializer

asDOMSerializer

public DOMSerializer asDOMSerializer()

Description copied from interface: Serializer

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

Specified by:

asDOMSerializer in interface Serializer

setOutputByteStream

public void setOutputByteStream(java.io.OutputStream output)
                         throws java.io.UnsupportedEncodingException

Description copied from interface: Serializer

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.

Specified by:

setOutputByteStream in interface Serializer

setOutputCharStream

public void setOutputCharStream(java.io.Writer output)

Description copied from interface: Serializer

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.

Specified by:

setOutputCharStream in interface Serializer

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.

Specified by:

setOutputFormat in interface Serializer

Tags copied from interface: Serializer

Parameters:

format - The output format to use

reset

protected void reset()

serialize

public void serialize(Element elem)
               throws java.io.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.

Specified by:

serialize in interface DOMSerializer

Parameters:

elem - The element to serialize

Throws:

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

serialize

public void serialize(DocumentFragment frag)
               throws java.io.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.

Specified by:

serialize in interface DOMSerializer

Parameters:

elem - The element to serialize

Throws:

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

serialize

public void serialize(Document doc)
               throws java.io.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.

Specified by:

serialize in interface DOMSerializer

Parameters:

doc - The document to serialize

Throws:

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

characters

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

Description copied from interface: ContentHandler

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).

Specified by:

characters in interface ContentHandler

Tags copied from interface: ContentHandler

Parameters:

ch - The characters from the XML document.

start - The start position in the array.

length - The number of characters to read from the array.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

ContentHandler.ignorableWhitespace(char[], int, int), Locator

ignorableWhitespace

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

Description copied from interface: ContentHandler

Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Specified by:

ignorableWhitespace in interface ContentHandler

Tags copied from interface: ContentHandler

Parameters:

ch - The characters from the XML document.

start - The start position in the array.

length - The number of characters to read from the array.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

ContentHandler.characters(char[], int, int)

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String code)

Description copied from interface: ContentHandler

Receive notification of a processing instruction.

The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

Specified by:

processingInstruction in interface ContentHandler

Tags copied from interface: ContentHandler

Parameters:

target - The processing instruction target.

data - The processing instruction data, or null if none was supplied.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

comment

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

Description copied from interface: LexicalHandler

Report an XML comment anywhere in the document.

This callback will be used for comments inside or outside the document element, including comments in the external DTD subset (if read).

Specified by:

comment in interface LexicalHandler

Tags copied from interface: LexicalHandler

Parameters:

ch - An array holding the characters in the comment.

start - The starting position in the array.

length - The number of characters to use from the array.

Throws:

SAXException - The application may raise an exception.

comment

public void comment(java.lang.String text)

startCDATA

public void startCDATA()

Description copied from interface: LexicalHandler

Report the start of a CDATA section.

The contents of the CDATA section will be reported through the regular characters event.

Specified by:

startCDATA in interface LexicalHandler

Tags copied from interface: LexicalHandler

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.endCDATA()

endCDATA

public void endCDATA()

Description copied from interface: LexicalHandler

Report the end of a CDATA section.

Specified by:

endCDATA in interface LexicalHandler

Tags copied from interface: LexicalHandler

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.startCDATA()

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.

Specified by:

endDocument in interface ContentHandler

Throws:

SAXException - An I/O exception occured during serializing

startEntity

public void startEntity(java.lang.String name)

Description copied from interface: LexicalHandler

Report the beginning of an entity.

The start and end of the document entity are not reported. The start and end of the external DTD subset are reported using the pseudo-name "[dtd]". All other events must be properly nested within start/end entity events.

Note that skipped entities will be reported through the skippedEntity event, which is part of the ContentHandler interface.

Specified by:

startEntity in interface LexicalHandler

Tags copied from interface: LexicalHandler

Parameters:

name - The name of the entity. If it is a parameter entity, the name will begin with '%'.

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.endEntity(java.lang.String), DeclHandler.internalEntityDecl(java.lang.String, java.lang.String), DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)

endEntity

public void endEntity(java.lang.String name)

Description copied from interface: LexicalHandler

Report the end of an entity.

Specified by:

endEntity in interface LexicalHandler

Tags copied from interface: LexicalHandler

Parameters:

name - The name of the entity that is ending.

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.startEntity(java.lang.String)

setDocumentLocator

public void setDocumentLocator(Locator locator)

Description copied from interface: ContentHandler

Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the DocumentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.

Specified by:

setDocumentLocator in interface ContentHandler

Tags copied from interface: ContentHandler

Parameters:

locator - An object that can return the location of any SAX document event.

See Also:

Locator

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws SAXException

Description copied from interface: ContentHandler

Receive notification of a skipped entity.

The Parser will invoke this method once for each entity skipped. Non-validating processors may skip entities if they have not seen the declarations (because, for example, the entity was declared in an external DTD subset). All processors may skip external entities, depending on the values of the http://xml.org/sax/features/external-general-entities and the http://xml.org/sax/features/external-parameter-entities properties.

Specified by:

skippedEntity in interface ContentHandler

Tags copied from interface: ContentHandler

Parameters:

name - The name of the skipped entity. If it is a parameter entity, the name will begin with '%'.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws SAXException

Description copied from interface: ContentHandler

Begin the scope of a prefix-URI Namespace mapping.

The information from this event is not necessary for normal Namespace processing: the SAX XML reader will automatically replace prefixes for element and attribute names when the http://xml.org/sax/features/namespaces feature is true (the default).

There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary.

Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each-other: all startPrefixMapping events will occur before the corresponding startElement event, and all endPrefixMapping events will occur after the corresponding endElement event, but their order is not guaranteed.

Specified by:

startPrefixMapping in interface ContentHandler

Tags copied from interface: ContentHandler

Parameters:

prefix - The Namespace prefix being declared.

uri - The Namespace URI the prefix is mapped to.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

ContentHandler.endPrefixMapping(java.lang.String), ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws SAXException

Description copied from interface: ContentHandler

End the scope of a prefix-URI mapping.

See startPrefixMapping for details. This event will always occur after the corresponding endElement event, but the order of endPrefixMapping events is not otherwise guaranteed.

Specified by:

endPrefixMapping in interface ContentHandler

Tags copied from interface: ContentHandler

Parameters:

prefix - The prefix that was being mapping.

Throws:

SAXException - The client may throw an exception during processing.

See Also:

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

startDTD

public void startDTD(java.lang.String name,
                     java.lang.String publicId,
                     java.lang.String systemId)

Description copied from interface: LexicalHandler

Report the start of DTD declarations, if any.

Any declarations are assumed to be in the internal subset unless otherwise indicated by a startEntity event.

Specified by:

startDTD in interface LexicalHandler

Tags copied from interface: LexicalHandler

Parameters:

name - The document type name.

publicId - The declared public identifier for the external DTD subset, or null if none was declared.

systemId - The declared system identifier for the external DTD subset, or null if none was declared.

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.endDTD(), LexicalHandler.startEntity(java.lang.String)

endDTD

public void endDTD()

Description copied from interface: LexicalHandler

Report the end of DTD declarations.

Specified by:

endDTD in interface LexicalHandler

Tags copied from interface: LexicalHandler

Throws:

SAXException - The application may raise an exception.

See Also:

LexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)

elementDecl

public void elementDecl(java.lang.String name,
                        java.lang.String model)

Description copied from interface: DeclHandler

Report an element type declaration.

The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all whitespace is removed,and will include the enclosing parentheses.

Specified by:

elementDecl in interface DeclHandler

Tags copied from interface: DeclHandler

Parameters:

name - The element type name.

model - The content model as a normalized string.

Throws:

SAXException - The application may raise an exception.

attributeDecl

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

Description copied from interface: DeclHandler

Report an attribute type declaration.

Only the effective (first) declaration for an attribute will be reported. The type will be one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION", or a parenthesized token group with the separator "|" and all whitespace removed.

Specified by:

attributeDecl in interface DeclHandler

Tags copied from interface: DeclHandler

Parameters:

eName - The name of the associated element.

aName - The name of the attribute.

type - A string representing the attribute type.

valueDefault - A string representing the attribute default ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if none of these applies.

value - A string representing the attribute's default value, or null if there is none.

Throws:

SAXException - The application may raise an exception.

internalEntityDecl

public void internalEntityDecl(java.lang.String name,
                               java.lang.String value)

Description copied from interface: DeclHandler

Report an internal entity declaration.

Only the effective (first) declaration for each entity will be reported.

Specified by:

internalEntityDecl in interface DeclHandler

Tags copied from interface: DeclHandler

Parameters:

name - The name of the entity. If it is a parameter entity, the name will begin with '%'.

value - The replacement text of the entity.

Throws:

SAXException - The application may raise an exception.

See Also:

DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String), DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

externalEntityDecl

public void externalEntityDecl(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId)

Description copied from interface: DeclHandler

Report a parsed external entity declaration.

Only the effective (first) declaration for each entity will be reported.

Specified by:

externalEntityDecl in interface DeclHandler

Tags copied from interface: DeclHandler

Parameters:

name - The name of the entity. If it is a parameter entity, the name will begin with '%'.

publicId - The declared public identifier of the entity, or null if none was declared.

systemId - The declared system identifier of the entity.

Throws:

SAXException - The application may raise an exception.

See Also:

DeclHandler.internalEntityDecl(java.lang.String, java.lang.String), DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

unparsedEntityDecl

public void unparsedEntityDecl(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId,
                               java.lang.String notationName)

Description copied from interface: DTDHandler

Receive notification of an unparsed entity declaration event.

Note that the notation name corresponds to a notation reported by the notationDecl() event. It is up to the application to record the entity for later reference, if necessary.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application.

Specified by:

unparsedEntityDecl in interface DTDHandler

Tags copied from interface: DTDHandler

Parameters:

name - The unparsed entity's name.

publicId - The entity's public identifier, or null if none was given.

systemId - The entity's system identifier (it must always have one).

notation - name The name of the associated notation.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String), AttributeList

notationDecl

public void notationDecl(java.lang.String name,
                         java.lang.String publicId,
                         java.lang.String systemId)

Description copied from interface: DTDHandler

Receive notification of a notation declaration event.

It is up to the application to record the notation for later reference, if necessary.

If a system identifier is present, and it is a URL, the SAX parser must resolve it fully before passing it to the application.

Specified by:

notationDecl in interface DTDHandler

Tags copied from interface: DTDHandler

Parameters:

name - The notation name.

publicId - The notation's public identifier, or null if none was given.

systemId - The notation's system identifier, or null if none was given.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String), AttributeList

enterDTD

protected void enterDTD()

Called by any of the DTD handlers to enter DTD mode. Once entered, all output will be accumulated in a string that can be printed as part of the document's DTD. This method may be called any number of time but will only have affect the first time it's called. To exist DTD state and get the accumulated DTD, call leaveDTD().

leaveDTD

protected java.lang.String leaveDTD()

Called by the root element to leave DTD mode and if any DTD parts were printer, will return a string with their textual content.

serializeNode

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

Parameters:

node - The node to serialize

See Also:

serializeElement(org.w3c.dom.Element)

content

protected org.apache.xml.serialize.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

characters

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

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

getEntityRef

protected abstract java.lang.String getEntityRef(char 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)

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

serializePreRoot

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.

printText

protected final void printText(java.lang.String text)

Called to print additional text. Each time this method is called it accumulates more text. When a space is printed (printSpace()) all the accumulated text becomes one part and is added to the accumulate line. When a line is long enough, it can be broken at its text boundary.

Parameters:

text - The text to print

printText

protected final void printText(char[] chars,
                               int start,
                               int end)

printText

protected final void printText(java.lang.String text,
                               boolean preserveSpace)

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

printText

protected final void printText(java.lang.StringBuffer text,
                               boolean preserveSpace)

printSpace

protected final void printSpace()

Called to print a single space between text parts that may be broken into separate lines. Must not be called to print a space when preserving spaces. The text accumulated so far with printText(java.lang.String) will be added to the accumulated line, and a space separator will be counted. If the line accumulated so far is long enough, it will be printed.

breakLine

protected final void breakLine()

Called to print a line consisting of the text accumulated so far. This is equivalent to calling printSpace() but forcing the line to print and starting a new line (printSpace() will only start a new line if the current line is long enough).

breakLine

protected final void breakLine(boolean preserveSpace)

flush

public void flush()

Flush the output stream. Must be called when done printing the document, otherwise some text might be buffered.

indent

protected void indent()

Increment the indentation for the next line.

unindent

protected void unindent()

Decrement the indentation for the next line.

printDoctypeURL

protected void printDoctypeURL(java.lang.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(java.lang.String).

Parameters:

url - The document type url to print

escape

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

Returns:

The escaped string

getElementState

protected org.apache.xml.serialize.ElementState getElementState()

Return the state of the current element, or null if not within any element (e.g. before entering root element).

Returns:

Current element state, or null

enterElementState

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. Tag name and space preserving is specified, element state is initially empty.

Returns:

Current element state, or null

leaveElementState

protected org.apache.xml.serialize.ElementState leaveElementState()

Leave the current element state and return to the state of the parent element, or no state if this is the root element.

Returns:

Previous element state, or null

getPrefix

protected java.lang.String getPrefix(java.lang.String namespaceURI)