<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:51 GMT 2011 -->
<TITLE>
net.sf.saxon.serialize
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="net.sf.saxon.serialize";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/s9api/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../net/sf/saxon/serialize/charcode/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/serialize/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package net.sf.saxon.serialize
</H2>
This package contains code for serializing trees using the standard W3C-defined serialization methods
(xml, html, text).
<P>
<B>See:</B>
<BR>
<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/CharacterReferenceGenerator.html" title="interface in net.sf.saxon.serialize">CharacterReferenceGenerator</A></B></TD>
<TD>A class that expands a character to a character reference, entity reference, etc,
and writes the resulting reference to a writer</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/BinaryTextDecoder.html" title="class in net.sf.saxon.serialize">BinaryTextDecoder</A></B></TD>
<TD>This class generates decodes processing instructions in text output that represent text encoded
in base64 binary or hexBinary</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/CDATAFilter.html" title="class in net.sf.saxon.serialize">CDATAFilter</A></B></TD>
<TD>CDATAFilter: This ProxyEmitter converts character data to CDATA sections,
if the character data belongs to one of a set of element types to be handled this way.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/CharacterMap.html" title="class in net.sf.saxon.serialize">CharacterMap</A></B></TD>
<TD>This class defines a character map, that is, a mapping from characters to strings used by the serializer
when mapping individual characters in the output.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/CharacterMapExpander.html" title="class in net.sf.saxon.serialize">CharacterMapExpander</A></B></TD>
<TD>CharacterMapExpander: This ProxyReceiver expands characters occurring in a character map,
as specified by the XSLT 2.0 xsl:character-map declaration</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/CharacterMapIndex.html" title="class in net.sf.saxon.serialize">CharacterMapIndex</A></B></TD>
<TD>This class represents a set of named character maps.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/Emitter.html" title="class in net.sf.saxon.serialize">Emitter</A></B></TD>
<TD>Emitter: This abstract class defines methods that must be implemented by
components that format SAXON output.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/HexCharacterReferenceGenerator.html" title="class in net.sf.saxon.serialize">HexCharacterReferenceGenerator</A></B></TD>
<TD>A class that represents a character as a hexadecimal character reference
and writes the result to a supplied Writer</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/HTMLEmitter.html" title="class in net.sf.saxon.serialize">HTMLEmitter</A></B></TD>
<TD>This class generates HTML output</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/HTMLIndenter.html" title="class in net.sf.saxon.serialize">HTMLIndenter</A></B></TD>
<TD>HTMLIndenter: This ProxyEmitter indents HTML elements, by adding whitespace
character data where appropriate.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/HTMLTagHashSet.html" title="class in net.sf.saxon.serialize">HTMLTagHashSet</A></B></TD>
<TD>A simple class for testing membership of a fixed set of case-insensitive ASCII strings.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/HTMLURIEscaper.html" title="class in net.sf.saxon.serialize">HTMLURIEscaper</A></B></TD>
<TD>This class is used as a filter on the serialization pipeline; it performs the function
of escaping URI-valued attributes in HTML</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/ImplicitResultChecker.html" title="class in net.sf.saxon.serialize">ImplicitResultChecker</A></B></TD>
<TD>This filter is inserted into the serializer pipeline when serializing an implicit XSLT result tree, that
is, one that is created without use of xsl:result-document.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/MessageEmitter.html" title="class in net.sf.saxon.serialize">MessageEmitter</A></B></TD>
<TD>MessageEmitter is the default Receiver for xsl:message output.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/MessageWarner.html" title="class in net.sf.saxon.serialize">MessageWarner</A></B></TD>
<TD>MessageWarner is a user-selectable receiver for XSLT xsl:message output.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/MetaTagAdjuster.html" title="class in net.sf.saxon.serialize">MetaTagAdjuster</A></B></TD>
<TD>The MetaTagAdjuster adds a meta element to the content of the head element, indicating
the required content type and encoding; it also removes any existing meta element
containing this information</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/TEXTEmitter.html" title="class in net.sf.saxon.serialize">TEXTEmitter</A></B></TD>
<TD>This class generates TEXT output</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/UncommittedSerializer.html" title="class in net.sf.saxon.serialize">UncommittedSerializer</A></B></TD>
<TD>This class is used when the decision on which serialization method to use has to be delayed until the first
element is read.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/UnicodeNormalizer.html" title="class in net.sf.saxon.serialize">UnicodeNormalizer</A></B></TD>
<TD>UnicodeNormalizer: This ProxyReceiver performs unicode normalization on the contents
of attribute and text nodes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/UTF8Writer.html" title="class in net.sf.saxon.serialize">UTF8Writer</A></B></TD>
<TD>Specialized buffering UTF-8 writer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/XHTMLEmitter.html" title="class in net.sf.saxon.serialize">XHTMLEmitter</A></B></TD>
<TD>XHTMLEmitter is an Emitter that generates XHTML output.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/XHTMLURIEscaper.html" title="class in net.sf.saxon.serialize">XHTMLURIEscaper</A></B></TD>
<TD>This class performs URI escaping for the XHTML output method.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/XML10ContentChecker.html" title="class in net.sf.saxon.serialize">XML10ContentChecker</A></B></TD>
<TD>This class is used on the serialization pipeline to check that the document conforms
to XML 1.0 rules.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/XMLEmitter.html" title="class in net.sf.saxon.serialize">XMLEmitter</A></B></TD>
<TD>XMLEmitter is an Emitter that generates XML output
to a specified destination.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../net/sf/saxon/serialize/XMLIndenter.html" title="class in net.sf.saxon.serialize">XMLIndenter</A></B></TD>
<TD>XMLIndenter: This ProxyReceiver indents elements, by adding character data where appropriate.</TD>
</TR>
</TABLE>
<P>
<A NAME="package_description"><!-- --></A><H2>
Package net.sf.saxon.serialize Description
</H2>
<P>
<p>This package contains code for serializing trees using the standard W3C-defined serialization methods
(xml, html, text). Additional Saxon-specific serialization methods are in package <A HREF="../../../../com/saxonica/serialize/package-summary.html"><CODE>com.saxonica.serialize</CODE></A>.</p>
<p>Serialization in Saxon operates as a push-based event pipeline in which the components of the pipeline
implement the <A HREF="../../../../net/sf/saxon/event/Receiver.html" title="interface in net.sf.saxon.event"><CODE>Receiver</CODE></A> interface.
This defines a class that accepts a stream of events, with one method
defined for each kind of event. The events are modelled on the design of SAX, but adapted
to the XPath data model and to the use of Saxon's NamePool. Attributes and namespaces are
notified individually <i>after</i> the start of the relevant element.</p>
<p>The pipeline for serialization is assembled by the <A HREF="../../../../net/sf/saxon/lib/SerializerFactory.html" title="class in net.sf.saxon.lib"><CODE>SerializerFactory</CODE></A> based
on a supplied set of serialization parameters. Only those components needed for the chosen serialization
parameters are included in the pipeline; for example, a Unicode normalizer is inserted at the appropriate
place in the pipeline if Unicode normalization is requested in the serialization parameters.</p>
<p>The immediate output of node constructors in a query or stylesheet goes to a <A HREF="../../../../net/sf/saxon/event/SequenceReceiver.html" title="class in net.sf.saxon.event"><CODE>SequenceReceiver</CODE></A>.
This is a subclass of <code>Receiver</code> that can handle an arbitrary sequence, containing atomic values
as well as nodes. When constructing the content of an element, a <A HREF="../../../../net/sf/saxon/event/ComplexContentOutputter.html" title="class in net.sf.saxon.event"><CODE>ComplexContentOutputter</CODE></A> is used;
when constructing the content of a node such as a text node or attribute, a <code>SequenceOutputter</code>
is used instead.</p>
<p>The final serialization classes are subclasses of <A HREF="../../../../net/sf/saxon/serialize/Emitter.html" title="class in net.sf.saxon.serialize"><CODE>Emitter</CODE></A>, but much of the serialization work
(such as indentation or application of character maps) is done by other classes on the pipeline. These
are generally constructed by extending the <A HREF="../../../../net/sf/saxon/event/ProxyReceiver.html" title="class in net.sf.saxon.event"><CODE>ProxyReceiver</CODE></A> class.</p>
<p>The Emitter is an abstract implementation of the Receiver interface. As well as supporting
the Receiver interface, it provides methods for controlling the destination of serialized output
(a Writer or OutputStream) and for setting serialization properties (in a Properties object).
In practice nearly all the implementations of Receiver are currently subclasses of Emitter,
but this may change in the future.</p>
<p>The package includes emitters for the standard output methods xml, html, and text, and
proxy emitters to allow a sequence of filters to be applied to the output.</p>,
<hr>
<p align="center"><i>Michael H. Kay<br/>
Saxonica Limited<br/>
30 July 2010</i></p>
<P>
<P>
<DL>
</DL>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/s9api/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../net/sf/saxon/serialize/charcode/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/serialize/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
