com.ausregistry.jtoolkit2.xml

Class XMLWriter

java.lang.Object

com.ausregistry.jtoolkit2.xml.XMLWriter

Direct Known Subclasses:

EPPWriter

public abstract class XMLWriter
extends java.lang.Object

An XMLWriter provides a simple interface to build a DOM tree and serialize it to XML format. XMLWriters are namespace aware and may be configured to validate the generated XML. Uses the maintenance, support and user level loggers.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	encoding
protected java.util.logging.Logger	maintLogger
protected boolean	standalone
protected java.util.logging.Logger	supportLogger
protected java.util.logging.Logger	userLogger
protected java.lang.String	version
protected java.lang.String	xml

Constructor Summary

Constructors

Constructor and Description
XMLWriter()

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Element	appendChild(org.w3c.dom.Element parent, java.lang.String name) Append a new child element to the specified element.
org.w3c.dom.Element	appendChild(org.w3c.dom.Element parent, java.lang.String name, java.lang.String uri) Append a new child element to the specified element.
org.w3c.dom.Element	appendChild(org.w3c.dom.Element parent, java.lang.String name, java.lang.String[] attrNames, java.lang.String[] attrValues) Append a DOM Element with the given name and attributes to the specified parent Element.
org.w3c.dom.Element	appendChild(org.w3c.dom.Element parent, java.lang.String name, java.lang.String attrName, java.lang.String attrValue) Append a DOM Element with the given name and attribute to the specified parent Element.
org.w3c.dom.Element	appendChild(org.w3c.dom.Element parent, java.lang.String name, java.lang.String value, java.lang.String attrName, java.lang.String attrValue) Append a DOM Element with the given name, text content value and attribute to the specified parent Element.
org.w3c.dom.Element	appendChild(org.w3c.dom.Element parent, java.lang.String name, java.lang.String uri, java.lang.String value, java.lang.String[] attrNames, java.lang.String[] attrValues) Append a DOM Element with the given name and attributes to the specified parent Element.
void	appendChildren(org.w3c.dom.Element parent, java.lang.String name, java.lang.String[] values) Append multiple DOM Elements to the given Element, each having a specified text content.
protected abstract org.w3c.dom.Element	createElement(java.lang.String uri, java.lang.String name)
abstract org.w3c.dom.Element	getRoot() Get the root element of the DOM tree associated with this writer.
protected abstract XMLBuilder	getXMLBuilder()
protected abstract boolean	isParserValidating()
static XMLWriter	newInstance() Get an instance of the default implementation of XMLWriter.
protected abstract javax.xml.parsers.SAXParser	newSAXParser()
protected abstract void	setRoot(org.w3c.dom.Element newRoot) Set the root element of the DOM tree associated with this writer.
java.lang.String	toXML(XmlOutputConfig xmlOutputConfig) Serialize to XML format the DOM tree currently associated with this XMLWriter.

Methods inherited from class java.lang.Object

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

Field Detail

xml

protected java.lang.String xml

version

protected java.lang.String version

encoding

protected java.lang.String encoding

standalone

protected boolean standalone

supportLogger

protected java.util.logging.Logger supportLogger

userLogger

protected java.util.logging.Logger userLogger

maintLogger

protected java.util.logging.Logger maintLogger

Constructor Detail

XMLWriter

public XMLWriter()

Method Detail

newInstance

public static XMLWriter newInstance()

Get an instance of the default implementation of XMLWriter.

getRoot

public abstract org.w3c.dom.Element getRoot()

Get the root element of the DOM tree associated with this writer.

Returns:

The root Element of the DOM tree.

newSAXParser

protected abstract javax.xml.parsers.SAXParser newSAXParser()
                                                     throws org.xml.sax.SAXException,
                                                            javax.xml.parsers.ParserConfigurationException

Throws:

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

isParserValidating

protected abstract boolean isParserValidating()

getXMLBuilder

protected abstract XMLBuilder getXMLBuilder()

setRoot

protected abstract void setRoot(org.w3c.dom.Element newRoot)

Set the root element of the DOM tree associated with this writer.

Parameters:

