net.sf.saxon.event

Class Emitter

Implemented Interfaces:
Result, Receiver
Known Direct Subclasses:
XMLEmitter

public abstract class Emitter
extends java.lang.Object
implements Result, Receiver

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.

Field Summary

protected boolean
allCharactersEncodable
protected CharacterSet
characterSet
protected NamePool
namePool
protected Properties
outputProperties
protected OutputStream
outputStream
protected PipelineConfiguration
pipelineConfig
protected StreamResult
streamResult
protected String
systemId
protected Writer
writer

Method Summary

Configuration
getConfiguration()
Get the configuration used for this document
Properties
getOutputProperties()
Get the output properties
OutputStream
getOutputStream()
Get the output stream
PipelineConfiguration
getPipelineConfiguration()
Get the pipeline configuration used for this document
String
getSystemId()
Get the System ID
Writer
getWriter()
Get the output writer
protected void
makeWriter()
Make a Writer for this Emitter to use, given a StreamResult.
void
setOutputProperties(Properties details)
Set output properties
void
setOutputStream(OutputStream stream)
Set the output destination as a byte stream
void
setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipelineConfiguration
void
setStreamResult(StreamResult result)
Set the StreamResult acting as the output destination of the Emitter
void
setSystemId(String systemId)
Set the System ID
void
setUnparsedEntity(String name, String uri, String publicId)
Set unparsed entity URI.
void
setWriter(Writer writer)
Set the output destination as a character stream
boolean
usesWriter()
Determine whether the Emitter wants a Writer for character output or an OutputStream for binary output.

Field Details

allCharactersEncodable

protected boolean allCharactersEncodable

characterSet

protected CharacterSet characterSet

namePool

protected NamePool namePool

outputProperties

protected Properties outputProperties

outputStream

protected OutputStream outputStream

pipelineConfig

protected PipelineConfiguration pipelineConfig

streamResult

protected StreamResult streamResult

systemId

protected String systemId

writer

protected Writer writer

Method Details

getConfiguration

public Configuration getConfiguration()
Get the configuration used for this document
Returns:
the configuration

getOutputProperties

public Properties getOutputProperties()
Get the output properties
Returns:
the output serialization properties

getOutputStream

public OutputStream getOutputStream()
Get the output stream
Returns:
the OutputStream being used as an output destination, if any

getPipelineConfiguration

public PipelineConfiguration getPipelineConfiguration()
Get the pipeline configuration used for this document
Specified by:
getPipelineConfiguration in interface Receiver

getSystemId

public String getSystemId()
Get the System ID

getWriter

public Writer getWriter()
Get the output writer
Returns:
the Writer being used as an output destination, if any

makeWriter

protected void makeWriter()
            throws XPathException
Make a Writer for this Emitter to use, given a StreamResult.

setOutputProperties

public void setOutputProperties(Properties details)
            throws XPathException
Set output properties
Parameters:
details - the output serialization properties

setOutputStream

public void setOutputStream(OutputStream stream)
            throws XPathException
Set the output destination as a byte stream
Parameters:
stream - the OutputStream being used as an output destination

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)
Set the pipelineConfiguration
Specified by:
setPipelineConfiguration in interface Receiver

setStreamResult

public void setStreamResult(StreamResult result)
            throws XPathException
Set the StreamResult acting as the output destination of the Emitter
Parameters:
result - the output destination

setSystemId

public void setSystemId(String systemId)
Set the System ID
Specified by:
setSystemId in interface Receiver
Parameters:
systemId - the system identifier (=base URI)

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
Parameters:
name - the entity name
uri - the entity system ID
publicId - the entity public ID

setWriter

public void setWriter(Writer writer)
            throws XPathException
Set the output destination as a character stream
Parameters:
writer - the Writer to use as an output destination

usesWriter

public boolean usesWriter()
Determine whether the Emitter wants a Writer for character output or an OutputStream for binary output. The standard Emitters all use a Writer, so this returns true; but a subclass can override this if it wants to use an OutputStream
Returns:
true if a Writer is needed, as distinct from an OutputStream