Class ToTextStream

All Implemented Interfaces:
DOMSerializer, ExtendedContentHandler, ExtendedLexicalHandler, SerializationHandler, Serializer, ContentHandler, DTDHandler, ErrorHandler, DeclHandler, LexicalHandler

public class ToTextStream extends ToStream
This class is not a public API. It is only public because it is used in other packages. This class converts SAX or SAX-like calls to a serialized document for xsl:output method of "text".
  • Field Details

  • Constructor Details

    • ToTextStream

      public ToTextStream()
      Default constructor.
  • Method Details

    • endDocument

      public void endDocument() throws SAXException
      Receive notification of the end of a document.

      The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

      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.

      The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.

      If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.

      Specified by:
      startElement in interface ContentHandler
      Overrides:
      startElement in class ToStream
      Parameters:
      namespaceURI - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
      localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.
      name - The qualified name (with prefix), or the empty string if qualified names are not available.
      atts - The attributes attached to the element, if any.
      Throws:
      SAXException - Any SAX exception, possibly wrapping another exception.
      SAXException
      See Also:
    • endElement

      public void endElement(String namespaceURI, String localName, String name) throws SAXException
      Receive notification of the end of an element.

      The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

      If the element name has a namespace prefix, the prefix will still be attached to the name.

      Specified by:
      endElement in interface ContentHandler
      Overrides:
      endElement in class ToStream
      Parameters:
      namespaceURI - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
      localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.
      name - The qualified name (with prefix), or the empty string if qualified names are not available.
      Throws:
      SAXException - Any SAX exception, possibly wrapping another exception.
      SAXException
    • characters

      public void characters(char[] ch, 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:
      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:
    • charactersRaw

      public void charactersRaw(char[] ch, int start, int length) throws SAXException
      If available, when the disable-output-escaping attribute is used, output raw text without escaping.
      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.
    • cdata

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

      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:
    • ignorableWhitespace

      public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
      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
      Overrides:
      ignorableWhitespace 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:
    • processingInstruction

      public void processingInstruction(String target, String data) throws SAXException
      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.

      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
    • comment

      public void comment(String data) throws SAXException
      Called when a Comment is to be constructed. Note that Xalan will normally invoke the other version of this method. %REVIEW% In fact, is this one ever needed, or was it a mistake?
      Specified by:
      comment in interface ExtendedLexicalHandler
      Overrides:
      comment in class SerializerBase
      Parameters:
      data - The comment data.
      Throws:
      SAXException - Any SAX exception, possibly wrapping another exception.
      See Also:
    • comment

      public void comment(char[] ch, int start, int length) throws SAXException
      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
      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.
    • entityReference

      public 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 the name of the entity.
      Throws:
      SAXException
    • addAttribute

      public void addAttribute(String uri, String localName, String rawName, String type, String value, boolean XSLAttribute)
      Description copied from class: SerializerBase
      Adds the given attribute to the set of collected attributes , but only if there is a currently open element. An element is currently open if a startElement() notification has occured but the start of the element has not yet been written to the output. In the stream case this means that we have not yet been forced to close the elements opening tag by another notification, such as a character notification.
      Specified by:
      addAttribute in interface ExtendedContentHandler
      Overrides:
      addAttribute in class SerializerBase
      Parameters:
      uri - the URI of the attribute
      localName - the local name of the attribute
      rawName - the qualified name of the attribute
      type - the type of the attribute (probably CDATA)
      value - the value of the attribute
      XSLAttribute - true if this attribute is coming from an xsl:attriute element
      See Also:
    • endCDATA

      public void endCDATA() throws SAXException
      Description copied from class: ToStream
      Report the end of a CDATA section.
      Specified by:
      endCDATA in interface LexicalHandler
      Overrides:
      endCDATA in class ToStream
      Throws:
      SAXException - The application may raise an exception.
      See Also:
    • endElement

      public 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 - Any SAX exception, possibly wrapping another exception.
      See Also:
    • startElement

      public void startElement(String elementNamespaceURI, String elementLocalName, String elementName) throws SAXException
      From XSLTC
      Specified by:
      startElement in interface ExtendedContentHandler
      Overrides:
      startElement in class ToStream
      Parameters:
      elementNamespaceURI - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
      elementLocalName - The local name (without prefix), or the empty string if Namespace processing is not being performed.
      elementName - The element type name.
      Throws:
      SAXException
      See Also:
    • characters

      public void characters(String characters) throws SAXException
      From XSLTC
      Specified by:
      characters in interface ExtendedContentHandler
      Overrides:
      characters in class ToStream
      Parameters:
      characters - The string of characters to process.
      Throws:
      SAXException
    • addAttribute

      public void addAttribute(String name, String value)
      From XSLTC
      Specified by:
      addAttribute in interface ExtendedContentHandler
      Overrides:
      addAttribute in class SerializerBase
      Parameters:
      name - the attribute's qualified name
      value - the value of the attribute
    • addUniqueAttribute

      public void addUniqueAttribute(String qName, String value, int flags) throws SAXException
      Add a unique attribute
      Parameters:
      qName - the fully qualified attribute name.
      value - the attribute value
      flags - a bitwise flag
      Throws:
      SAXException
    • startPrefixMapping

      public boolean startPrefixMapping(String prefix, String uri, boolean shouldFlush) throws SAXException
      Description copied from class: ToStream
      Handle a prefix/uri mapping, which is associated with a startElement() that is soon to follow. Need to close any open start tag to make sure than any name space attributes due to this event are associated wih the up comming element, not the current one.
      Specified by:
      startPrefixMapping in interface ExtendedContentHandler
      Overrides:
      startPrefixMapping in class ToStream
      Parameters:
      prefix - The Namespace prefix being declared.
      uri - The Namespace URI the prefix is mapped to.
      shouldFlush - true if any open tags need to be closed first, this will impact which element the mapping applies to (open parent, or its up comming child)
      Returns:
      returns true if the call made a change to the current namespace information, false if it did not change anything, e.g. if the prefix/namespace mapping was already in scope from before.
      Throws:
      SAXException - The client may throw an exception during processing.
      See Also:
    • startPrefixMapping

      public void startPrefixMapping(String prefix, String uri) throws SAXException
      Description copied from class: ToStream
      Begin the scope of a prefix-URI Namespace mapping just before another element is about to start. This call will close any open tags so that the prefix mapping will not apply to the current element, but the up comming child.
      Specified by:
      startPrefixMapping in interface ContentHandler
      Overrides:
      startPrefixMapping in class ToStream
      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:
    • namespaceAfterStartElement

      public void namespaceAfterStartElement(String prefix, String uri) throws SAXException
      Description copied from class: SerializerBase
      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:
      prefix - the URI of the namespace
      uri - the prefix associated with the given URI.
      Throws:
      SAXException
      See Also:
    • flushPending

      public void flushPending() throws SAXException
      Description copied from class: ToStream
      This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section.
      Specified by:
      flushPending in interface SerializationHandler
      Overrides:
      flushPending in class ToStream
      Throws:
      SAXException