This package contains code for serializing trees using the standard W3C-defined serialization methods
(xml, html, text, etc). Additional Saxon-specific serialization methods are in package
Serialization in Saxon operates as a push-based event pipeline in which the components of the pipeline
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 after the start of the relevant element.
The pipeline for serialization is assembled by the
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.
The immediate output of node constructors in a query or stylesheet goes to a
This is a subclass of
Receiver that can handle an arbitrary sequence, containing atomic values
as well as nodes. When constructing the content of an element, a
when constructing the content of a node such as a text node or attribute, a
is used instead.
The final serialization classes are subclasses of
Emitter, but much of the
(such as indentation or application of character maps) is done by other classes on the pipeline. These
are generally constructed by extending the
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.
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.,
Interface Summary Interface Description CharacterReferenceGeneratorA class that expands a character to a character reference, entity reference, etc, and writes the resulting reference to a writer
Class Summary Class Description AdaptiveEmitterThis class implements the Adaptive serialization method defined in XSLT+XQuery Serialization 3.1. BinaryTextDecoderThis class generates decodes processing instructions in text output that represent text encoded in base64 binary or hexBinary CDATAFilterCDATAFilter: This ProxyReceiver converts character data to CDATA sections, if the character data belongs to one of a set of element types to be handled this way. CharacterMapThis class defines a character map, that is, a mapping from characters to strings used by the serializer when mapping individual characters in the output. CharacterMapExpanderCharacterMapExpander: This ProxyReceiver expands characters occurring in a character map, as specified by the XSLT 2.0 xsl:character-map declaration CharacterMapIndexThis class represents a set of named character maps. EmitterEmitter: This abstract class defines methods that must be implemented by components that format SAXON output. ExpandedStreamResultAn ExpandedStreamResult is similar to a StreamResult, and is created from a StreamResult. HexCharacterReferenceGeneratorA class that represents a character as a hexadecimal character reference and writes the result to a supplied Writer HTML40EmitterThis class generates HTML 4.0 output HTML50EmitterThis class generates HTML 5.0 output HTMLEmitterThis class generates HTML output HTMLIndenterHTMLIndenter: This ProxyReceiver indents HTML elements, by adding whitespace character data where appropriate. HTMLTagHashSetA simple class for testing membership of a fixed set of case-insensitive ASCII strings. HTMLURIEscaperThis class is used as a filter on the serialization pipeline; it performs the function of escaping URI-valued attributes in HTML JSONEmitterThis class implements the back-end text generation of the JSON serialization method. JSONSerializerThis class implements the JSON serialization method defined in XSLT+XQuery Serialization 3.1. MessageEmitterMessageEmitter is the default Receiver for xsl:message output. MessageWarnerMessageWarner is a user-selectable receiver for XSLT xsl:message output. MetaTagAdjusterThe 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 PrincipalOutputGatekeeperThis class is added to the output pipeline for the principal result destination for a transformation if the transformation uses xsl:result-document instructions. SerializationParamsHandlerThis class handles a set of serialization parameters provided in the form of an XDM instance as specified in the Serialization 3.0 definition, section 3.1 SerializationPropertiesDefine a set of serialization properties. TEXTEmitterThis class generates TEXT output UncommittedSerializerThis class is used when the decision on which serialization method to use has to be delayed until the first element is read. UnicodeNormalizerUnicodeNormalizer: This ProxyReceiver performs unicode normalization on the contents of attribute and text nodes. UTF8WriterSpecialized buffering UTF-8 writer. XHTML1EmitterXHTMLEmitter is an Emitter that generates XHTML 1 output. XHTML5EmitterXHTML5Emitter is an Emitter that generates XHTML 5 output. XHTMLPrefixRemoverFilter to change elements in the XHTML, SVG, or MathML namespaces so they have no prefix (that is, to make these the default namespace). XHTMLURIEscaperThis class performs URI escaping for the XHTML output method. XML10ContentCheckerThis class is used on the serialization pipeline to check that the document conforms to XML 1.0 rules. XMLEmitterXMLEmitter is an Emitter that generates XML output to a specified destination. XMLIndenterXMLIndenter: This ProxyReceiver indents elements, by adding character data where appropriate.