de.aristaflow.adept2.extensions.datatypes

Class AbstractXmlBasedUdt

java.lang.Object

de.aristaflow.adept2.extensions.datatypes.AbstractXmlBasedUdt

Direct Known Subclasses:

ListUdt, LocalisationUdt

public abstract class AbstractXmlBasedUdt
extends java.lang.Object

An abstract class providing the basic means for an object-oriented wrapper for a UDTValue providing direct access to various data of the UDT. The data is represented as XML in the UDTValue. This class allows for parsing and validating the XML as well as for creating at least the basic structure (document and top-level element) for the XML.

Author:

Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	logger The logger for problems when loading the XML schema.
protected java.lang.String	xmlElementName The name of the top-level element in the XML that represents the UDT.
protected java.lang.String	xmlNamespace The namespace of the XML that represents the UDT.

Constructor Summary

Constructors

Constructor and Description
AbstractXmlBasedUdt(java.lang.String udtName, java.lang.String xmlNamespace) Creates a new wrapper class for a UDTValue based on XML.
AbstractXmlBasedUdt(java.lang.String udtName, java.lang.String xmlNamespace, java.lang.String xmlElementName) Creates a new wrapper class for a UDTValue based on XML.

Method Summary

Modifier and Type	Method and Description
protected org.w3c.dom.Document	createDocument() Creates a document for the XML-representation of this UDT containing the top-level element.
protected java.lang.String	getNamespace() Gets the namespace of the XML that represents the UDT.
protected java.lang.String	getUdtName() Gets the name of the user-defined type.
protected abstract java.lang.String	getXsdFileName() Gets the file name of the XSD of this UDT.
protected abstract java.lang.String	loadFromStream(java.io.InputStream valueAsStream) Loads and data from the designated InputStream by parsing the corresponding XML.
protected void	loadFromUdtValue(UDTValue udtValue) Loads the data from the designated UDTValue by parsing the corresponding XML.
protected javax.xml.validation.Schema	loadXmlSchema() Loads the XML schema for this UDT.
protected abstract void	marshal(org.w3c.dom.Element topLevel) Marshals the data of this UDT as XML by adding it to the designated top-level element.
protected static void	marshalBoolean(boolean b, org.w3c.dom.Node node) Marshals the designated boolean value as content of the designated node.
protected static void	marshalByteArray(byte[] bytes, org.w3c.dom.Node node) Marshals the designated byte[] value as content of the designated node.
protected static void	marshalDate(java.util.Date date, org.w3c.dom.Node node) Marshals the designated Date value as content of the designated node.
protected static void	marshalDouble(double d, org.w3c.dom.Node node) Marshals the designated double value as content of the designated node.
protected static void	marshalLong(long l, org.w3c.dom.Node node) Marshals the designated long value as content of the designated node.
protected static void	marshalURI(java.net.URI uri, org.w3c.dom.Node node) Marshals the designated URI value as content of the designated node.
void	saveToStream(java.io.OutputStream out) Serialises the data of this UDT as XML to the designated output stream.
UDTValue	saveToUdtValue() Serialises the data of this UDT as XML and returns it as UDTValue.
protected static boolean	unmarshalBoolean(org.w3c.dom.Node node) Unmarshals a boolean value from the text content of the designated node.
protected static byte[]	unmarshalByteArray(org.w3c.dom.Node node) Unmarshals a byte[] value from the text content of the designated node.
protected static java.util.Date	unmarshalDate(org.w3c.dom.Node node) Unmarshals a Date value from the text content of the designated node.
protected static double	unmarshalDouble(org.w3c.dom.Node node) Unmarshals the double value from the text content of the designated node.
protected static long	unmarshalLong(org.w3c.dom.Node node) Unmarshals the long value from the text content of the designated node.
protected static java.net.URI	unmarshalURI(org.w3c.dom.Node node) Unmarshals a URI value from the text content of the designated node.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final java.util.logging.Logger logger

The logger for problems when loading the XML schema.

xmlNamespace

