net.sourceforge.pldoc

Class XMLWriter

java.lang.Object

net.sourceforge.pldoc.XMLWriter

public class XMLWriter
extends Object

Description of the Class

created April 18, 2004

Constructor Summary

Constructors

Constructor and Description
XMLWriter() Constructor for the XMLWriter object
XMLWriter(OutputStream outStream) Constructor for the XMLWriter object

Method Summary

Modifier and Type	Method and Description
void	appendNodeChildren(Node node) Append node to document.
void	cdata(String str) Description of the Method
CDATASection	createCDATASection(String data) Convert data into CDATA.
Element	createElement(String tagName) Create element with name of tagName.
void	element(String name) Convenience method.
void	endDocument() Finalize current Document, writing it out.
void	endElement(String name) Generate end tag.
void	endElementRecursive(String name) Generate end tags for any open tags.
Node	findObjectNode(String schemaName, String objectName) Locate the Schema and the Object in the current DOM.
Document	getDocument() Get the DOM Document written so far.
void	pushAttribute(String name, String value) Add an attribute to the queue.
void	setDocType(String sPublic, String sSystem) Sets the docType attribute of the XMLWriter object
void	setEncoding(String encoding) Set the encoding attribute of the XMLWriter object
void	setIndent(boolean indent) Set the indent attribute of the XMLWriter object
void	setMethod(String method) Set the method attribute of the XMLWriter object
void	startDocument() Start new Document.
void	startElement(String name) Generate start tag.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLWriter

public XMLWriter(OutputStream outStream)
          throws IOException

Constructor for the XMLWriter object

Parameters:

outStream - Description of the Parameter

Throws:

IOException - Description of the Exception

XMLWriter

public XMLWriter()
          throws IOException

Constructor for the XMLWriter object

Throws:

IOException - Description of the Exception

Method Detail

setMethod

public void setMethod(String method)

Set the method attribute of the XMLWriter object

Parameters:

method - The new method value

setEncoding

public void setEncoding(String encoding)

Set the encoding attribute of the XMLWriter object

Parameters:

encoding - The new encoding value

setIndent

public void setIndent(boolean indent)

Set the indent attribute of the XMLWriter object

Parameters:

indent - The new indent value

setDocType

public void setDocType(String sPublic,
                       String sSystem)

Sets the docType attribute of the XMLWriter object

Parameters:

sPublic - The new docType value

sSystem - The new docType value

startDocument

public void startDocument()
                   throws SAXException

Start new Document.

Throws:

SAXException - Description of the Exception

endDocument

public void endDocument()
                 throws SAXException

Finalize current Document, writing it out.

Throws:

SAXException - Description of the Exception

pushAttribute

public void pushAttribute(String name,
                          String value)
                   throws SAXException

Add an attribute to the queue.

Should be called before calling the respective startElement()

.

Parameters:

name - Description of the Parameter

value - Description of the Parameter

Throws:

SAXException - Description of the Exception

startElement

public void startElement(String name)
                  throws SAXException

Generate start tag.

Parameters:

name - Description of the Parameter

Throws:

SAXException - Description of the Exception

endElement

public void endElement(String name)
                throws SAXException

Generate end tag.

Parameters:

name - Description of the Parameter

Throws:

SAXException - Description of the Exception

endElementRecursive

public void endElementRecursive(String name)
                         throws SAXException

Generate end tags for any open tags.

Parameters:

name - Description of the Parameter

Throws:

SAXException - Description of the Exception

element

public void element(String name)
             throws SAXException

Convenience method.

Parameters:

name - Description of the Parameter

Throws:

SAXException - Description of the Exception

cdata

public void cdata(String str)
           throws SAXException

Description of the Method

Parameters:

str - Description of the Parameter

Throws:

SAXException - Description of the Exception

getDocument

public Document getDocument()

Get the DOM Document written so far.

Returns:

current Document

appendNodeChildren

public void appendNodeChildren(Node node)
                        throws SAXException

Append node to document.

Parameters:

node - node whose children to append

Throws:

SAXException - Description of the Exception

findObjectNode

public Node findObjectNode(String schemaName,
                           String objectName)
                    throws SAXException

Locate the Schema and the Object in the current DOM.

Parameters:

schemaName - Oracle Schema name

objectName - Oracle Object name

Returns:

located node

Throws:

SAXException - Description of the Exception

createElement

public Element createElement(String tagName)
                      throws DOMException

Create element with name of tagName.

Parameters:

tagName - text

Returns:

tag as Element

Throws:

DOMException - Description of the Exception

createCDATASection

public CDATASection createCDATASection(String data)
                                throws DOMException

Convert data into CDATA.

Parameters:

data - text

Returns:

text as CDATA

Throws:

DOMException - Description of the Exception