public abstract class Emitter extends Object implements Result, Receiver
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.
Modifier and Type | Field and Description |
---|---|
protected CharacterSet |
characterSet |
protected NamePool |
namePool |
protected Properties |
outputProperties |
protected OutputStream |
outputStream |
protected PipelineConfiguration |
pipelineConfig |
protected StreamResult |
streamResult |
protected String |
systemId |
protected Writer |
writer |
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
Constructor and Description |
---|
Emitter() |
Modifier and Type | Method and Description |
---|---|
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
|
static Receiver |
makeEmitter(String className,
Controller controller)
Load a named output emitter or SAX2 ContentHandler and check it is OK.
|
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 namePool in which all name codes can be found
|
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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
attribute, characters, close, comment, endDocument, endElement, namespace, open, processingInstruction, startContent, startDocument, startElement
protected PipelineConfiguration pipelineConfig
protected NamePool namePool
protected String systemId
protected StreamResult streamResult
protected Writer writer
protected OutputStream outputStream
protected Properties outputProperties
protected CharacterSet characterSet
public void setPipelineConfiguration(PipelineConfiguration pipe)
setPipelineConfiguration
in interface Receiver
public PipelineConfiguration getPipelineConfiguration()
getPipelineConfiguration
in interface Receiver
public Configuration getConfiguration()
public void setSystemId(String systemId)
setSystemId
in interface Result
setSystemId
in interface Receiver
public String getSystemId()
getSystemId
in interface Result
public void setOutputProperties(Properties details) throws XPathException
XPathException
public Properties getOutputProperties()
public void setStreamResult(StreamResult result) throws XPathException
XPathException
protected void makeWriter() throws XPathException
XPathException
public boolean usesWriter()
public void setWriter(Writer writer)
public Writer getWriter()
public void setOutputStream(OutputStream stream) throws XPathException
XPathException
public OutputStream getOutputStream()
public void setUnparsedEntity(String name, String uri, String publicId) throws XPathException
setUnparsedEntity
in interface Receiver
name
- The name of the unparsed entityuri
- The system identifier of the unparsed entitypublicId
- The public identifier of the unparsed entityXPathException
public static Receiver makeEmitter(String className, Controller controller) throws XPathException
XPathException