de.aristaflow.adept2.extensions.datatypes

Class ListUdt

java.lang.Object

de.aristaflow.adept2.extensions.datatypes.AbstractXmlBasedUdt

de.aristaflow.adept2.extensions.datatypes.ListUdt

public class ListUdt
extends AbstractXmlBasedUdt

This class represents a list-structure for values of any ProcessConstants.AdeptDataType.

The list-structure is stored in an appropriate XML representation in a UDTValue. Wrap such a UDTValue by this class for simplified access to and manipulation of the list.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ENTRY The name of the XML-element for an entry of the list.
protected ProcessConstants.AdeptDataType	innerType The data type of the values of this list.
protected java.lang.String	innerUdtType The UDT type of the values of this list if they are user-defined types, null otherwise.
protected java.util.List<java.io.Serializable>	list The list which is the actual value of this UDT.
protected static java.lang.String	TYPE The name of the XML-attribute for the inner type that is an ProcessConstants.AdeptDataType.
protected static java.lang.String	UDT_TYPE The name of the optional XML-attribute for the inner UDT type name.
protected static java.lang.String	XML_NAMESPACE The namespace for the XML-representation of this UDT.
protected static java.lang.String	XSD_FILE_NAME The filename for the XSD of this UDT.

Fields inherited from class de.aristaflow.adept2.extensions.datatypes.AbstractXmlBasedUdt

logger, xmlElementName, xmlNamespace

Constructor Summary

Constructors

Modifier	Constructor and Description
	ListUdt(java.util.Collection<? extends java.io.Serializable> list, ProcessConstants.AdeptDataType innerType) Creates a new list UDT for values of the designated (non-userdefined) type.
protected	ListUdt(java.util.Collection<? extends java.io.Serializable> list, ProcessConstants.AdeptDataType innerType, java.lang.String innerUdtType) Creates a new list UDT for values of the designated type.
	ListUdt(java.util.Collection<? extends java.io.Serializable> list, java.lang.String innerUdtType) Creates a new list UDT for values of the designated (userdefined) type.
	ListUdt(java.io.InputStream stream) Creates a new list UDT for the designated InputStream.
	ListUdt(ProcessConstants.AdeptDataType innerType) Creates a new list UDT for values of the designated (non-userdefined) type.
	ListUdt(java.lang.String innerUdtType) Creates a new list UDT for values of the designated (userdefined) type.
	ListUdt(UDTValue value) Creates a new list UDT for the designated UDTValue.

Method Summary

Modifier and Type	Method and Description
<any>	getInnerType() Gets the inner type of this list, that is the type of the list elements.
java.util.List<java.io.Serializable>	getList() Gets the list value of this UDT.
protected java.lang.String	getXsdFileName() Gets the file name of the XSD of this UDT.
java.lang.String	loadFromStream(java.io.InputStream in) Loads and data from the designated InputStream by parsing the corresponding XML.
protected void	marshal(org.w3c.dom.Element parent) Marshals the data of this UDT as XML by adding it to the designated top-level element.

Methods inherited from class de.aristaflow.adept2.extensions.datatypes.AbstractXmlBasedUdt

createDocument, getNamespace, getUdtName, loadFromUdtValue, loadXmlSchema, marshalBoolean, marshalByteArray, marshalDate, marshalDouble, marshalLong, marshalURI, saveToStream, saveToUdtValue, unmarshalBoolean, unmarshalByteArray, unmarshalDate, unmarshalDouble, unmarshalLong, unmarshalURI

Methods inherited from class java.lang.Object

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

Field Detail

XML_NAMESPACE

protected static final java.lang.String XML_NAMESPACE

The namespace for the XML-representation of this UDT.

See Also:

Constant Field Values

XSD_FILE_NAME

protected static final java.lang.String XSD_FILE_NAME

The filename for the XSD of this UDT.

See Also:

Constant Field Values

TYPE

protected static final java.lang.String TYPE

The name of the XML-attribute for the inner type that is an ProcessConstants.AdeptDataType.

See Also:

Constant Field Values

UDT_TYPE

