de.aristaflow.adept2.extensions.datatypes

Class WebFormSubtable

java.lang.Object

de.aristaflow.adept2.extensions.datatypes.WebFormSubtable

public class WebFormSubtable
extends java.lang.Object

This class facilitates the handling and manipulation of WebForm subtables.

Author:

Patrick Schmidt

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addColumn(java.lang.String columnName, ProcessConstants.AdeptDataType dataType) Adds a new column this WebForm subtable with the given name and data type.
int	addRow() Adds a new empty row.
int	addRow(java.lang.Object... values) Adds a empty row filled with the given values.
int	getColumnCount() Returns the number of columns in this WebForm subtable.
java.lang.String[]	getColumnNames() Returns the names of all columns in this WebForm subtable.
ProcessConstants.AdeptDataType	getDataType(java.lang.String columnName) Returns the data type of the column with the given name.
int	getRowCount() Returns the number of rows of this WebForm subtable.
java.lang.Object	getValue(java.lang.String columnName, int rowIndex) Returns the value of the specified column and row.
boolean	hasColumn(java.lang.String columnName) Returns whether this WebForm subtable has a column with the given name.
void	insertRow(int rowIndex) Inserts a new empty row at the specified row index.
void	insertRow(int rowIndex, java.lang.Object... values) Inserts a new row filled with the given values at the specified row index.
void	loadFromStream(java.io.InputStream in) Loads the data of the WebForm subtable from the given input stream.
void	loadFromUDTValue(UDTValue udtValue) Loads the data of the WebForm subtable from the given UDTValue.
void	removeColumn(java.lang.String columnName) Removes the column with the given name from this WebForm subtable.
void	removeRow(int rowIndex) Removes the row at the specified index.
java.io.InputStream	saveToStream() Serialises the data of this WebForm subtable and returns an input stream from which the data can be read.
void	saveToStream(java.io.OutputStream out) Serialises the data of this WebForm subtable to the given output stream.
UDTValue	saveToUDTValue() Serialises the data of this WebForm subtable to a UDTValue.
void	setValue(java.lang.String columnName, int rowIndex, java.lang.Object value) Sets the value of the specified column and row to the given value.
void	setValues(int rowIndex, java.lang.Object... values) Sets all values of the given row.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebFormSubtable

public WebFormSubtable()

Constructs a new empty WebFormSubtable.

Method Detail

loadFromUDTValue

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

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

Parameters:

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

Throws:

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

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

loadFromStream

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

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

Parameters:

in - the input stream from which the WebForm subtable should be read

Throws:

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

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

saveToUDTValue

public UDTValue saveToUDTValue()

Serialises the data of this WebForm subtable to a UDTValue.

Returns:

an UDT value containing the data of this WebForm subtable

saveToStream

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

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

Parameters:

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

Throws:

java.io.IOException - if the WebForm subtable 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 subtable and returns an input stream from which the data can be read.

Returns:

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

Throws:

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

getColumnNames

public java.lang.String[] getColumnNames()

Returns the names of all columns in this WebForm subtable.

Returns:

the names of all columns in this WebForm subtable

getColumnCount

public int getColumnCount()

Returns the number of columns in this WebForm subtable.

Returns:

the number of columns in this WebForm subtable

hasColumn

public boolean hasColumn(java.lang.String columnName)

Returns whether this WebForm subtable has a column with the given name.

Parameters:

columnName - the name of the column

Returns:

whether this WebForm subtable has a column with the given name

addColumn

public void addColumn(java.lang.String columnName,
                      ProcessConstants.AdeptDataType dataType)

Adds a new column this WebForm subtable with the given name and data type.

Parameters:

columnName - the name of the new column

dataType - the data type of the new column

removeColumn

public void removeColumn(java.lang.String columnName)

Removes the column with the given name from this WebForm subtable.

Parameters:

columnName - the name of the column to be removed

getDataType

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

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

Parameters:

columnName - name of the desired column

Returns:

the data type of the column with the given name

getRowCount

public int getRowCount()

Returns the number of rows of this WebForm subtable.

Returns:

the number of rows of this WebForm subtable

addRow

public int addRow()

Adds a new empty row.

Returns:

the index of the new row

addRow

public int addRow(java.lang.Object... values)

Adds a empty row filled with the given values.

Parameters:

values - the values of the new row

Returns:

the index of the new row

insertRow

public void insertRow(int rowIndex)

Inserts a new empty row at the specified row index.

Parameters:

rowIndex - the index of the new row

insertRow

public void insertRow(int rowIndex,
                      java.lang.Object... values)

Inserts a new row filled with the given values at the specified row index.

Parameters:

rowIndex - the index of the new row

values - the values of the new row

removeRow

public void removeRow(int rowIndex)

Removes the row at the specified index.

Parameters:

rowIndex - index of the row to be deleted

getValue

public java.lang.Object getValue(java.lang.String columnName,
                                 int rowIndex)

Returns the value of the specified column and row.

Parameters:

columnName - the name of the desired column

rowIndex - the index of the desired row

Returns:

the value of the column with the given name in the row with the specified index

setValue

public void setValue(java.lang.String columnName,
                     int rowIndex,
                     java.lang.Object value)

Sets the value of the specified column and row to the given value.

Parameters:

columnName - the name of the desired column

rowIndex - the index of the desired row

value - the new value for the specified column and row

setValues

public void setValues(int rowIndex,
                      java.lang.Object... values)

Sets all values of the given row.

Parameters:

rowIndex - the index of the desired row

values - the new values of the row