com.ebasetech.ufs.mapping

Interface TableDataInterface

public interface TableDataInterface

This represents the full data set for a UFS table. This is composed of a collection of TableRow objects, each of which is, in turn, composed of a collection of TableCell objects.

Method Summary

Modifier and Type	Method and Description
void	addRow(TableRow row) Adds the supplied row to the table data.
TableRow	createNewRow() Factory method.
java.util.Iterator	getAllRows() Returns an iterator over the entire set of rows in this table.
java.util.Iterator	getChangedRows() Returns an iterator over the set of changed rows in this table.
int	getNumberOfChangedRows() Returns the number of rows that have been changed
TableRow	getTableRow(int uniqueIdentifier) Gets the tableRow associated with this unique identifier.

Method Detail

getAllRows

java.util.Iterator getAllRows()
                       throws com.ebasetech.ufs.kernel.FormException

Returns an iterator over the entire set of rows in this table. Rows are presented in their current sort order.

Throws:

com.ebasetech.ufs.kernel.FormException

getChangedRows

java.util.Iterator getChangedRows()

Returns an iterator over the set of changed rows in this table. The iterator

getNumberOfChangedRows

int getNumberOfChangedRows()

Returns the number of rows that have been changed

createNewRow

TableRow createNewRow()

Factory method. Creates a new, empty table row and returns it for the user to populate with cells.

Returns:

empty Table Row

addRow

void addRow(TableRow row)

Adds the supplied row to the table data.

Parameters:

row - the TableRow to be added to this table.

getTableRow

TableRow getTableRow(int uniqueIdentifier)

Gets the tableRow associated with this unique identifier. The unique identifier is a number that uniquely identifies each table row for the duration of each form execution. It is set when the row is created, either by fetchtable or by row insertion, and is unaffected by subsequent table sorts, row deletion or updatetable requests. The unique identifier can be retieved using method getUniqueIdentifier() on TableRow.

Parameters:

uniqueIdentifier -

Returns:

TableRow if the tableRow with this identifier is in the table or null if it is not