protected static final java.lang.String UDT_TYPE

The name of the optional XML-attribute for the inner UDT type name.

See Also:

Constant Field Values

ENTRY

protected static final java.lang.String ENTRY

The name of the XML-element for an entry of the list.

See Also:

Constant Field Values

list

protected final java.util.List<java.io.Serializable> list

The list which is the actual value of this UDT.

innerType

protected ProcessConstants.AdeptDataType innerType

The data type of the values of this list.

innerUdtType

protected java.lang.String innerUdtType

The UDT type of the values of this list if they are user-defined types, null otherwise.

Constructor Detail

ListUdt

public ListUdt(ProcessConstants.AdeptDataType innerType)

Creates a new list UDT for values of the designated (non-userdefined) type.

Parameters:

innerType - The type of the list values.

ListUdt

public ListUdt(java.lang.String innerUdtType)

Creates a new list UDT for values of the designated (userdefined) type.

Parameters:

innerUdtType - The UDT type of the values of this list if they are user-defined types. This must not be null.

ListUdt

public ListUdt(java.util.Collection<? extends java.io.Serializable> list,
               ProcessConstants.AdeptDataType innerType)

Creates a new list UDT for values of the designated (non-userdefined) type. This type has to conform to the type of the values in the provided list.

Parameters:

list - A list providing the values for this UDT. This may be null.

innerType - The type of the list values.

ListUdt

public ListUdt(java.util.Collection<? extends java.io.Serializable> list,
               java.lang.String innerUdtType)

Creates a new list UDT for values of the designated (userdefined) type. This type has to conform to the type of the values in the provided list.

Parameters:

list - A list providing the values for this UDT. This may be null.

innerUdtType - The UDT type of the values of this list if they are user-defined types. This must not be null.

ListUdt

protected ListUdt(java.util.Collection<? extends java.io.Serializable> list,
                  ProcessConstants.AdeptDataType innerType,
                  java.lang.String innerUdtType)

Creates a new list UDT for values of the designated type. This type has to conform to the type of the values in the provided list.

Parameters:

list - A list providing the values for this UDT. This may be null.

innerType - The type of the list values.

innerUdtType - The UDT type of the values of this list if they are user-defined types, null otherwise.

ListUdt

public ListUdt(UDTValue value)
        throws java.io.IOException,
               XMLFormatException

Creates a new list UDT for the designated UDTValue.

Parameters:

value - The UDTValue from which to retrieve the list.

Throws:

java.io.IOException - If an error occurs while reading the UDTValue, an IOException will be thrown.

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

ListUdt

public ListUdt(java.io.InputStream stream)
        throws java.io.IOException,
               XMLFormatException

Creates a new list UDT for the designated InputStream.

Parameters:

stream - The InputStream from which to retrieve the list.

Throws:

java.io.IOException - If an error occurs while reading the InputStream, an IOException will be thrown.

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

Method Detail

getXsdFileName

protected java.lang.String getXsdFileName()

Description copied from class: AbstractXmlBasedUdt

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.

Specified by:

getXsdFileName in class AbstractXmlBasedUdt

Returns:

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

getInnerType

public <any> getInnerType()

Gets the inner type of this list, that is the type of the list elements. If the inner type is ProcessConstants.AdeptDataType.USERDEFINED, the second element of the pair specifies the inner user-defined type.

Returns:

The inner type of this list, that is the type of the list elements.

loadFromStream

public java.lang.String loadFromStream(java.io.InputStream in)
                                throws java.io.IOException,
                                       XMLFormatException

Description copied from class: AbstractXmlBasedUdt

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

Specified by:

loadFromStream in class AbstractXmlBasedUdt

Parameters:

in - 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.

getList

public java.util.List<java.io.Serializable> getList()

Gets the list value of this UDT. Note that this is actually the list, that is, it can be changed via side-effects.

Returns:

The list value of this UDT.

marshal

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

Description copied from class: AbstractXmlBasedUdt

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

Specified by:

marshal in class AbstractXmlBasedUdt

Parameters:

parent - 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.