org.apache.xml.serializer

Class ToStream

public abstract class ToStream extends SerializerBase

This abstract class is a base class for other stream serializers (xml, html, text ...) that write output to a stream.

UNKNOWN: internal

Constructor Summary
ToStream()
Default constructor
Method Summary
booleanaddAttributeAlways(String uri, String localName, String rawName, String type, String value, boolean xslAttribute)
Adds the given attribute to the set of attributes, even if there is no currently open element.
voidaddCdataSectionElements(String URI_and_localNames)
Remembers the cdata sections specified in the cdata-section-elements by appending the given cdata section elements to the list.
voidattributeDecl(String eName, String aName, String type, String valueDefault, String value)
Report an attribute type declaration.
voidcharacters(char[] chars, int start, int length)
Receive notification of character data.
voidcharacters(String s)
Receive notification of character data.
voidcomment(char[] ch, int start, int length)
Receive notification of an XML comment anywhere in the document.
voidelementDecl(String name, String model)
Report an element type declaration.
voidendCDATA()
Report the end of a CDATA section.
voidendDTD()
Report the end of DTD declarations.
voidendElement(String namespaceURI, String localName, String name)
Receive notification of the end of an element.
voidendElement(String name)
Receive notification of the end of an element.
voidendNonEscaping()
Ends an un-escaping section.
voidendPrefixMapping(String prefix)
End the scope of a prefix-URI Namespace mapping.
voidexternalEntityDecl(String name, String publicId, String systemId)
Report a parsed external entity declaration.
voidflushPending()
This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section.
intgetIndentAmount()
Returns the m_indentAmount.
PropertiesgetOutputFormat()
Returns the output format for this serializer.
OutputStreamgetOutputStream()
Get the output stream where the events will be serialized to.
WritergetWriter()
Get the character stream where the events will be serialized to.
voidignorableWhitespace(char[] ch, int start, int length)
Receive notification of ignorable whitespace in element content.
voidinternalEntityDecl(String name, String value)
Report an internal entity declaration.
voidnotationDecl(String name, String pubID, String sysID)
If this method is called, the serializer is used as a DTDHandler, which changes behavior how the serializer handles document entities.
voidprocessAttributes(Writer writer, int nAttrs)
Process the attributes, which means to write out the currently collected attributes to the writer.
booleanreset()
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).
voidserialize(Node node)
Serializes the DOM node.
voidsetCdataSectionElements(Vector URI_and_localNames)
Remembers the cdata sections specified in the cdata-section-elements.
voidsetContentHandler(ContentHandler ch)
voidsetDTDEntityExpansion(boolean expand)
If set to false the serializer does not expand DTD entities, but leaves them as is, the default value is true;
voidsetEncoding(String encoding)
Sets the character encoding coming from the xsl:output encoding stylesheet attribute.
booleansetEscaping(boolean escape)
voidsetIndentAmount(int m_indentAmount)
Sets the m_indentAmount.
booleansetLineSepUse(boolean use_sytem_line_break)
Set if the operating systems end-of-line line separator should be used when serializing.
voidsetNewLine(char[] eolChars)
Sets the end of line characters to be used during serialization
voidsetOutputFormat(Properties format)
Specifies an output format for this serializer.
voidsetOutputStream(OutputStream output)
Specifies an output stream to which the document should be serialized.
voidsetTransformer(Transformer transformer)
voidsetWriter(Writer writer)
Specifies a writer to which the document should be serialized.
voidskippedEntity(String name)
Receive notification of a skipped entity.
voidstartCDATA()
Report the start of a CDATA section.
voidstartDTD(String name, String publicId, String systemId)
Report the start of DTD declarations, if any.
voidstartElement(String namespaceURI, String localName, String name, Attributes atts)
Receive notification of the beginning of an element, although this is a SAX method additional namespace or attribute information can occur before or after this call, that is associated with this element.
voidstartElement(String elementNamespaceURI, String elementLocalName, String elementName)
Receive notification of the beginning of an element, additional namespace or attribute information can occur before or after this call, that is associated with this element.
voidstartElement(String elementName)
voidstartEntity(String name)
Report the beginning of an entity.
voidstartNonEscaping()
Starts an un-escaping section.
voidstartPrefixMapping(String prefix, String uri)
Begin the scope of a prefix-URI Namespace mapping just before another element is about to start.
booleanstartPrefixMapping(String prefix, String uri, boolean shouldFlush)
Handle a prefix/uri mapping, which is associated with a startElement() that is soon to follow.
voidunparsedEntityDecl(String name, String pubID, String sysID, String notationName)
If this method is called, the serializer is used as a DTDHandler, which changes behavior how the serializer handles document entities.
voidwriteAttrString(Writer writer, String string, String encoding)
Returns the specified string after substituting specials, and UTF-16 surrogates for chracter references &#xnn.

Constructor Detail

ToStream

public ToStream()
Default constructor

Method Detail

addAttributeAlways

