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
,org.xml.sax.ContentHandler
,org.xml.sax.DTDHandler
,org.xml.sax.ErrorHandler
,org.xml.sax.ext.DeclHandler
,org.xml.sax.ext.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 Description static java.lang.String
CDATA_CONTINUE
To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >static java.lang.String
CDATA_DELIMITER_CLOSE
The constant "]]>"static java.lang.String
CDATA_DELIMITER_OPEN
static java.lang.String
DEFAULT_SAX_SERIALIZER
static java.lang.String
EMPTYSTRING
static java.lang.String
ENTITY_AMP
static java.lang.String
ENTITY_CRLF
static java.lang.String
ENTITY_GT
static java.lang.String
ENTITY_LT
static java.lang.String
ENTITY_QUOT
static java.lang.String
XML_PREFIX
static java.lang.String
XMLNS_PREFIX
static java.lang.String
XMLNS_URI
static java.lang.String
XMLVERSION10
static java.lang.String
XMLVERSION11
Define the XML version.-
Fields inherited from class org.apache.xml.serializer.SerializerBase
PKG_NAME, PKG_PATH
-
Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler
HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS
-
-
Constructor Summary
Constructors Constructor Description ToHTMLStream()
Default constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addUniqueAttribute(java.lang.String name, java.lang.String value, int flags)
This method is used to add an attribute to the currently open element.void
attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String valueDefault, java.lang.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.void
comment(char[] ch, int start, int length)
Receive notification of an XML comment anywhere in the document.void
elementDecl(java.lang.String name, java.lang.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(java.lang.String elemName)
Receive notification of the end of an element.void
endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String name)
Receive notification of the end of an element.void
entityReference(java.lang.String name)
Receive notivication of a entityReference.void
externalEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
This method does nothing.static ElemDesc
getElemDesc(java.lang.String name)
Get a description of the given element.void
internalEntityDecl(java.lang.String name, java.lang.String value)
This method does nothing.void
namespaceAfterStartElement(java.lang.String prefix, java.lang.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().void
processAttributes(java.io.Writer writer, int nAttrs)
Process the attributes, which means to write out the currently collected attributes to the writer.void
processingInstruction(java.lang.String target, java.lang.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(java.util.Properties format)
Specifies an output format for this serializer.void
setSpecialEscapeURLs(boolean bool)
Tells if the formatter should use special URL escaping.void
startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)
Report the start of DTD declarations, if any.void
startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String name, org.xml.sax.Attributes atts)
Receive notification of the beginning of an element.void
writeAttrString(java.io.Writer writer, java.lang.String string, java.lang.String encoding)
Writes the specified string after substituting specials, and UTF-16 surrogates for character references&#xnn
.void
writeAttrURI(java.io.Writer writer, java.lang.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, endCDATA, endNonEscaping, endPrefixMapping, flushPending, getIndentAmount, getOutputFormat, getOutputStream, getWriter, ignorableWhitespace, notationDecl, serialize, setCdataSectionElements, setContentHandler, setDTDEntityExpansion, setEncoding, setEscaping, setIndentAmount, setLineSepUse, setNewLine, setOutputStream, setTransformer, setWriter, skippedEntity, startCDATA, startElement, startElement, startEntity, startNonEscaping, startPrefixMapping, startPrefixMapping, unparsedEntityDecl
-
Methods inherited from class org.apache.xml.serializer.SerializerBase
addAttribute, addAttribute, addAttribute, addAttributes, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, characters, close, comment, documentIsEmpty, endEntity, error, fatalError, fireEndEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputProperty, getOutputPropertyDefault, getOutputPropertyNonDefault, getPrefix, getStandalone, getTransformer, getVersion, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setIndent, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputProperty, setOutputPropertyDefault, setSourceLocator, setStandalone, setVersion, startDocument, warning
-
-
-
-
Field Detail
-
CDATA_CONTINUE
public static final java.lang.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 java.lang.String CDATA_DELIMITER_CLOSE
The constant "]]>"- See Also:
- Constant Field Values
-
CDATA_DELIMITER_OPEN
public static final java.lang.String CDATA_DELIMITER_OPEN
- See Also:
- Constant Field Values
-
EMPTYSTRING
public static final java.lang.String EMPTYSTRING
- See Also:
- Constant Field Values
-
ENTITY_AMP
public static final java.lang.String ENTITY_AMP
- See Also:
- Constant Field Values
-
ENTITY_CRLF
public static final java.lang.String ENTITY_CRLF
- See Also:
- Constant Field Values
-
ENTITY_GT
public static final java.lang.String ENTITY_GT
- See Also:
- Constant Field Values
-
ENTITY_LT
public static final java.lang.String ENTITY_LT
- See Also:
- Constant Field Values
-
ENTITY_QUOT
public static final java.lang.String ENTITY_QUOT
- See Also:
- Constant Field Values
-
XML_PREFIX
public static final java.lang.String XML_PREFIX
- See Also:
- Constant Field Values
-
XMLNS_PREFIX
public static final java.lang.String XMLNS_PREFIX
- See Also:
- Constant Field Values
-
XMLNS_URI
public static final java.lang.String XMLNS_URI
- See Also:
- Constant Field Values
-
DEFAULT_SAX_SERIALIZER
public static final java.lang.String DEFAULT_SAX_SERIALIZER
-
XMLVERSION11
public static final java.lang.String XMLVERSION11
Define the XML version.- See Also:
- Constant Field Values
-
XMLVERSION10
public static final java.lang.String XMLVERSION10
- See Also:
- Constant Field Values
-
-
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(java.util.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 interfaceSerializer
- Overrides:
setOutputFormat
in classToStream
- Parameters:
format
- The output format or serialzation parameters to use.
-
getElemDesc
public static final ElemDesc getElemDesc(java.lang.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.
-
endDocument
public final void endDocument() throws org.xml.sax.SAXException
Receive notification of the end of a document.- Throws:
org.xml.sax.SAXException
- Any SAX exception, possibly wrapping another exception.org.xml.sax.SAXException
-
startElement
public void startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String name, org.xml.sax.Attributes atts) throws org.xml.sax.SAXException
Receive notification of the beginning of an element.- Specified by:
startElement
in interfaceorg.xml.sax.ContentHandler
- Overrides:
startElement
in classToStream
- Parameters:
namespaceURI
-localName
-name
- The element type name.atts
- The attributes attached to the element, if any.- Throws:
org.xml.sax.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(java.lang.String namespaceURI, java.lang.String localName, java.lang.String name) throws org.xml.sax.SAXException
Receive notification of the end of an element.- Specified by:
endElement
in interfaceorg.xml.sax.ContentHandler
- Overrides:
endElement
in classToStream
- Parameters:
namespaceURI
-localName
-name
- The element type name- Throws:
org.xml.sax.SAXException
- Any SAX exception, possibly wrapping another exception.
-
writeAttrURI
public void writeAttrURI(java.io.Writer writer, java.lang.String string, boolean doURLEscaping) throws java.io.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:
org.xml.sax.SAXException
- if a bad surrogate pair is detected.java.io.IOException
-
writeAttrString
public void writeAttrString(java.io.Writer writer, java.lang.String string, java.lang.String encoding) throws java.io.IOException
Writes the specified string after substituting specials, and UTF-16 surrogates for character references&#xnn
.- Overrides:
writeAttrString
in classToStream
- Parameters:
string
- String to convert to XML format.encoding
- CURRENTLY NOT IMPLEMENTED.- Throws:
org.xml.sax.SAXException
java.io.IOException
-
characters
public final void characters(char[] chars, int start, int length) throws org.xml.sax.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 interfaceorg.xml.sax.ContentHandler
- Overrides:
characters
in classToStream
- 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:
org.xml.sax.SAXException
- Any SAX exception, possibly wrapping another exception.org.xml.sax.SAXException
- See Also:
ToStream.ignorableWhitespace(char[], int, int)
,Locator
-
cdata
public final void cdata(char[] ch, int start, int length) throws org.xml.sax.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).
- 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:
org.xml.sax.SAXException
- Any SAX exception, possibly wrapping another exception.org.xml.sax.SAXException
- See Also:
ToStream.ignorableWhitespace(char[], int, int)
,Locator
-
processingInstruction
public void processingInstruction(java.lang.String target, java.lang.String data) throws org.xml.sax.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:
org.xml.sax.SAXException
- Any SAX exception, possibly wrapping another exception.org.xml.sax.SAXException
-
entityReference
public final void entityReference(java.lang.String name) throws org.xml.sax.SAXException
Receive notivication of a entityReference.- Specified by:
entityReference
in interfaceExtendedContentHandler
- Overrides:
entityReference
in classSerializerBase
- Parameters:
name
- non-null reference to entity name string.- Throws:
org.xml.sax.SAXException
-
endElement
public final void endElement(java.lang.String elemName) throws org.xml.sax.SAXException
Description copied from class:ToStream
Receive notification of the end of an element.- Specified by:
endElement
in interfaceExtendedContentHandler
- Overrides:
endElement
in classToStream
- Parameters:
elemName
- The element type name- Throws:
org.xml.sax.SAXException
- Any SAX exception, possibly wrapping another exception.- See Also:
ExtendedContentHandler.endElement(String)
-
processAttributes
public void processAttributes(java.io.Writer writer, int nAttrs) throws java.io.IOException, org.xml.sax.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 classToStream
- Parameters:
writer
- the writer to write processed attributes to.nAttrs
- the number of attributes in m_attributes to be processed- Throws:
org.xml.sax.SAXException
java.io.IOException
-
namespaceAfterStartElement
public void namespaceAfterStartElement(java.lang.String prefix, java.lang.String uri) throws org.xml.sax.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 interfaceExtendedContentHandler
- Overrides:
namespaceAfterStartElement
in classSerializerBase
- Parameters:
uri
- the URI of the namespaceprefix
- the prefix associated with the given URI.- Throws:
org.xml.sax.SAXException
- See Also:
ExtendedContentHandler.namespaceAfterStartElement(String, String)
-
startDTD
public void startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.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 interfaceorg.xml.sax.ext.LexicalHandler
- Overrides:
startDTD
in classToStream
- 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:
org.xml.sax.SAXException
- The application may raise an exception.- See Also:
ToStream.endDTD()
,ToStream.startEntity(java.lang.String)
-
endDTD
public void endDTD() throws org.xml.sax.SAXException
Report the end of DTD declarations.- Specified by:
endDTD
in interfaceorg.xml.sax.ext.LexicalHandler
- Overrides:
endDTD
in classToStream
- Throws:
org.xml.sax.SAXException
- The application may raise an exception.- See Also:
startDTD(java.lang.String, java.lang.String, java.lang.String)
-
attributeDecl
public void attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String valueDefault, java.lang.String value) throws org.xml.sax.SAXException
This method does nothing.- Specified by:
attributeDecl
in interfaceorg.xml.sax.ext.DeclHandler
- Overrides:
attributeDecl
in classToStream
- 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:
org.xml.sax.SAXException
- The application may raise an exception.
-
elementDecl
public void elementDecl(java.lang.String name, java.lang.String model) throws org.xml.sax.SAXException
This method does nothing.- Specified by:
elementDecl
in interfaceorg.xml.sax.ext.DeclHandler
- Overrides:
elementDecl
in classToStream
- Parameters:
name
- The element type name.model
- The content model as a normalized string.- Throws:
org.xml.sax.SAXException
- The application may raise an exception.
-
internalEntityDecl
public void internalEntityDecl(java.lang.String name, java.lang.String value) throws org.xml.sax.SAXException
This method does nothing.- Specified by:
internalEntityDecl
in interfaceorg.xml.sax.ext.DeclHandler
- Overrides:
internalEntityDecl
in classToStream
- 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:
org.xml.sax.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(java.lang.String name, java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.SAXException
This method does nothing.- Specified by:
externalEntityDecl
in interfaceorg.xml.sax.ext.DeclHandler
- Overrides:
externalEntityDecl
in classToStream
- 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:
org.xml.sax.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(java.lang.String name, java.lang.String value, int flags) throws org.xml.sax.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 attributevalue
- 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:
org.xml.sax.SAXException
-
comment
public void comment(char[] ch, int start, int length) throws org.xml.sax.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 interfaceorg.xml.sax.ext.LexicalHandler
- Overrides:
comment
in classToStream
- 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:
org.xml.sax.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 interfaceSerializer
- Overrides:
reset
in classToStream
- Returns:
- true if the class was successfuly reset.
-
-