org.apache.xml.serializer

Class ToHTMLStream

java.lang.Object

org.apache.xml.serializer.SerializerBase

org.apache.xml.serializer.ToStream

org.apache.xml.serializer.ToHTMLStream

All Implemented Interfaces:

DOMSerializer, ExtendedContentHandler, ExtendedLexicalHandler, SerializationHandler, Serializer, ContentHandler, DTDHandler, ErrorHandler, DeclHandler, LexicalHandler

public class ToHTMLStream
extends ToStream

This serializer takes a series of SAX or SAX-like events and writes its output to the given stream. This class is not a public API, it is public because it is used from another package.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDATA_CONTINUE To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >
static String	CDATA_DELIMITER_CLOSE The constant "]]>"
static String	CDATA_DELIMITER_OPEN
static String	DEFAULT_SAX_SERIALIZER
static String	EMPTYSTRING
static String	ENTITY_AMP
static String	ENTITY_CRLF
static String	ENTITY_GT
static String	ENTITY_LT
static String	ENTITY_QUOT
protected boolean	m_inDTD This flag is set while receiving events from the DTD
static String	XML_PREFIX
static String	XMLNS_PREFIX
static String	XMLNS_URI
static String	XMLVERSION10
static String	XMLVERSION11 Define the XML version.

Fields inherited from class org.apache.xml.serializer.ToStream

m_cdataStartCalled, m_charInfo, m_disableOutputEscapingStates, m_escaping, m_inDoctype, m_ispreserve, m_isprevtext, m_lineSep, m_lineSepLen, m_lineSepUse, m_preserves, m_spaceBeforeClose

Fields inherited from class org.apache.xml.serializer.SerializerBase

m_attrBuff, m_attributes, m_CdataElems, m_cdataTagOpen, m_charsBuff, m_doctypePublic, m_doctypeSystem, m_doIndent, m_elemContext, m_indentAmount, m_inEntityRef, m_inExternalDTD, m_mediatype, m_needToCallStartDocument, m_prefixMap, m_shouldNotWriteXMLHeader, m_sourceLocator, m_standaloneWasSpecified, m_StringOfCDATASections, m_tracer, m_version, m_writer, PKG_NAME, PKG_PATH

Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler

HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS

Constructor Summary

Constructors

Constructor and Description
ToHTMLStream() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addUniqueAttribute(String name, String value, int flags) This method is used to add an attribute to the currently open element.
void	attributeDecl(String eName, String aName, String type, String valueDefault, String value) This method does nothing.
void	cdata(char[] ch, int start, int length) Receive notification of cdata.
void	characters(char[] chars, int start, int length) Receive notification of character data.
protected void	closeStartTag() For the enclosing elements starting tag write out out any attributes followed by ">".
void	comment(char[] ch, int start, int length) Receive notification of an XML comment anywhere in the document.
void	elementDecl(String name, String model) This method does nothing.
void	endDocument() Receive notification of the end of a document.
void	endDTD() Report the end of DTD declarations.
void	endElement(String elemName) Receive notification of the end of an element.
void	endElement(String namespaceURI, String localName, String name) Receive notification of the end of an element.
void	entityReference(String name) Receive notivication of a entityReference.
void	externalEntityDecl(String name, String publicId, String systemId) This method does nothing.
static ElemDesc	getElemDesc(String name) Get a description of the given element.
void	internalEntityDecl(String name, String value) This method does nothing.
void	namespaceAfterStartElement(String prefix, String uri) This method is used when a prefix/uri namespace mapping is indicated after the element was started with a startElement() and before and endElement().
protected void	processAttribute(Writer writer, String name, String value, ElemDesc elemDesc) Process an attribute.
void	processAttributes(Writer writer, int nAttrs) Process the attributes, which means to write out the currently collected attributes to the writer.
void	processingInstruction(String target, String data) Receive notification of a processing instruction.
boolean	reset() Try's to reset the super class and reset this class for re-use, so that you don't need to create a new serializer (mostly for performance reasons).
void	setOmitMetaTag(boolean bool) Tells if the formatter should omit the META tag.
void	setOutputFormat(Properties format) Specifies an output format for this serializer.
void	setSpecialEscapeURLs(boolean bool) Tells if the formatter should use special URL escaping.
protected void	startDocumentInternal() Receive notification of the beginning of a document.
void	startDTD(String name, String publicId, String systemId) Report the start of DTD declarations, if any.
void	startElement(String namespaceURI, String localName, String name, Attributes atts) Receive notification of the beginning of an element.
void	writeAttrString(Writer writer, String string, String encoding) Writes the specified string after substituting specials, and UTF-16 surrogates for character references &#xnn.
void	writeAttrURI(Writer writer, String string, boolean doURLEscaping) Write the specified string after substituting non ASCII characters, with %HH, where HH is the hex of the byte value.