protected final java.lang.String xmlNamespace

The namespace of the XML that represents the UDT.

xmlElementName

protected final java.lang.String xmlElementName

The name of the top-level element in the XML that represents the UDT.

Constructor Detail

AbstractXmlBasedUdt

public AbstractXmlBasedUdt(java.lang.String udtName,
                           java.lang.String xmlNamespace)

Creates a new wrapper class for a UDTValue based on XML. The name of the top-level element of the XML is expected to be the UDT-name.

Parameters:

udtName - The name of the UDT. This can be changed later when loading the value.

xmlNamespace - The namespace of the XML-representation of the UDT.

AbstractXmlBasedUdt

public AbstractXmlBasedUdt(java.lang.String udtName,
                           java.lang.String xmlNamespace,
                           java.lang.String xmlElementName)

Creates a new wrapper class for a UDTValue based on XML.

Parameters:

udtName - The name of the UDT. This can be changed later when loading the value.

xmlNamespace - The namespace of the XML-representation of the UDT.

xmlElementName - The name of the top-level element in the XML-representation of the UDT.

Method Detail

getUdtName

protected java.lang.String getUdtName()

Gets the name of the user-defined type.

Returns:

The name of the user-defined type.

getNamespace

protected java.lang.String getNamespace()

Gets the namespace of the XML that represents the UDT.

Returns:

The namespace of the XML that represents the UDT.

loadXmlSchema

protected javax.xml.validation.Schema loadXmlSchema()

Loads the XML schema for this UDT. If it cannot be loaded, null will be returned. It is advised to cache the schema in subclasses, even as static field, but make sure to synchronise access appropriately.

Returns:

The XML schema for this UDT or null in case the schema cannot be loaded.

loadFromUdtValue

protected void loadFromUdtValue(UDTValue udtValue)
                         throws java.io.IOException,
                                XMLFormatException

Loads the data from the designated UDTValue by parsing the corresponding XML.

Parameters:

udtValue - The UDTValue from which to load the XML for the data of this UDT.

Throws:

java.lang.IllegalArgumentException - If the designated UDT value does not have the right user-defined type (name), an IllegalArgumentException will be thrown.

java.io.IOException - If an error occurs while reading the UDTValue, an IOException will be thrown. If a class is to be loaded from the UDT value that cannot be found, a ClassNotFoundException will be wrapped within an IOException.

XMLFormatException - If the document is not well-formed or does not conform to its schema (if provided), an XMLFormatException will be thrown.

createDocument

protected org.w3c.dom.Document createDocument()
                                       throws java.io.IOException

Creates a document for the XML-representation of this UDT containing the top-level element.

Returns:

A document for the XML-representation of this UDT containing the top-level element.

Throws:

java.io.IOException - If an error occurs while marshaling this UDT, an IOException will be thrown.

saveToUdtValue

public UDTValue saveToUdtValue()
                        throws java.io.IOException

Serialises the data of this UDT as XML and returns it as UDTValue.

Returns:

The data of this UDT as XML representation in a UDTValue.

Throws:

java.io.IOException - If there are problems serialising the data of this UDT as XML, an IOException will be thrown.

saveToStream

public void saveToStream(java.io.OutputStream out)
                  throws java.io.IOException

Serialises the data of this UDT as XML to the designated output stream.

Parameters:

out - The output stream to which to save the data of this UDT as XML.

Throws:

java.io.IOException - If there are problems serialising the data of this UDT as XML to the designated output stream, an IOException will be thrown.

getXsdFileName

protected abstract java.lang.String getXsdFileName()

Gets the file name of the XSD of this UDT. The file name is usually a static field of the subclass. The file name may contain a relative or even an absolute path relative to this class.

Returns:

The file name (including the path) of the XSD of this UDT.

loadFromStream

protected abstract java.lang.String loadFromStream(java.io.InputStream valueAsStream)
                                            throws java.io.IOException,
                                                   XMLFormatException

Loads and data from the designated InputStream by parsing the corresponding XML.

Parameters:

