Package net.sf.saxon.serialize

Class Emitter

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.serialize.Emitter

All Implemented Interfaces:

Result, Receiver, ReceiverWithOutputProperties

Direct Known Subclasses:

BinaryEmitter, XMLEmitter

public abstract class Emitter
extends SequenceReceiver
implements ReceiverWithOutputProperties

Emitter: This abstract class defines methods that must be implemented by components that format SAXON output. There is one emitter for XML, one for HTML, and so on. Additional methods are concerned with setting options and providing a Writer.

The interface is deliberately designed to be as close as possible to the standard SAX2 ContentHandler interface, however, it allows additional information to be made available.

An Emitter is a Receiver, specifically it is a Receiver that can direct output to a Writer or OutputStream, using serialization properties defined in a Properties object.

The Emitter (from 11.0 onwards) writes to a UnicodeWriter, which may itself bridge to a Writer or OutputStream.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allCharactersEncodable
protected CharacterSet	characterSet
protected Properties	outputProperties
protected UnicodeWriter	writer

Fields inherited from class net.sf.saxon.event.SequenceReceiver

pipelineConfiguration, previousAtomic, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor	Description
Emitter()

Method Summary

Modifier and Type	Method	Description
void	append(Item item, Location locationId, int copyNamespaces)	Append an arbitrary item (node or atomic value) to the output
void	close()	Notify the end of the event stream
Properties	getOutputProperties()	Get the output properties
void	setMustClose(boolean mustClose)	Set a flag indicating that the unicode writer must be closed after use.
void	setOutputProperties(Properties details)	Set output properties
void	setUnicodeWriter(UnicodeWriter unicodeWriter)	Set the output destination to which the emitter's output will be written
void	setUnparsedEntity(String name, String uri, String publicId)	Set unparsed entity URI.
boolean	usesTypeAnnotations()	Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events

Methods inherited from class net.sf.saxon.event.SequenceReceiver

append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getNamePool, getPipelineConfiguration, getSystemId, handlesAppend, open, setPipelineConfiguration, setSystemId

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.event.Receiver

append, characters, comment, endDocument, endElement, getPipelineConfiguration, handlesAppend, open, processingInstruction, setPipelineConfiguration, startDocument, startElement

Methods inherited from interface javax.xml.transform.Result

getSystemId, setSystemId

Field Details

writer

protected UnicodeWriter writer

outputProperties

protected Properties outputProperties

characterSet

protected CharacterSet characterSet

allCharactersEncodable

protected boolean allCharactersEncodable

Constructor Details

Emitter

public Emitter()

Method Details

setOutputProperties

public void setOutputProperties(Properties details)
                         throws XPathException

Set output properties

Parameters:

details - the output serialization properties

Throws:

XPathException - if an error occurs finding the encoding property

getOutputProperties

public Properties getOutputProperties()

Get the output properties

Specified by:

getOutputProperties in interface ReceiverWithOutputProperties

Returns:

the output serialization properties. The returned value will be null if setOutputProperties() has not been called

setUnicodeWriter

public void setUnicodeWriter(UnicodeWriter unicodeWriter)

Set the output destination to which the emitter's output will be written

Parameters:

unicodeWriter - the output destination

setMustClose

public void setMustClose(boolean mustClose)

Set a flag indicating that the unicode writer must be closed after use. This will generally be true if the writer was created by Saxon, and false if it was supplied by the user

Parameters:

mustClose - true if the unicode writer is to be closed after use.

setUnparsedEntity

public void setUnparsedEntity(String name,
 String uri,
 String publicId)
                       throws XPathException

Set unparsed entity URI. Needed to satisfy the Receiver interface, but not used, because unparsed entities can occur only in input documents, not in output documents.

Specified by:

setUnparsedEntity in interface Receiver

Overrides:

setUnparsedEntity in class SequenceReceiver

Parameters:

name - the entity name

uri - the entity system ID

publicId - the entity public ID

Throws:

XPathException - if an error occurs

close

public void close()
           throws XPathException

Notify the end of the event stream

Specified by:

close in interface Receiver

Throws:

XPathException - if an error occurs

usesTypeAnnotations

public boolean usesTypeAnnotations()

Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events

Specified by:

usesTypeAnnotations in interface Receiver

Returns:

true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation (or conversely, it may avoid stripping unwanted type annotations)

append

public void append(Item item,
 Location locationId,
 int copyNamespaces)
            throws XPathException

Append an arbitrary item (node or atomic value) to the output

Specified by:

append in interface Receiver

Specified by:

append in class SequenceReceiver

Parameters:

item - the item to be appended

locationId - the location of the calling instruction, for diagnostics

copyNamespaces - if the item is an element node, this indicates whether its namespaces need to be copied. Values are ReceiverOption.ALL_NAMESPACES; the default (0) means

Throws:

XPathException - if an error occurs