Package org.apache.xml.serializer

Class 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 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

      • 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

    • 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​(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 interface Serializer
        Overrides:
        setOutputFormat in class ToStream
        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 interface org.xml.sax.ContentHandler
        Overrides:
        startElement in class ToStream
        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 interface org.xml.sax.ContentHandler
        Overrides:
        endElement in class ToStream
        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 class ToStream
        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 interface org.xml.sax.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:
        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 interface ExtendedContentHandler
        Overrides:
        entityReference in class SerializerBase
        Parameters:
        name - non-null reference to entity name string.
        Throws:
        org.xml.sax.SAXException

      • 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 class ToStream
        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

      • 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 interface org.xml.sax.ext.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:
        org.xml.sax.SAXException - The application may raise an exception.
        See Also:
        ToStream.endDTD(), ToStream.startEntity(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 interface org.xml.sax.ext.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:
        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 interface org.xml.sax.ext.DeclHandler
        Overrides:
        elementDecl in class ToStream
        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 interface org.xml.sax.ext.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:
        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 interface org.xml.sax.ext.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:
        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 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:
        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 interface org.xml.sax.ext.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:
        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 interface Serializer
        Overrides:
        reset in class ToStream
        Returns:
        true if the class was successfuly reset.