valueAsStream - The value of this UDT as stream (containing the XML representation).

Returns:

The name of the user-defined type if this is stored in the designated stream. If this is not null, the type name will be changed.

Throws:

java.io.IOException - If an error occurs while reading from the stream, an IOException will be thrown. If a class is to be loaded from the stream that cannot be found, a ClassNotFoundException will be wrapped within an IOException.

XMLFormatException - If the document is not well-formed or does not conform to its schema (if provided), an XMLFormatException will be thrown.

marshal

protected abstract void marshal(org.w3c.dom.Element topLevel)
                         throws java.io.IOException

Marshals the data of this UDT as XML by adding it to the designated top-level element.

Parameters:

topLevel - The top-level element to which to add the XML-representation of this UDT.

Throws:

java.io.IOException - If an error occurs while marshaling this UDT, an IOException will be thrown.

marshalBoolean

protected static void marshalBoolean(boolean b,
                                     org.w3c.dom.Node node)

Marshals the designated boolean value as content of the designated node.

Parameters:

b - The boolean value to marshal.

node - The node to which to marshal the value.

unmarshalBoolean

protected static boolean unmarshalBoolean(org.w3c.dom.Node node)

Unmarshals a boolean value from the text content of the designated node.

Parameters:

node - The node from which to unmarshal a boolean value from its text content.

Returns:

The boolean value from the text content of the designated node.

marshalLong

protected static void marshalLong(long l,
                                  org.w3c.dom.Node node)

Marshals the designated long value as content of the designated node.

Parameters:

l - The long value to marshal.

node - The node to which to marshal the value.

unmarshalLong

protected static long unmarshalLong(org.w3c.dom.Node node)

Unmarshals the long value from the text content of the designated node.

Parameters:

node - The node from which to unmarshal a long value from its text content.

Returns:

The long value from the text content of the designated node.

marshalDouble

protected static void marshalDouble(double d,
                                    org.w3c.dom.Node node)

Marshals the designated double value as content of the designated node.

Parameters:

d - The double value to marshal.

node - The node to which to marshal the value.

unmarshalDouble

protected static double unmarshalDouble(org.w3c.dom.Node node)

Unmarshals the double value from the text content of the designated node.

Parameters:

node - The node from which to unmarshal a double value from its text content.

Returns:

The double value from the text content of the designated node.

marshalDate

protected static void marshalDate(java.util.Date date,
                                  org.w3c.dom.Node node)

Marshals the designated Date value as content of the designated node.

Parameters:

date - The Date value to marshal.

node - The node to which to marshal the value.

unmarshalDate

protected static java.util.Date unmarshalDate(org.w3c.dom.Node node)

Unmarshals a Date value from the text content of the designated node.

Parameters:

node - The node from which to unmarshal a Date value from its text content.

Returns:

The Date value from the text content of the designated node.

marshalURI

protected static void marshalURI(java.net.URI uri,
                                 org.w3c.dom.Node node)

Marshals the designated URI value as content of the designated node.

Parameters:

uri - The URI value to marshal.

node - The node to which to marshal the value.

unmarshalURI

protected static java.net.URI unmarshalURI(org.w3c.dom.Node node)

Unmarshals a URI value from the text content of the designated node.

Parameters:

node - The node from which to unmarshal a URI value from its text content.

Returns:

The URI value from the text content of the designated node.

marshalByteArray

protected static void marshalByteArray(byte[] bytes,
                                       org.w3c.dom.Node node)

Marshals the designated byte[] value as content of the designated node.

Parameters:

bytes - The byte[] value to marshal.

node - The node to which to marshal the value.

unmarshalByteArray

protected static byte[] unmarshalByteArray(org.w3c.dom.Node node)
                                    throws java.io.IOException

Unmarshals a byte[] value from the text content of the designated node.

Parameters:

node - The node from which to unmarshal a byte[] value from its text content.

Returns:

The byte[] value from the text content of the designated node.

Throws:

java.io.IOException - If decoding the byte array with Base64 fails, an IOException will be thrown.