public boolean addAttributeAlways(String uri, String localName, String rawName, String type, String value, boolean xslAttribute)
Adds the given attribute to the set of attributes, even if there is no currently open element. This is useful if a SAX startPrefixMapping() should need to add an attribute before the element name is seen. This method is a copy of its super classes method, except that some tracing of events is done. This is so the tracing is only done for stream serializers, not for SAX ones.

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:attribute element.

Returns: true if the attribute value was added, false if the attribute already existed and the value was replaced with the new value.

addCdataSectionElements

public void addCdataSectionElements(String URI_and_localNames)
Remembers the cdata sections specified in the cdata-section-elements by appending the given cdata section elements to the list. This method can be called multiple times, but once an element is put in the list of cdata section elements it can not be removed. This method should be used by both Xalan and XSLTC.

Parameters: URI_and_localNames a whitespace separated list of element names, each element is a URI in curly braces (optional) and a local name. An example of such a parameter is: "{http://company.com}price {myURI2}book chapter"

attributeDecl

public void attributeDecl(String eName, String aName, String type, String valueDefault, String value)
Report an attribute type declaration.

Only the effective (first) declaration for an attribute will be reported. The type will be one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION", or a parenthesized token group with the separator "|" and all whitespace removed.

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.

characters

public void characters(char[] chars, 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: 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 org.xml.sax.Locator

characters

public void characters(String s)
Receive notification of character data.

Parameters: s The string of characters to process.

Throws: org.xml.sax.SAXException

comment

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

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.

elementDecl

public void elementDecl(String name, String model)
Report an element type declaration.

The content model will consist of the string "EMPTY", the string "ANY", or a parenthesised group, optionally followed by an occurrence indicator. The model will be normalized so that all whitespace is removed,and will include the enclosing parentheses.

Parameters: name The element type name. model The content model as a normalized string.

Throws: SAXException The application may raise an exception.

endCDATA

public void endCDATA()
Report the end of a CDATA section.

Throws: org.xml.sax.SAXException The application may raise an exception.

See Also: ToStream

endDTD

public void endDTD()
Report the end of DTD declarations.

Throws: org.xml.sax.SAXException The application may raise an exception.

See Also: ToStream

endElement

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

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 element type name

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

endElement

public void endElement(String name)
Receive notification of the end of an element.

Parameters: name The element type name

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

endNonEscaping

public void endNonEscaping()
Ends an un-escaping section.

Throws: org.xml.sax.SAXException

See Also: ToStream

endPrefixMapping

public void endPrefixMapping(String prefix)
End the scope of a prefix-URI Namespace mapping.

Parameters: prefix The prefix that was being mapping.

Throws: org.xml.sax.SAXException The client may throw an exception during processing.

See Also: org.xml.sax.ContentHandler#endPrefixMapping

externalEntityDecl

public void externalEntityDecl(String name, String publicId, String systemId)
Report a parsed external entity declaration.

Only the effective (first) declaration for each entity will be reported.

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 org.xml.sax.DTDHandler#unparsedEntityDecl

flushPending

public void flushPending()
This method flushes any pending events, which can be startDocument() closing the opening tag of an element, or closing an open CDATA section.

getIndentAmount

public int getIndentAmount()
Returns the m_indentAmount.

Returns: int

getOutputFormat

public Properties getOutputFormat()
Returns the output format for this serializer.

Returns: The output format in use

getOutputStream

public OutputStream getOutputStream()
Get the output stream where the events will be serialized to.

Returns: reference to the result stream, or null of only a writer was set.

getWriter

public Writer getWriter()
Get the character stream where the events will be serialized to.

Returns: Reference to the result Writer, or null.

ignorableWhitespace

public void ignorableWhitespace(char[] ch, int start, int length)
Receive notification of ignorable whitespace in element content. Not sure how to get this invoked quite yet.

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

internalEntityDecl

public void internalEntityDecl(String name, String value)
Report an internal entity declaration.

Only the effective (first) declaration for each entity will be reported.

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 org.xml.sax.DTDHandler#unparsedEntityDecl

notationDecl

public void notationDecl(String name, String pubID, String sysID)
If this method is called, the serializer is used as a DTDHandler, which changes behavior how the serializer handles document entities.

See Also: org.xml.sax.DTDHandler#notationDecl(java.lang.String, java.lang.String, java.lang.String)

processAttributes

public void processAttributes(Writer writer, int nAttrs)
Process the attributes, which means to write out the currently collected attributes to the writer. The attributes are not cleared by this method

Parameters: writer the writer to write processed attributes to. nAttrs the number of attributes in m_attributes to be processed

Throws: java.io.IOException org.xml.sax.SAXException

reset

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

Returns: true if the class was successfuly reset.

serialize

public void serialize(Node node)
Serializes the DOM node. Throws an exception only if an I/O exception occured while serializing.

Parameters: node Node to serialize.

Throws: IOException An I/O exception occured while serializing

setCdataSectionElements

public void setCdataSectionElements(Vector URI_and_localNames)
Remembers the cdata sections specified in the cdata-section-elements. The "official way to set URI and localName pairs. This method should be used by both Xalan and XSLTC.

Parameters: URI_and_localNames a vector of pairs of Strings (URI/local)

setContentHandler

public void setContentHandler(ContentHandler ch)

setDTDEntityExpansion

public void setDTDEntityExpansion(boolean expand)
If set to false the serializer does not expand DTD entities, but leaves them as is, the default value is true;

setEncoding

public void setEncoding(String encoding)
Sets the character encoding coming from the xsl:output encoding stylesheet attribute.

Parameters: encoding the character encoding

setEscaping

public boolean setEscaping(boolean escape)

See Also: SerializationHandler

setIndentAmount

public void setIndentAmount(int m_indentAmount)
Sets the m_indentAmount.

Parameters: m_indentAmount The m_indentAmount to set

setLineSepUse

public boolean setLineSepUse(boolean use_sytem_line_break)
Set if the operating systems end-of-line line separator should be used when serializing. If set false NL character (decimal 10) is left alone, otherwise the new-line will be replaced on output with the systems line separator. For example on UNIX this is NL, while on Windows it is two characters, CR NL, where CR is the carriage-return (decimal 13).

Parameters: use_sytem_line_break True if an input NL is replaced with the operating systems end-of-line separator.

Returns: The previously set value of the serializer.

setNewLine

public void setNewLine(char[] eolChars)
Sets the end of line characters to be used during serialization

Parameters: eolChars A character array corresponding to the characters to be used.

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.

Parameters: format The output format to use

setOutputStream

public void setOutputStream(OutputStream output)
Specifies an output stream to which the document should be serialized. This method should not be called while the serializer is in the process of serializing a document.

The encoding specified in the output properties is used, or if no encoding was specified, the default for the selected output method.

Parameters: output The output stream

setTransformer

public void setTransformer(Transformer transformer)

See Also: setTransformer

setWriter

public void setWriter(Writer writer)
Specifies a writer to which the document should be serialized. This method should not be called while the serializer is in the process of serializing a document.

Parameters: writer The output writer stream

skippedEntity

public void skippedEntity(String name)
Receive notification of a skipped entity.

Parameters: name The name of the skipped entity. If it is a parameter entity, the name will begin with '%', and if it is the external DTD subset, it will be the string "[dtd]".

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

See Also: org.xml.sax.ContentHandler#skippedEntity

startCDATA

public void startCDATA()
Report the start of a CDATA section.

Throws: org.xml.sax.SAXException The application may raise an exception.

See Also: ToStream

startDTD

public void startDTD(String name, String publicId, String systemId)
Report the start of DTD declarations, if any. Any declarations are assumed to be in the internal subset unless otherwise indicated.

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 ToStream

startElement

public void startElement(String namespaceURI, String localName, String name, Attributes atts)
Receive notification of the beginning of an element, although this is a SAX method additional namespace or attribute information can occur before or after this call, that is associated with this element.

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 element type name. 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: org.xml.sax.ContentHandler#startElement org.xml.sax.ContentHandler#endElement org.xml.sax.AttributeList

startElement

public void startElement(String elementNamespaceURI, String elementLocalName, String elementName)
Receive notification of the beginning of an element, additional namespace or attribute information can occur before or after this call, that is associated with this element.

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

See Also: org.xml.sax.ContentHandler#startElement org.xml.sax.ContentHandler#endElement org.xml.sax.AttributeList

startElement

public void startElement(String elementName)

startEntity

public void startEntity(String name)
Report the beginning of an entity. The start and end of the document entity are not reported. The start and end of the external DTD subset are reported using the pseudo-name "[dtd]". All other events must be properly nested within start/end entity events.

Parameters: name The name of the entity. If it is a parameter entity, the name will begin with '%'.

Throws: org.xml.sax.SAXException The application may raise an exception.

See Also: ToStream org.xml.sax.ext.DeclHandler#internalEntityDecl org.xml.sax.ext.DeclHandler#externalEntityDecl

startNonEscaping

public void startNonEscaping()
Starts an un-escaping section. All characters printed within an un- escaping section are printed as is, without escaping special characters into entity references. Only XML and HTML serializers need to support this method.

The contents of the un-escaping section will be delivered through the regular characters event.

Throws: org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(String prefix, String uri)
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.

Parameters: prefix The Namespace prefix being declared. uri The Namespace URI the prefix is mapped to.

Throws: org.xml.sax.SAXException The client may throw an exception during processing.

See Also: org.xml.sax.ContentHandler#startPrefixMapping

startPrefixMapping

public boolean startPrefixMapping(String prefix, String uri, boolean shouldFlush)
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.

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: org.xml.sax.SAXException The client may throw an exception during processing.

See Also: ExtendedContentHandler

unparsedEntityDecl

public void unparsedEntityDecl(String name, String pubID, String sysID, String notationName)
If this method is called, the serializer is used as a DTDHandler, which changes behavior how the serializer handles document entities.

See Also: org.xml.sax.DTDHandler#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

writeAttrString

public void writeAttrString(Writer writer, String string, String encoding)
Returns the specified string after substituting specials, and UTF-16 surrogates for chracter references &#xnn.

Parameters: string String to convert to XML format. encoding CURRENTLY NOT IMPLEMENTED.

Throws: java.io.IOException

Copyright B) 2006 Apache XML Project. All Rights Reserved.