org.pfsw.pax

Class XMLWriteController

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.pfsw.pax.BaseXMLTagInterpreterController

org.pfsw.pax.XMLWriteController

All Implemented Interfaces:

XMLTagInterpreterController, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class XMLWriteController
extends BaseXMLTagInterpreterController

This is the controller for wriring a DOM tree to an XML stream.

Field Summary

Fields inherited from interface org.pfsw.pax.XMLTagInterpreterController

PROP_LEXICAL_HANDLER

Constructor Summary

Constructors

Constructor and Description
XMLWriteController(org.xml.sax.XMLReader xmlReader, java.io.Writer writer) Initialize the new instance with the given XML reader and writer.

Method Summary

Modifier and Type	Method and Description
protected XMLTagInterpreterFactory	createTagInterpreterFactory() Returns a new instance of a tag interpreter factory.
void	endDocument() Receive notification of the end of a document.
int	getIndentIncrement() Returns the number of spaces that are additionally prepended per hierarchy level on each line.
protected XMLTagInterpreter	getInterpreterFor(java.lang.String tagName) Returns an instance of a tag interpreter class corresponding to the specified tag name.
protected MarkupWriter	getWriter()
protected void	handleFinalResult(java.lang.Object result) This method is called, when the end tag of the document was reached.
void	setIndentIncrement(int increment) Sets the number of spaces that are additionally prepended per hierarchy level on each line.
protected void	setWriter(MarkupWriter newValue)
void	useDoubleQuotes() Configures the writer to write double quotes ( " ) around attribute values.
void	useSingleQuotes() Configures the writer to write single quotes ( ' ) around attribute values.

Methods inherited from class org.pfsw.pax.BaseXMLTagInterpreterController

getInterpreterFactory, getInterpreterStack, getLexicalHandlerHolder, getReader, getXmlReader, initLexicalHandler, isLexicalHandlerSupported, isStackEmpty, peekStack, popFromStack, putOnStack, restartInterpreter, returnControl, setInterpreterFactory, setInterpreterStack, setLexicalHandlerHolder, setLexicalHandlerSupported, setReader, setXmlReader, startElement, startElement, startInterpreter, trace

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

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, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping

Constructor Detail

XMLWriteController

public XMLWriteController(org.xml.sax.XMLReader xmlReader,
                          java.io.Writer writer)

Initialize the new instance with the given XML reader and writer.

Method Detail

useSingleQuotes

public void useSingleQuotes()

Configures the writer to write single quotes ( ' ) around attribute values.

useDoubleQuotes

public void useDoubleQuotes()

Configures the writer to write double quotes ( " ) around attribute values.

endDocument

public void endDocument()

Receive notification of the end of a document.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

getIndentIncrement

public int getIndentIncrement()

Returns the number of spaces that are additionally prepended per hierarchy level on each line.

setIndentIncrement

public void setIndentIncrement(int increment)

Sets the number of spaces that are additionally prepended per hierarchy level on each line.

handleFinalResult

protected void handleFinalResult(java.lang.Object result)

This method is called, when the end tag of the document was reached.
It gets the result of the last tag interpreter.

Specified by:

handleFinalResult in class BaseXMLTagInterpreterController

Parameters:

result - The result of the all embracing document tag.

createTagInterpreterFactory

protected XMLTagInterpreterFactory createTagInterpreterFactory()

Returns a new instance of a tag interpreter factory.
This method is called during initialization of the controller. Its returned object is put into the variable interpreterFactory.

Specified by:

createTagInterpreterFactory in class BaseXMLTagInterpreterController

getInterpreterFor

protected XMLTagInterpreter getInterpreterFor(java.lang.String tagName)
                                       throws org.xml.sax.SAXException

Returns an instance of a tag interpreter class corresponding to the specified tag name. Here it is always the receiver itself.

Overrides:

getInterpreterFor in class BaseXMLTagInterpreterController

Parameters:

tagName - The name of the tag, the interpreter is looked up for.

Returns:

The tag interpreter instance or null, if the tag isn't supported.

Throws:

org.xml.sax.SAXException

getWriter

protected MarkupWriter getWriter()

setWriter

protected void setWriter(MarkupWriter newValue)