public class ListUdt extends AbstractXmlBasedUdt
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.
| 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.
|
logger, xmlElementName, xmlNamespace| 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. |
| 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.
|
createDocument, getNamespace, getUdtName, loadFromUdtValue, loadXmlSchema, marshalBoolean, marshalByteArray, marshalDate, marshalDouble, marshalLong, marshalURI, saveToStream, saveToUdtValue, unmarshalBoolean, unmarshalByteArray, unmarshalDate, unmarshalDouble, unmarshalLong, unmarshalURIprotected static final java.lang.String XML_NAMESPACE
protected static final java.lang.String XSD_FILE_NAME
protected static final java.lang.String TYPE
ProcessConstants.AdeptDataType.protected static final java.lang.String UDT_TYPE
protected static final java.lang.String ENTRY
protected final java.util.List<java.io.Serializable> list
protected ProcessConstants.AdeptDataType innerType
protected java.lang.String innerUdtType
null otherwise.public ListUdt(ProcessConstants.AdeptDataType innerType)
innerType - The type of the list values.public ListUdt(java.lang.String innerUdtType)
innerUdtType - The UDT type of the values of this list if they are
user-defined types. This must not be null.public ListUdt(java.util.Collection<? extends java.io.Serializable> list,
ProcessConstants.AdeptDataType innerType)
list - A list providing the values for this UDT. This may be
null.innerType - The type of the list values.public ListUdt(java.util.Collection<? extends java.io.Serializable> list,
java.lang.String innerUdtType)
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.protected ListUdt(java.util.Collection<? extends java.io.Serializable> list,
ProcessConstants.AdeptDataType innerType,
java.lang.String innerUdtType)
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.public ListUdt(UDTValue value) throws java.io.IOException, XMLFormatException
UDTValue.value - The UDTValue from which to retrieve the list.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.public ListUdt(java.io.InputStream stream)
throws java.io.IOException,
XMLFormatException
InputStream.stream - The InputStream from which to retrieve the list.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.protected java.lang.String getXsdFileName()
AbstractXmlBasedUdtgetXsdFileName in class AbstractXmlBasedUdtpublic <any> getInnerType()
ProcessConstants.AdeptDataType.USERDEFINED, the second element of
the pair specifies the inner user-defined type.public java.lang.String loadFromStream(java.io.InputStream in)
throws java.io.IOException,
XMLFormatException
AbstractXmlBasedUdtInputStream by parsing the
corresponding XML.loadFromStream in class AbstractXmlBasedUdtin - The value of this UDT as stream (containing the XML
representation).null, the type name
will be changed.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.public java.util.List<java.io.Serializable> getList()
protected void marshal(org.w3c.dom.Element parent)
throws java.io.IOException
AbstractXmlBasedUdtmarshal in class AbstractXmlBasedUdtparent - The top-level element to which to add the
XML-representation of this UDT.java.io.IOException - If an error occurs while marshaling this UDT, an
IOException will be thrown.