org.apache.xml.serializer

Class ToXMLStream

java.lang.Object

org.apache.xml.serializer.SerializerBase

org.apache.xml.serializer.ToStream

org.apache.xml.serializer.ToXMLStream

All Implemented Interfaces:

DOMSerializer, ExtendedContentHandler, ExtendedLexicalHandler, SerializationHandler, Serializer, ContentHandler, DTDHandler, ErrorHandler, DeclHandler, LexicalHandler

public class ToXMLStream
extends ToStream

This class converts SAX or SAX-like calls to a serialized xml document. The xsl:output method is "xml". This class is used explicitly in code generated by XSLTC, so it is "public", but it should be viewed as internal or package private, this is not an API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CDATA_CONTINUE To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >
static String	CDATA_DELIMITER_CLOSE The constant "]]>"
static String	CDATA_DELIMITER_OPEN
static String	DEFAULT_SAX_SERIALIZER
static String	EMPTYSTRING
static String	ENTITY_AMP
static String	ENTITY_CRLF
static String	ENTITY_GT
static String	ENTITY_LT
static String	ENTITY_QUOT
static String	XML_PREFIX
static String	XMLNS_PREFIX
static String	XMLNS_URI
static String	XMLVERSION10
static String	XMLVERSION11 Define the XML version.

Fields inherited from class org.apache.xml.serializer.ToStream

m_cdataStartCalled, m_charInfo, m_disableOutputEscapingStates, m_escaping, m_inDoctype, m_ispreserve, m_isprevtext, m_lineSep, m_lineSepLen, m_lineSepUse, m_preserves, m_spaceBeforeClose

Fields inherited from class org.apache.xml.serializer.SerializerBase

m_attrBuff, m_attributes, m_CdataElems, m_cdataTagOpen, m_charsBuff, m_doctypePublic, m_doctypeSystem, m_doIndent, m_elemContext, m_indentAmount, m_inEntityRef, m_inExternalDTD, m_mediatype, m_needToCallStartDocument, m_prefixMap, m_shouldNotWriteXMLHeader, m_sourceLocator, m_standaloneWasSpecified, m_StringOfCDATASections, m_tracer, m_version, m_writer, PKG_NAME, PKG_PATH

Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler

HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS

Constructor Summary

Constructors

Constructor and Description
ToXMLStream() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String uri, String localName, String rawName, String type, String value, boolean xslAttribute) Add an attribute to the current element.
void	addUniqueAttribute(String name, String value, int flags) This method is used to add an attribute to the currently open element.
void	CopyFrom(ToXMLStream xmlListener) Copy properties from another SerializerToXML.
void	endDocument() Receive notification of the end of a document.
void	endElement(String elemName) Receive notification of the end of an element.
void	endPreserving() Ends a whitespace preserving section.
void	entityReference(String name) Receive notivication of a entityReference.
void	namespaceAfterStartElement(String prefix, String uri) This method is used to notify the serializer of a namespace mapping (or node) that applies to the current element whose startElement() call has already been seen.
void	processingInstruction(String target, String data) Receive notification of a processing instruction.
protected boolean	pushNamespace(String prefix, String uri) From XSLTC Declare a prefix to point to a namespace URI.
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	startDocumentInternal() Receive notification of the beginning of a document.
void	startPreserving() Starts a whitespace preserving section.

Methods inherited from class org.apache.xml.serializer.ToStream

addAttributeAlways, addCdataSectionElements, attributeDecl, cdata, characters, characters, charactersRaw, closeCDATA, closeStartTag, comment, elementDecl, endCDATA, endDTD, endElement, endNonEscaping, endPrefixMapping, ensureAttributesNamespaceIsDeclared, escapingNotNeeded, externalEntityDecl, firePseudoAttributes, flushPending, flushWriter, getIndentAmount, getOutputFormat, getOutputStream, getWriter, ignorableWhitespace, indent, indent, internalEntityDecl, notationDecl, outputLineSep, processAttributes, serialize, setCdataSectionElements, setContentHandler, setDTDEntityExpansion, setEncoding, setEscaping, setIndentAmount, setLineSepUse, setNewLine, setOutputFormat, setOutputStream, setTransformer, setWriter, shouldIndent, skippedEntity, startCDATA, startDTD, startElement, startElement, startElement, startEntity, startNonEscaping, startPrefixMapping, startPrefixMapping, unparsedEntityDecl, writeAttrString, writeUTF16Surrogate

Methods inherited from class org.apache.xml.serializer.SerializerBase

