de.aristaflow.adept2.extensions.datatypes

Class WebFormContainer

java.lang.Object

de.aristaflow.adept2.extensions.datatypes.WebFormContainer

public class WebFormContainer
extends java.lang.Object

This class facilitates the handling and manipulation of WebForm containers.

Author:

Patrick Schmidt

Constructor Summary

Constructors

Constructor and Description
WebFormContainer() Constructs a new empty WebFormContainer.

Method Summary

Modifier and Type	Method and Description
void	addField(java.lang.String fieldName, ProcessConstants.AdeptDataType dataType) Adds a new field to this WebForm container with the given name and data type.
ProcessConstants.AdeptDataType	getDataType(java.lang.String fieldName) Returns the data type of the field with the given name.
int	getFieldCount() Returns the number of fields in this WebForm container.
java.lang.String[]	getFieldNames() Returns the names of all fields in this WebForm container.
java.lang.Object	getValue(java.lang.String fieldName) Returns the value of the field with the given name.
boolean	hasField(java.lang.String fieldName) Returns whether this WebForm container has a field with the given name.
void	loadFromStream(java.io.InputStream in) Loads the data of the WebForm container from the given input stream.
void	loadFromUDTValue(UDTValue udtValue) Loads the data of the WebForm container from the given UDTValue.
void	removeField(java.lang.String fieldName) Removes the field with the given name from this WebForm container.
java.io.InputStream	saveToStream() Serialises the data of this WebForm container and returns an input stream from which the data can be read.
void	saveToStream(java.io.OutputStream out) Serialises the data of this WebForm container to the given output stream.
UDTValue	saveToUDTValue() Serialises the data of this WebForm container to a UDTValue.
void	setValue(java.lang.String fieldName, java.lang.Object value) Sets the value of the field with the given name to the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebFormContainer

public WebFormContainer()

Constructs a new empty WebFormContainer.

Method Detail

loadFromUDTValue

public void loadFromUDTValue(UDTValue udtValue)
                      throws java.io.IOException,
                             XMLFormatException

Loads the data of the WebForm container from the given UDTValue.

Parameters:

udtValue - the UDT value from which the WebForm container should be read

Throws:

java.io.IOException - if reading the UDT value failed

XMLFormatException - if the UDT value isn't a valid WebForm container

loadFromStream

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

Loads the data of the WebForm container from the given input stream.

Parameters:

in - the input from which the WebForm container should be read

Throws:

java.io.IOException - if reading the input stream failed

XMLFormatException - if the input stream didn't contain a valid WebForm container

saveToUDTValue

public UDTValue saveToUDTValue()

Serialises the data of this WebForm container to a UDTValue.

Returns:

an UDT value containing the data of this WebForm container

saveToStream

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

Serialises the data of this WebForm container to the given output stream.

Parameters:

out - the output stream to which the data of this WebForm container should be saved

Throws:

java.io.IOException - if the WebForm container could not be written to the given output stream

saveToStream

public java.io.InputStream saveToStream()
                                 throws java.io.IOException

Serialises the data of this WebForm container and returns an input stream from which the data can be read.

Returns:

an input stream from which the serialised data of this WebForm container can be read

Throws:

java.io.IOException - if the input stream could not be created for the WebForm container

getFieldNames

public java.lang.String[] getFieldNames()

Returns the names of all fields in this WebForm container.

Returns:

the names of all fields in this WebForm container

getFieldCount

public int getFieldCount()

Returns the number of fields in this WebForm container.

Returns:

the number of fields in this WebForm container

hasField

public boolean hasField(java.lang.String fieldName)

Returns whether this WebForm container has a field with the given name.

Parameters:

fieldName - the name of the field

Returns:

whether this WebForm container has a field with the given name

addField

public void addField(java.lang.String fieldName,
                     ProcessConstants.AdeptDataType dataType)

Adds a new field to this WebForm container with the given name and data type.

Parameters:

fieldName - the name of the new field

dataType - the data type of the new field

removeField

public void removeField(java.lang.String fieldName)

Removes the field with the given name from this WebForm container.

Parameters:

fieldName - the name of the field to be removed

getDataType

public ProcessConstants.AdeptDataType getDataType(java.lang.String fieldName)

Returns the data type of the field with the given name.

Parameters:

fieldName - name of the desired field

Returns:

the data type of the field with the given name

getValue

public java.lang.Object getValue(java.lang.String fieldName)

Returns the value of the field with the given name.

Parameters:

fieldName - the name of the desired field

Returns:

the value of the field with the given name

setValue

public void setValue(java.lang.String fieldName,
                     java.lang.Object value)

Sets the value of the field with the given name to the given value.

Parameters:

fieldName - the name of the desired field

value - the new value for the field