Methods inherited from class org.apache.xml.serializer.ToStream

addAttributeAlways, addCdataSectionElements, characters, charactersRaw, closeCDATA, endCDATA, endNonEscaping, endPrefixMapping, ensureAttributesNamespaceIsDeclared, escapingNotNeeded, firePseudoAttributes, flushPending, flushWriter, getIndentAmount, getOutputFormat, getOutputStream, getWriter, ignorableWhitespace, indent, indent, notationDecl, outputLineSep, serialize, setCdataSectionElements, setContentHandler, setDTDEntityExpansion, setEncoding, setEscaping, setIndentAmount, setLineSepUse, setNewLine, setOutputStream, setTransformer, setWriter, shouldIndent, skippedEntity, startCDATA, startElement, startElement, startEntity, startNonEscaping, startPrefixMapping, startPrefixMapping, unparsedEntityDecl, writeUTF16Surrogate

Methods inherited from class org.apache.xml.serializer.SerializerBase

addAttribute, addAttribute, addAttribute, addAttributes, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, characters, close, comment, documentIsEmpty, endEntity, error, fatalError, fireCDATAEvent, fireCharEvent, fireCommentEvent, fireEndDoc, fireEndElem, fireEndEntity, fireEntityReference, fireEscapingEvent, fireStartDoc, fireStartElem, fireStartEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getLocalName, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputProperty, getOutputPropertyDefault, getOutputPropertyNonDefault, getPrefix, getPrefixPart, getStandalone, getTransformer, getVersion, initCDATA, isCdataSection, patchName, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setIndent, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputProperty, setOutputPropertyDefault, setSourceLocator, setStandalone, setStandaloneInternal, setVersion, startDocument, warning

Methods inherited from class java.lang.Object

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

Field Detail

m_inDTD

protected boolean m_inDTD

This flag is set while receiving events from the DTD

CDATA_CONTINUE

public static final String CDATA_CONTINUE

To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >

See Also:

Constant Field Values

CDATA_DELIMITER_CLOSE

public static final String CDATA_DELIMITER_CLOSE

The constant "]]>"

See Also:

Constant Field Values

CDATA_DELIMITER_OPEN

public static final String CDATA_DELIMITER_OPEN

See Also:

Constant Field Values

EMPTYSTRING

public static final String EMPTYSTRING

See Also:

Constant Field Values

ENTITY_AMP

public static final String ENTITY_AMP

See Also:

Constant Field Values

ENTITY_CRLF

public static final String ENTITY_CRLF

See Also:

Constant Field Values

ENTITY_GT

public static final String ENTITY_GT

See Also:

Constant Field Values

ENTITY_LT

public static final String ENTITY_LT

See Also:

Constant Field Values

ENTITY_QUOT

public static final String ENTITY_QUOT

See Also:

Constant Field Values

XML_PREFIX

public static final String XML_PREFIX

See Also:

Constant Field Values

XMLNS_PREFIX

public static final String XMLNS_PREFIX

See Also:

Constant Field Values

XMLNS_URI

public static final String XMLNS_URI

See Also:

Constant Field Values

