uk.ac.ed.epcc.webapp.content

Class XMLDomBuilder

java.lang.Object

uk.ac.ed.epcc.webapp.content.XMLDomBuilder

All Implemented Interfaces:

SimpleXMLBuilder

Direct Known Subclasses:

NestedXMLBuilder

public class XMLDomBuilder
extends java.lang.Object
implements SimpleXMLBuilder

A SimpleXMLBuilder that modifies a DocumentFragment

Constructor Summary

Constructors

Constructor and Description
XMLDomBuilder(org.w3c.dom.DocumentFragment fragment)

Method Summary

Modifier and Type	Method and Description
void	addString(java.lang.String s)
XMLDomBuilder	appendParent() Append the contents of this builder to the parent (if any).
SimpleXMLBuilder	attr(java.lang.String name, java.lang.CharSequence s) Add an attribute.
SimpleXMLBuilder	clean(char c)
SimpleXMLBuilder	clean(java.lang.CharSequence s) append text to the document escaping any characters that might be interpreted as XML markup.
SimpleXMLBuilder	clean(java.lang.Number i) Append text representation of the number
SimpleXMLBuilder	close() close the last opened tag.
org.w3c.dom.DocumentFragment	getFragment()
SimpleXMLBuilder	getNested() Get a new SimpleXMLBuilder of the same type as this object.
SimpleXMLBuilder	getParent() Get the parent object.
SimpleXMLBuilder	open(java.lang.String tag) open a tag
SimpleXMLBuilder	open(java.lang.String tag, java.lang.String[][] attr) open a tag with attributes.
boolean	setEscapeUnicode(boolean escape_unicode) Should high code-point unicode characters be escaped to avoid charset problems.
void	setNameSpace(java.lang.String ns)
void	setPrefix(java.lang.String prefix)

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.content.SimpleXMLBuilder

addObject, attr

Constructor Detail

XMLDomBuilder

public XMLDomBuilder(org.w3c.dom.DocumentFragment fragment)

Method Detail

setNameSpace

public void setNameSpace(java.lang.String ns)

setPrefix

public void setPrefix(java.lang.String prefix)

getFragment

public org.w3c.dom.DocumentFragment getFragment()

clean

public SimpleXMLBuilder clean(java.lang.CharSequence s)

Description copied from interface: SimpleXMLBuilder

append text to the document escaping any characters that might be interpreted as XML markup.

Specified by:

clean in interface SimpleXMLBuilder

Returns:

reference to self.

addString

public void addString(java.lang.String s)

clean

public SimpleXMLBuilder clean(char c)

Specified by:

clean in interface SimpleXMLBuilder

clean

public SimpleXMLBuilder clean(java.lang.Number i)

Description copied from interface: SimpleXMLBuilder

Append text representation of the number

Specified by:

clean in interface SimpleXMLBuilder

Parameters:

i - Number to format

Returns:

reference to self

close

public SimpleXMLBuilder close()

Description copied from interface: SimpleXMLBuilder

close the last opened tag.

Specified by:

close in interface SimpleXMLBuilder

Returns:

reference to self

open

public SimpleXMLBuilder open(java.lang.String tag)

Description copied from interface: SimpleXMLBuilder

open a tag

Specified by:

open in interface SimpleXMLBuilder

Returns:

reference to self

open

public SimpleXMLBuilder open(java.lang.String tag,
                             java.lang.String[][] attr)

Description copied from interface: SimpleXMLBuilder

open a tag with attributes. attribute values are escaped

Specified by:

open in interface SimpleXMLBuilder

Parameters:

tag - tag to open

attr - array of name,value pairs

Returns:

reference to self

attr

public SimpleXMLBuilder attr(java.lang.String name,
                             java.lang.CharSequence s)

Description copied from interface: SimpleXMLBuilder

Add an attribute. It is only legal to call this after a call to open and before close or clean.

Specified by:

attr in interface SimpleXMLBuilder

Parameters:

name - String attribute name

s - CharSequence attribute value or null for no value

Returns:

reference to self

getNested

public SimpleXMLBuilder getNested()
                           throws java.lang.UnsupportedOperationException

Description copied from interface: SimpleXMLBuilder

Get a new SimpleXMLBuilder of the same type as this object. This is to build un-commited content that is appended to this object using the SimpleXMLBuilder.appendParent() method. The calling code need only hold a reference to the current builder as the SimpleXMLBuilder.appendParent() method returns the parent.

Specified by:

getNested in interface SimpleXMLBuilder

Returns:

SimpleXMLBuilder

Throws:

java.lang.UnsupportedOperationException

appendParent

public XMLDomBuilder appendParent()
                           throws java.lang.UnsupportedOperationException

Description copied from interface: SimpleXMLBuilder

Append the contents of this builder to the parent (if any).

Specified by:

appendParent in interface SimpleXMLBuilder

Returns:

the parent

Throws:

java.lang.UnsupportedOperationException

getParent

public SimpleXMLBuilder getParent()

Description copied from interface: SimpleXMLBuilder

Get the parent object.

Specified by:

getParent in interface SimpleXMLBuilder

Returns:

parent

setEscapeUnicode

public boolean setEscapeUnicode(boolean escape_unicode)

Description copied from interface: SimpleXMLBuilder

Should high code-point unicode characters be escaped to avoid charset problems. This is advisory only the implementation is free to ignore this call and return false in all cases.

Specified by:

setEscapeUnicode in interface SimpleXMLBuilder

Returns:

previous setting.