|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object | +--net.sf.saxon.event.Emitter
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 CharacterSet |
characterSet
|
protected Configuration |
config
|
protected NamePool |
namePool
|
protected java.util.Properties |
outputProperties
|
protected java.io.OutputStream |
outputStream
|
protected javax.xml.transform.stream.StreamResult |
streamResult
|
protected java.lang.String |
systemId
|
protected java.io.Writer |
writer
|
| Fields inherited from interface javax.xml.transform.Result |
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING |
| Constructor Summary | |
Emitter()
|
|
| Method Summary | |
Configuration |
getConfiguration()
Get the namepool used for this document |
LocationProvider |
getDocumentLocator()
Get the Document Locator |
java.util.Properties |
getOutputProperties()
Get the output properties |
java.io.OutputStream |
getOutputStream()
Get the output stream |
java.lang.String |
getSystemId()
Get the System ID |
java.io.Writer |
getWriter()
Get the output writer |
static Emitter |
makeEmitter(java.lang.String className)
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 |
setConfiguration(Configuration config)
Set the namePool in which all name codes can be found |
void |
setDocumentLocator(LocationProvider locator)
Set locator, to identify position in the document. |
void |
setOutputProperties(java.util.Properties details)
Set output properties |
void |
setOutputStream(java.io.OutputStream stream)
Set the output destination as a byte stream |
void |
setStreamResult(javax.xml.transform.stream.StreamResult result)
Set the StreamResult acting as the output destination of the Emitter |
void |
setSystemId(java.lang.String systemId)
Set the System ID |
void |
setUnparsedEntity(java.lang.String name,
java.lang.String uri,
java.lang.String publicId)
Set unparsed entity URI. |
void |
setWriter(java.io.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. |
| 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 |
attribute, characters, close, comment, endDocument, endElement, namespace, open, processingInstruction, startContent, startDocument, startElement |
| Field Detail |
protected Configuration config
protected NamePool namePool
protected java.lang.String systemId
protected javax.xml.transform.stream.StreamResult streamResult
protected java.io.Writer writer
protected java.io.OutputStream outputStream
protected java.util.Properties outputProperties
protected CharacterSet characterSet
| Constructor Detail |
public Emitter()
| Method Detail |
public void setConfiguration(Configuration config)
setConfiguration in interface Receiverpublic Configuration getConfiguration()
getConfiguration in interface Receiverpublic void setSystemId(java.lang.String systemId)
setSystemId in interface javax.xml.transform.Resultpublic java.lang.String getSystemId()
getSystemId in interface javax.xml.transform.Result
public void setOutputProperties(java.util.Properties details)
throws XPathException
XPathExceptionpublic java.util.Properties getOutputProperties()
public void setStreamResult(javax.xml.transform.stream.StreamResult result)
protected void makeWriter()
throws XPathException
XPathExceptionpublic boolean usesWriter()
public void setWriter(java.io.Writer writer)
public java.io.Writer getWriter()
public void setOutputStream(java.io.OutputStream stream)
throws XPathException
XPathExceptionpublic java.io.OutputStream getOutputStream()
public void setDocumentLocator(LocationProvider locator)
setDocumentLocator in interface Receiverpublic LocationProvider getDocumentLocator()
getDocumentLocator in interface Receiver
public void setUnparsedEntity(java.lang.String name,
java.lang.String uri,
java.lang.String publicId)
throws XPathException
setUnparsedEntity in interface Receivername - The name of the unparsed entityuri - The system identifier of the unparsed entitypublicId - The public identifier of the unparsed entity
XPathException
public static Emitter makeEmitter(java.lang.String className)
throws XPathException
XPathException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||