DEFAULT_SAX_SERIALIZER

public static final String DEFAULT_SAX_SERIALIZER

XMLVERSION11

public static final String XMLVERSION11

Define the XML version.

See Also:

Constant Field Values

XMLVERSION10

public static final String XMLVERSION10

See Also:

Constant Field Values

Constructor Detail

ToHTMLStream

public ToHTMLStream()

Default constructor.

Method Detail

setSpecialEscapeURLs

public void setSpecialEscapeURLs(boolean bool)

Tells if the formatter should use special URL escaping.

Parameters:

bool - True if URLs should be specially escaped with the %xx form.

setOmitMetaTag

public void setOmitMetaTag(boolean bool)

Tells if the formatter should omit the META tag.

Parameters:

bool - True if the META tag should be omitted.

setOutputFormat

public void setOutputFormat(Properties 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. This method can be called multiple times before starting the serialization of a particular result-tree. In principle all serialization parameters can be changed, with the exception of method="html" (it must be method="html" otherwise we shouldn't even have a ToHTMLStream object here!)

Specified by:

setOutputFormat in interface Serializer

Overrides:

setOutputFormat in class ToStream

Parameters:

format - The output format or serialzation parameters to use.

getElemDesc

public static final ElemDesc getElemDesc(String name)

Get a description of the given element.

Parameters:

name - non-null name of element, case insensitive.

Returns:

non-null reference to ElemDesc, which may be m_dummy if no element description matches the given name.

startDocumentInternal

protected void startDocumentInternal()
                              throws SAXException

Receive notification of the beginning of a document.

Overrides:

startDocumentInternal in class SerializerBase

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

SAXException

endDocument

public final void endDocument()
                       throws SAXException

Receive notification of the end of a document.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

SAXException

startElement

public void startElement(String namespaceURI,
                         String localName,
                         String name,
                         Attributes atts)
                  throws SAXException

Receive notification of the beginning of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class ToStream

Parameters:

namespaceURI -

localName -

name - The element type name.

atts - The attributes attached to the element, if any.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

endElement(java.lang.String, java.lang.String, java.lang.String), AttributeList

endElement

public final void endElement(String namespaceURI,
                             String localName,
                             String name)
                      throws SAXException

Receive notification of the end of an element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class ToStream

Parameters:

namespaceURI -

localName -

name - The element type name

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

processAttribute

protected void processAttribute(Writer writer,
                                String name,
                                String value,
                                ElemDesc elemDesc)
                         throws IOException

Process an attribute.

Parameters:

writer - The writer to write the processed output to.

name - The name of the attribute.

value - The value of the attribute.

elemDesc - The description of the HTML element that has this attribute.

Throws:

SAXException

IOException

writeAttrURI

public void writeAttrURI(Writer writer,
                         String string,
                         boolean doURLEscaping)
                  throws IOException

Write the specified string after substituting non ASCII characters, with %HH, where HH is the hex of the byte value.

Parameters:

string - String to convert to XML format.

doURLEscaping - True if we should try to encode as per http://www.ietf.org/rfc/rfc2396.txt.

Throws:

SAXException - if a bad surrogate pair is detected.

IOException

writeAttrString

public void writeAttrString(Writer writer,
                            String string,
                            String encoding)
                     throws IOException

Writes the specified string after substituting specials, and UTF-16 surrogates for character references &#xnn.

Overrides:

writeAttrString in class ToStream

Parameters:

string - String to convert to XML format.

encoding - CURRENTLY NOT IMPLEMENTED.

Throws:

SAXException

IOException

characters

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

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

Overrides:

characters in class ToStream

Parameters:

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

SAXException

See Also:

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

cdata

public final void cdata(char[] ch,
                        int start,
                        int length)
                 throws SAXException

Receive notification of cdata.

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

Overrides:

cdata in class ToStream

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.

SAXException

See Also:

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

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Receive notification of a processing instruction.

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.

SAXException

entityReference

public final void entityReference(String name)
                           throws SAXException

Receive notivication of a entityReference.

Specified by:

entityReference in interface ExtendedContentHandler

Overrides:

entityReference in class SerializerBase

Parameters:

name - non-null reference to entity name string.

Throws:

SAXException

endElement

public final void endElement(String elemName)
                      throws SAXException

Description copied from class: ToStream

Receive notification of the end of an element.

Specified by:

endElement in interface ExtendedContentHandler

Overrides:

endElement in class ToStream

Parameters:

elemName - The element type name

Throws:

SAXException

See Also:

ExtendedContentHandler.endElement(String)

processAttributes

public void processAttributes(Writer writer,
                              int nAttrs)
                       throws IOException,
                              SAXException

Process the attributes, which means to write out the currently collected attributes to the writer. The attributes are not cleared by this method

Overrides:

processAttributes in class ToStream

Parameters:

writer - the writer to write processed attributes to.

nAttrs - the number of attributes in m_attributes to be processed

Throws:

SAXException

IOException

closeStartTag

protected void closeStartTag()
                      throws SAXException

For the enclosing elements starting tag write out out any attributes followed by ">". At this point we also mark if this element is a cdata-section-element.

Overrides:

closeStartTag in class ToStream

Throws:

SAXException

namespaceAfterStartElement

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

This method is used when a prefix/uri namespace mapping is indicated after the element was started with a startElement() and before and endElement(). startPrefixMapping(prefix,uri) would be used before the startElement() call.

Specified by:

namespaceAfterStartElement in interface ExtendedContentHandler

Overrides:

namespaceAfterStartElement in class SerializerBase

Parameters:

uri - the URI of the namespace

prefix - the prefix associated with the given URI.

Throws:

SAXException

See Also:

ExtendedContentHandler.namespaceAfterStartElement(String, String)

startDTD

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

Description copied from class: ToStream

Report the start of DTD declarations, if any. Any declarations are assumed to be in the internal subset unless otherwise indicated.

Specified by:

startDTD in interface LexicalHandler

Overrides:

startDTD in class ToStream

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:

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

endDTD

public void endDTD()
            throws SAXException

Report the end of DTD declarations.

Specified by:

endDTD in interface LexicalHandler

Overrides:

endDTD in class ToStream

Throws:

SAXException - The application may raise an exception.

See Also:

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

attributeDecl

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

This method does nothing.

Specified by:

attributeDecl in interface DeclHandler

Overrides:

attributeDecl in class ToStream

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.

elementDecl

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

This method does nothing.

Specified by:

elementDecl in interface DeclHandler

Overrides:

elementDecl in class ToStream

Parameters:

name - The element type name.

model - The content model as a normalized string.

Throws:

SAXException - The application may raise an exception.

internalEntityDecl

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

This method does nothing.

Specified by:

internalEntityDecl in interface DeclHandler

Overrides:

internalEntityDecl in class ToStream

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:

ToStream.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(String name,
                               String publicId,
                               String systemId)
                        throws SAXException

This method does nothing.

Specified by:

externalEntityDecl in interface DeclHandler

Overrides:

externalEntityDecl in class ToStream

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:

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

addUniqueAttribute

public void addUniqueAttribute(String name,
                               String value,
                               int flags)
                        throws SAXException

This method is used to add an attribute to the currently open element. The caller has guaranted that this attribute is unique, which means that it not been seen before and will not be seen again.

Parameters:

name - the qualified name of the attribute

value - the value of the attribute which can contain only ASCII printable characters characters in the range 32 to 127 inclusive.

flags - the bit values of this integer give optimization information.

Throws:

SAXException

comment

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

Description copied from class: ToStream

Receive notification of 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

Overrides:

comment in class ToStream

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.

reset

public boolean reset()

Description copied from class: ToStream

Try's to reset the super class and reset this class for re-use, so that you don't need to create a new serializer (mostly for performance reasons).

Specified by:

reset in interface Serializer

Overrides:

reset in class ToStream

Returns:

true if the class was successfuly reset.