newRoot - The DOM Element to assign as the root.

createElement

protected abstract org.w3c.dom.Element createElement(java.lang.String uri,
                                                     java.lang.String name)

appendChild

public org.w3c.dom.Element appendChild(org.w3c.dom.Element parent,
                                       java.lang.String name)

Append a new child element to the specified element. The new element will inherit the namespace of the parent.

Parameters:

parent - The element which will be the parent element of the new element.

name - The name of the new element (tag).

Returns:

The new child element.

appendChild

public org.w3c.dom.Element appendChild(org.w3c.dom.Element parent,
                                       java.lang.String name,
                                       java.lang.String uri)

Append a new child element to the specified element. The new element will be in the namespace identified by the given URI.

Parameters:

parent - The element which will be the parent element of the new element.

name - The name of the new element (tag).

uri - Namespace URI for the new child element.

appendChild

public org.w3c.dom.Element appendChild(org.w3c.dom.Element parent,
                                       java.lang.String name,
                                       java.lang.String attrName,
                                       java.lang.String attrValue)

Append a DOM Element with the given name and attribute to the specified parent Element. The new Element will be in the namespace of its parent.

Parameters:

parent - The parent of the new Element.

name - The name of the new Element.

attrName - The name of the attribute of the new Element.

attrValue - The value of the attribute named attrName.

Returns:

The new Element.

appendChild

public org.w3c.dom.Element appendChild(org.w3c.dom.Element parent,
                                       java.lang.String name,
                                       java.lang.String value,
                                       java.lang.String attrName,
                                       java.lang.String attrValue)

Append a DOM Element with the given name, text content value and attribute to the specified parent Element. The new Element will be in the namespace of its parent.

Parameters:

parent - The parent of the new Element.

name - The name of the new Element.

value - The text content to assign to the text node child of the new Element.

attrName - The name of the attribute of the new Element.

attrValue - The value of the attribute named attrName.

Returns:

The new Element.

appendChild

public org.w3c.dom.Element appendChild(org.w3c.dom.Element parent,
                                       java.lang.String name,
                                       java.lang.String[] attrNames,
                                       java.lang.String[] attrValues)

Append a DOM Element with the given name and attributes to the specified parent Element. The two arrays attrNames and attrValues must have the same length and be ordered such that the nth element of attrValues corresponds to the attribute with the name given by the nth element of attrNames. The new Element will be in the namespace of its parent.

Parameters:

parent - The parent of the new Element.

name - The name of the new Element.

attrNames - The names of the attributes of the new Element.

attrValues - The values of each of the attributes attrName.

Returns:

The new Element.

appendChild

public org.w3c.dom.Element appendChild(org.w3c.dom.Element parent,
                                       java.lang.String name,
                                       java.lang.String uri,
                                       java.lang.String value,
                                       java.lang.String[] attrNames,
                                       java.lang.String[] attrValues)

Append a DOM Element with the given name and attributes to the specified parent Element. The new element is in the namespace identified the the given URI. The two arrays attrNames and attrValues must have the same length and be ordered such that the nth element of attrValues corresponds to the attribute with the name given by the nth element of attrNames.

Parameters:

parent - The parent of the new Element.

name - The name of the new Element.

uri - The URI of the new Element's namespace.

attrNames - The names of the attributes of the new Element.

attrValues - The values of each of the attributes attrName.

Returns:

The new Element.

appendChildren

public void appendChildren(org.w3c.dom.Element parent,
                           java.lang.String name,
                           java.lang.String[] values)

Append multiple DOM Elements to the given Element, each having a specified text content. The text content of each new element is defined by the values array. The new Element will be in the namespace of its parent.

Parameters:

parent - The parent of the new Elements.

name - The name of the new Elements.

toXML

public java.lang.String toXML(XmlOutputConfig xmlOutputConfig)
                       throws org.xml.sax.SAXException

Serialize to XML format the DOM tree currently associated with this XMLWriter. If validation is enabled, then an alternative SAX error handler may be provided as described in

Returns:

the string

Throws:

org.xml.sax.SAXException - the SAX exception HandlerFactory. That handler will receive notification of parsing/validation failures.