org.apache.xml.serializer

Class ToTextStream

public final 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".

UNKNOWN: internal

Constructor Summary
ToTextStream()
Default constructor.
Method Summary
voidaddAttribute(String uri, String localName, String rawName, String type, String value, boolean XSLAttribute)
voidaddAttribute(String name, String value)
From XSLTC
voidaddUniqueAttribute(String qName, String value, int flags)
Add a unique attribute
voidcdata(char[] ch, int start, int length)
Receive notification of cdata.
voidcharacters(char[] ch, int start, int length)
Receive notification of character data.
voidcharacters(String characters)
From XSLTC
voidcharactersRaw(char[] ch, int start, int length)
If available, when the disable-output-escaping attribute is used, output raw text without escaping.
voidcomment(String data)
Called when a Comment is to be constructed.
voidcomment(char[] ch, int start, int length)
Report an XML comment anywhere in the document.
voidendCDATA()
voidendDocument()
Receive notification of the end of a document.
voidendElement(String namespaceURI, String localName, String name)
Receive notification of the end of an element.
voidendElement(String elemName)
voidentityReference(String name)
Receive notivication of a entityReference.
voidflushPending()
voidignorableWhitespace(char[] ch, int start, int length)
Receive notification of ignorable whitespace in element content.
voidnamespaceAfterStartElement(String prefix, String uri)
voidprocessingInstruction(String target, String data)
Receive notification of a processing instruction.
voidstartElement(String namespaceURI, String localName, String name, Attributes atts)
Receive notification of the beginning of an element.
voidstartElement(String elementNamespaceURI, String elementLocalName, String elementName)
From XSLTC
booleanstartPrefixMapping(String prefix, String uri, boolean shouldFlush)
voidstartPrefixMapping(String prefix, String uri)

Constructor Detail

ToTextStream

public ToTextStream()
Default constructor.

Method Detail

addAttribute

public void addAttribute(String uri, String localName, String rawName, String type, String value, boolean XSLAttribute)

See Also: ExtendedContentHandler

addAttribute

public void addAttribute(String name, String value)
From XSLTC

addUniqueAttribute

public void addUniqueAttribute(String qName, String value, int flags)
Add a unique attribute

cdata

public void cdata(char[] ch, int start, int length)
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.

See Also: ToTextStream org.xml.sax.Locator

characters

public void characters(char[] ch, int start, int length)
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).

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.

See Also: ToTextStream org.xml.sax.Locator

characters

public void characters(String characters)
From XSLTC

charactersRaw

public void charactersRaw(char[] ch, int start, int length)
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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.

comment

public void comment(String data)
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?

Parameters: data The comment data.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception.

comment

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

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.

endCDATA

public void endCDATA()

See Also: org.xml.sax.ext.LexicalHandler#endCDATA()

endDocument

public void endDocument()
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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException

endElement

public void endElement(String namespaceURI, String localName, String name)
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.

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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException

endElement

public void endElement(String elemName)

See Also: endElement

entityReference

public void entityReference(String name)
Receive notivication of a entityReference.

Parameters: name non-null reference to the name of the entity.

Throws: org.xml.sax.SAXException

flushPending

public void flushPending()

ignorableWhitespace

public void ignorableWhitespace(char[] ch, int start, int length)
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.

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: ToTextStream

namespaceAfterStartElement

public void namespaceAfterStartElement(String prefix, String uri)

processingInstruction

public void processingInstruction(String target, String data)
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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException

startElement

public void startElement(String namespaceURI, String localName, String name, Attributes atts)
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.

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: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException

See Also: ToTextStream org.xml.sax.AttributeList

startElement

public void startElement(String elementNamespaceURI, String elementLocalName, String elementName)
From XSLTC

startPrefixMapping

public boolean startPrefixMapping(String prefix, String uri, boolean shouldFlush)

startPrefixMapping

public void startPrefixMapping(String prefix, String uri)
Copyright B) 2005 Apache XML Project. All Rights Reserved.