com.hcl.domino.keep.tools

Class SimpleXMLDoc

java.lang.Object

com.hcl.domino.keep.tools.SimpleXMLDoc

public class SimpleXMLDoc
extends java.lang.Object

Convenience class to write out an XML document using a stream and a SAX parser. A stack is used to keep track of open and closed tag and on document close all tags are properly closed. It doesn’t guarantee the XML you might want or need, but it will be valid XML. The SAX Parser esures correct encoding of the tags and values

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SimpleXMLDoc.Element

Constructor Summary

Constructors

Constructor and Description
SimpleXMLDoc(java.io.OutputStream out) Default constructor, creates empty document

Method Summary

Modifier and Type	Method and Description
SimpleXMLDoc	addCdataElement(SimpleXMLDoc.Element element, java.lang.String elementValue)
SimpleXMLDoc	addCdataElement(java.lang.String elementName, java.lang.String elementValue)
SimpleXMLDoc	addComment(java.lang.String comment) Adds a comment to the result.
SimpleXMLDoc	addEmptyElement(SimpleXMLDoc.Element element)
SimpleXMLDoc	addEmptyElement(java.lang.String elementName)
SimpleXMLDoc	addNamespace(java.lang.String key, java.lang.String uri) Add namespace to a document
SimpleXMLDoc	addSimpleElement(SimpleXMLDoc.Element element, java.lang.String elementValue)
SimpleXMLDoc	addSimpleElement(java.lang.String elementName, java.lang.String elementValue)
void	closeDocument() Closes the document and ensures that all tags are closed
SimpleXMLDoc	closeElement(int howMany)
boolean	closeElement(java.lang.String lastElementToClose)
SimpleXMLDoc	dateElement(SimpleXMLDoc.Element element, java.util.Date date)
SimpleXMLDoc	dateElement(java.lang.String elementName, java.util.Date date)
SimpleXMLDoc.Element	element(java.lang.String name)
java.lang.String	getDocTypePublic()
java.lang.String	getDocTypeSystem()
java.lang.String	getXmlStyleSheet()
SimpleXMLDoc	openElement(SimpleXMLDoc.Element element) Starts a tag with a given tag element that contains name and attributes
SimpleXMLDoc	openElement(java.lang.String elementName)
SimpleXMLDoc	setDocTypePublic(java.lang.String docTypePublic)
SimpleXMLDoc	setDocTypeSystem(java.lang.String docTypeSystem)
SimpleXMLDoc	setXmlStyleSheet(java.lang.String xmlStyleSheet)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleXMLDoc

public SimpleXMLDoc(java.io.OutputStream out)

Default constructor, creates empty document

Parameters:

out - Where the document goes

Method Detail

addCdataElement

public SimpleXMLDoc addCdataElement(SimpleXMLDoc.Element element,
                                    java.lang.String elementValue)

Parameters:

element -

• an XML Element

elementValue -

• Lot of String to encapsulate

Returns:

fluent

addCdataElement

public SimpleXMLDoc addCdataElement(java.lang.String elementName,
                                    java.lang.String elementValue)

Parameters:

elementName -

elementValue -

Returns:

fulent

addComment

public SimpleXMLDoc addComment(java.lang.String comment)

Adds a comment to the result. Comments are only written after the root element, so we cache them if necessary

Parameters:

comment - The comment text

Returns:

fluent

addEmptyElement

public SimpleXMLDoc addEmptyElement(SimpleXMLDoc.Element element)

Parameters:

element - The tag to add

Returns:

fluent SimpleXMLDoc

addEmptyElement

public SimpleXMLDoc addEmptyElement(java.lang.String elementName)

Parameters:

elementName -

Returns:

fluent SimpleXMLDoc

addNamespace

public SimpleXMLDoc addNamespace(java.lang.String key,
                                 java.lang.String uri)

Add namespace to a document

Parameters:

key - Namespace abbreviation without :

uri - Namespace URL

Returns:

fluent SimpleXMLDoc

addSimpleElement

public SimpleXMLDoc addSimpleElement(SimpleXMLDoc.Element element,
                                     java.lang.String elementValue)

Parameters:

element -

elementValue -

Returns:

fluent SimpleXMLDoc

addSimpleElement

public SimpleXMLDoc addSimpleElement(java.lang.String elementName,
                                     java.lang.String elementValue)

Parameters:

elementName -

elementValue -

Returns:

fluent SimpleXMLDoc

closeDocument

public void closeDocument()

Closes the document and ensures that all tags are closed

closeElement

public SimpleXMLDoc closeElement(int howMany)

Parameters:

howMany -

Returns:

fluent

closeElement

public boolean closeElement(java.lang.String lastElementToClose)

Parameters:

lastElementToClose -

Returns:

closes was successful

dateElement

public SimpleXMLDoc dateElement(SimpleXMLDoc.Element element,
                                java.util.Date date)

Parameters:

element -

date -

Returns:

fluent SimpleXMLDoc

dateElement

public SimpleXMLDoc dateElement(java.lang.String elementName,
                                java.util.Date date)

Parameters:

elementName -

date -

Returns:

fluent SimpleXMLDoc

element

public SimpleXMLDoc.Element element(java.lang.String name)

Parameters:

name -

• Name for the tag

Returns:

a new Element with that name

getDocTypePublic

public java.lang.String getDocTypePublic()

Returns:

Public doc type if any

getDocTypeSystem

public java.lang.String getDocTypeSystem()

Returns:

System doctyep if any

getXmlStyleSheet

public java.lang.String getXmlStyleSheet()

Returns:

Stylesheet if any

openElement

public SimpleXMLDoc openElement(SimpleXMLDoc.Element element)

Starts a tag with a given tag element that contains name and attributes

Parameters:

element -

• Element to open

Returns:

Fluent SimpleXMLDoc

openElement

public SimpleXMLDoc openElement(java.lang.String elementName)

Parameters:

elementName -

Returns:

fluent SimpleXMLDoc

setDocTypePublic

public SimpleXMLDoc setDocTypePublic(java.lang.String docTypePublic)

Parameters:

docTypePublic -

Returns:

fluent SimpleXMLDoc

setDocTypeSystem

public SimpleXMLDoc setDocTypeSystem(java.lang.String docTypeSystem)

Parameters:

docTypeSystem -

Returns:

fluent SimpleXMLDoc

setXmlStyleSheet

public SimpleXMLDoc setXmlStyleSheet(java.lang.String xmlStyleSheet)

Parameters:

xmlStyleSheet -

Returns:

fluent SimpleXMLDoc