net.sf.saxon.event
Class Emitter
java.lang.Object
net.sf.saxon.event.Emitter
- Result, Receiver
public abstract class Emitter
extends java.lang.Object
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.
allCharactersEncodable
protected boolean allCharactersEncodable
outputProperties
protected Properties outputProperties
outputStream
protected OutputStream outputStream
streamResult
protected StreamResult streamResult
systemId
protected String systemId
writer
protected Writer writer
getConfiguration
public Configuration getConfiguration()
Get the configuration used for this document
getOutputProperties
public Properties getOutputProperties()
Get the output properties
- the output serialization properties
getOutputStream
public OutputStream getOutputStream()
Get the output stream
- the OutputStream being used as an output destination, if any
getSystemId
public String getSystemId()
Get the System ID
getWriter
public Writer getWriter()
Get the output writer
- 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
details
- the output serialization properties
setOutputStream
public void setOutputStream(OutputStream stream)
throws XPathException
Set the output destination as a byte stream
stream
- the OutputStream being used as an output destination
setStreamResult
public void setStreamResult(StreamResult result)
throws XPathException
Set the StreamResult acting as the output destination of the Emitter
result
- the output destination
setSystemId
public void setSystemId(String systemId)
Set the System ID
- setSystemId in interface Receiver
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.
- setUnparsedEntity in interface Receiver
name
- the entity nameuri
- the entity system IDpublicId
- the entity public ID
setWriter
public void setWriter(Writer writer)
throws XPathException
Set the output destination as a character stream
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
- true if a Writer is needed, as distinct from an OutputStream