addAttribute, addAttribute, addAttributes, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, characters, close, comment, documentIsEmpty, endEntity, error, fatalError, fireCDATAEvent, fireCharEvent, fireCommentEvent, fireEndDoc, fireEndElem, fireEndEntity, fireEntityReference, fireEscapingEvent, fireStartDoc, fireStartElem, fireStartEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getLocalName, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputProperty, getOutputPropertyDefault, getOutputPropertyNonDefault, getPrefix, getPrefixPart, getStandalone, getTransformer, getVersion, initCDATA, isCdataSection, patchName, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setIndent, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputProperty, setOutputPropertyDefault, setSourceLocator, setStandalone, setStandaloneInternal, setVersion, startDocument, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CDATA_CONTINUE

public static final 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 String CDATA_DELIMITER_CLOSE

The constant "]]>"

See Also:

Constant Field Values

CDATA_DELIMITER_OPEN

public static final String CDATA_DELIMITER_OPEN

See Also:

Constant Field Values

EMPTYSTRING

public static final String EMPTYSTRING

See Also:

Constant Field Values

ENTITY_AMP

public static final String ENTITY_AMP

See Also:

Constant Field Values

ENTITY_CRLF

public static final String ENTITY_CRLF

See Also:

Constant Field Values

ENTITY_GT

public static final String ENTITY_GT

See Also:

Constant Field Values

ENTITY_LT

public static final String ENTITY_LT

See Also:

Constant Field Values

ENTITY_QUOT

public static final String ENTITY_QUOT

See Also:

Constant Field Values

XML_PREFIX

public static final String XML_PREFIX

See Also:

Constant Field Values

XMLNS_PREFIX

public static final String XMLNS_PREFIX

See Also:

Constant Field Values

XMLNS_URI

public static final String XMLNS_URI

See Also:

Constant Field Values

DEFAULT_SAX_SERIALIZER

public static final String DEFAULT_SAX_SERIALIZER

XMLVERSION11

public static final String XMLVERSION11

Define the XML version.

See Also:

Constant Field Values

XMLVERSION10

public static final String XMLVERSION10

See Also:

Constant Field Values

Constructor Detail

ToXMLStream

public ToXMLStream()

Default constructor.

Method Detail

CopyFrom

public void CopyFrom(ToXMLStream xmlListener)

Copy properties from another SerializerToXML.

Parameters:

xmlListener - non-null reference to a SerializerToXML object.

startDocumentInternal

public void startDocumentInternal()
                           throws SAXException

Receive notification of the beginning of a document.

Overrides:

startDocumentInternal in class SerializerBase

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

SAXException

endDocument

public void endDocument()
                 throws SAXException

Receive notification of the end of a document.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

SAXException

startPreserving

public void startPreserving()
                     throws SAXException

Starts a whitespace preserving section. All characters printed within a preserving section are printed without indentation and without consolidating multiple spaces. This is equivalent to the xml:space="preserve" attribute. Only XML and HTML serializers need to support this method.

The contents of the whitespace preserving section will be delivered through the regular characters event.

Throws:

SAXException

endPreserving

public void endPreserving()
                   throws SAXException

Ends a whitespace preserving section.

Throws:

SAXException

See Also:

startPreserving()

processingInstruction

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

SAXException - Any SAX exception, possibly wrapping another exception.

SAXException

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 - The name of the entity.

Throws:

SAXException

addUniqueAttribute

public void addUniqueAttribute(String name,
                               String value,
                               int flags)
                        throws 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:

SAXException

addAttribute

public void addAttribute(String uri,
                         String localName,
                         String rawName,
                         String type,
                         String value,
                         boolean xslAttribute)
                  throws SAXException

Add an attribute to the current element.

Specified by:

addAttribute in interface ExtendedContentHandler

Overrides:

addAttribute in class SerializerBase

Parameters:

uri - the URI associated with the element name

localName - local part of the attribute name

rawName - prefix:localName

type -

value - the value of the attribute

xslAttribute - true if this attribute is from an xsl:attribute, false if declared within the elements opening tag.

Throws:

SAXException

See Also:

ExtendedContentHandler.addAttribute(String, String, String, String, String)

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

See Also:

ExtendedContentHandler.endElement(String)

namespaceAfterStartElement

public void namespaceAfterStartElement(String prefix,
                                       String uri)
                                throws SAXException

This method is used to notify the serializer of a namespace mapping (or node) that applies to the current element whose startElement() call has already been seen. The official SAX startPrefixMapping(prefix,uri) is to define a mapping for a child element that is soon to be seen with a startElement() call. The official SAX call does not apply to the current element, hence the reason for this method.

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:

ExtendedContentHandler.namespaceAfterStartElement(String, String)

pushNamespace

protected boolean pushNamespace(String prefix,
                                String uri)

From XSLTC Declare a prefix to point to a namespace URI. Inform SAX handler if this is a new prefix mapping.

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

Specified by:

reset in interface Serializer

Overrides:

reset in class ToStream

Returns:

true if the class was successfuly reset.