net.sf.joost.emitter
Class StreamEmitter

java.lang.Object
  net.sf.joost.emitter.StxEmitterBase
      net.sf.joost.emitter.StreamEmitter

All Implemented Interfaces:

Constants, ContentHandler, LexicalHandler, StxEmitter

Direct Known Subclasses:

HtmlEmitter, TextEmitter, XmlEmitter

public abstract class StreamEmitter

extends StxEmitterBase

implements Constants

Base class for emitter classes that produce a character stream.

Version:

$Revision: 1.26 $ $Date: 2005/03/13 17:12:49 $

Author:

Oliver Becker

Field Summary

protected CharsetEncoder	charsetEncoder Encoder for the chosen encoding
protected String	encoding The used output encoding
private static String	HTML_METHOD Joost's HTML extension output method
private static org.apache.commons.logging.Log	log
protected Writer	writer Writer for the resulting text

Fields inherited from class net.sf.joost.emitter.StxEmitterBase

Fields inherited from interface net.sf.joost.Constants

DEBUG, DEFAULT_ENCODING, FEAT_NS, FEAT_NSPREFIX, FEATURE_URI_PREFIX, FUNC_NS, JOOST_EXT_NS, PR_ATTRIBUTES, PR_BUFFER, PR_CHILDREN, PR_CONTINUE, PR_ERROR, PR_SELF, PR_SIBLINGS, STX_NS

Constructor Summary

StreamEmitter(Writer writer, String encoding)

Method Summary

void	comment(char[] ch, int start, int length) Does nothing
void	endCDATA() Does nothing
void	endDTD() Does nothing
void	endEntity(String name) Won't be called
void	endPrefixMapping(String prefix) Does nothing
void	ignorableWhitespace(char[] p0, int p1, int p2) Won't be called
static StreamEmitter	newEmitter(OutputStream out, Properties outputProperties) Creates an emitter using a given OutputStream and a set of output properties.
static StreamEmitter	newEmitter(String filename, Properties outputProperties) Creates an emitter that writes to a given file, using a set of output properties.
static StreamEmitter	newEmitter(Writer writer, String encoding, Properties outputProperties) Creates an emitter using a given Writer, an output encoding and a set of output properties.
static StreamEmitter	newXMLEmitter(Writer writer) Creates an XML emitter using a given Writer and the default output encoding (Constants.DEFAULT_ENCODING).
void	processingInstruction(String target, String data) Does nothing
void	setDocumentLocator(Locator locator) Does nothing
void	setOmitXmlDeclaration(boolean flag) Defines whether the XML declaration should be written
void	skippedEntity(String value) Won't be called
void	startCDATA() Does nothing
void	startDTD(String name, String publicId, String systemId) Does nothing
void	startEntity(String name) Won't be called
void	startPrefixMapping(String prefix, String uri) Does nothing

Methods inherited from class net.sf.joost.emitter.StxEmitterBase

getSystemId, setSystemId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, startDocument, startElement

Field Detail

log

private static org.apache.commons.logging.Log log

HTML_METHOD

private static String HTML_METHOD

Joost's HTML extension output method

writer

protected Writer writer

Writer for the resulting text

encoding

protected String encoding

The used output encoding

charsetEncoder

protected CharsetEncoder charsetEncoder

Encoder for the chosen encoding

Constructor Detail

StreamEmitter

public StreamEmitter(Writer writer,
                     String encoding)

Method Detail

newEmitter

public static StreamEmitter newEmitter(Writer writer,
                                       String encoding,
                                       Properties outputProperties)

Creates an emitter using a given Writer, an output encoding and a set of output properties. The value of the OutputKeys.METHOD property determines the returned emitter object.

Parameters:

writer - A Writer for receiving the output.

encoding - the encoding used in the writer resp. that should be used for the encoding declaration

outputProperties - The set of output properties to be used.

Returns:

a proper stream emitter object

newEmitter

public static StreamEmitter newEmitter(OutputStream out,
                                       Properties outputProperties)
                                throws IOException

Creates an emitter using a given OutputStream and a set of output properties. The value of the OutputKeys.ENCODING property defines the encoding for to used. The value of the OutputKeys.METHOD property determines the returned emitter object.

Parameters:

out - An OutputStream for receiving the output.

outputProperties - The set of output properties to be used.

Returns:

a proper stream emitter object

Throws:

IOException - When an error occurs while accessing OutputStream.

newXMLEmitter

public static StreamEmitter newXMLEmitter(Writer writer)

Creates an XML emitter using a given Writer and the default output encoding (Constants.DEFAULT_ENCODING).

Parameters:

writer - A Writer for receiving the output.

Returns:

a proper XML emitter object

newEmitter

public static StreamEmitter newEmitter(String filename,
                                       Properties outputProperties)
                                throws IOException

Creates an emitter that writes to a given file, using a set of output properties. The value of the OutputKeys.ENCODING property defines the encoding for to used. The value of the OutputKeys.METHOD property determines the returned emitter object.

Parameters:

filename - The name of the output file.

outputProperties - The set of output properties to be used.

Returns:

a proper stream emitter object

Throws:

IOException - When an error occurs while opening the file.

setOmitXmlDeclaration

public void setOmitXmlDeclaration(boolean flag)

Defines whether the XML declaration should be written

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Does nothing

Specified by:

startPrefixMapping in interface ContentHandler

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)

Does nothing

Specified by:

endPrefixMapping in interface ContentHandler

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Does nothing

Specified by:

processingInstruction in interface ContentHandler

Throws:

SAXException

skippedEntity

public void skippedEntity(String value)

Won't be called

Specified by:

skippedEntity in interface ContentHandler

ignorableWhitespace

public void ignorableWhitespace(char[] p0,
                                int p1,
                                int p2)

Won't be called

Specified by:

ignorableWhitespace in interface ContentHandler

setDocumentLocator

public void setDocumentLocator(Locator locator)

Does nothing

Specified by:

setDocumentLocator in interface ContentHandler

startDTD

public void startDTD(String name,
                     String publicId,
                     String systemId)

Does nothing

Specified by:

startDTD in interface LexicalHandler

endDTD

public void endDTD()

Does nothing

Specified by:

endDTD in interface LexicalHandler

startEntity

public void startEntity(String name)

Won't be called

Specified by:

startEntity in interface LexicalHandler

endEntity

public void endEntity(String name)

Won't be called

Specified by:

endEntity in interface LexicalHandler

startCDATA

public void startCDATA()
                throws SAXException

Does nothing

Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Does nothing

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException

comment

public void comment(char[] ch,
                    int start,
                    int length)
             throws SAXException

Does nothing

Specified by:

comment in interface LexicalHandler

Throws:

SAXException