no.g9.client.core.view.table

Interface TableModel<T extends ListRow>

Type Parameters:

T - The actual implementing ListRow class

All Known Implementing Classes:

DefaultTableModel

public interface TableModel<T extends ListRow>

The general table model used by jVine targets. The table model is used to hold all the data that can be displayed by a table in addition to various properties concerning rows, columns and table cells.

ListRow is used to represents rows. Rows are referenced using a zero-based rowIndex. When setting a property, the property is propagated to the ListRow's PropertyManager.

The table model maintains two lists of ListRows:

• The table data list is the complete list of ListRows in this table model. All methods that uses rowIndex as a parameter or return value relates to the table data list. This list can be accessed by means of the getTableData() method.
• The table view list is the filtered and sorted list of ListRows that can be presented by a dialog. This list can be accessed by means of the getTableView() method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TableModel.SelectionModel Enumerates the various row selection models.

Method Summary

Modifier and Type	Method and Description
void	add(Collection<T> rows) Appends the specified rows to this table data's list.
void	add(T... row) Appends the specified rows to this table data's list.
void	addRowFilter(RowFilter<?,ListRow> rowFilter) Add the row filter to this table model.
void	addRowFilters(Collection<RowFilter<?,ListRow>> rowFilters) Add the row filters to this table model.
void	clear() Clears this table model by removing all ListRows.
void	clearRowFilters() Removes all row filters used by this table model.
void	filterTableView() Update the table view list according to the defined filters.
T	get(int rowIndex) Get the list row at the specified table data's index (zero-based).
<U> U	getCellProperty(int rowIndex, DialogObjectConstant columnIdentifier, Property<U> propertyName) Get the property value for the specified cell.
int	getColumnCount() Get the number of columns in this table model.
DialogObjectConstant	getFirstSortingColumn() Get the column that is first in the sorting sequence.
Collection<RowFilter<?,ListRow>>	getRowFilters() Get the registered row filters for this table model.
List<T>	getSelected() Get the list of selected rows.
int	getSelectionCount() Get the number of selected rows.
TableModel.SelectionModel	getSelectionModel() Get the tables selection model.
ListRowComparator.Sorting	getSorting() Get the sort direction used by the first sorting column.
List<T>	getTableData() Get the table data list.
int	getTableDataRowCount() Get the number of rows in this table's data list.
List<T>	getTableView() Get the table view list.
int	getTableViewRowCount() Get the number of rows in this table's view list.
Object	getValueAt(int rowIndex, DialogObjectConstant columnIdentifier) Get the cell value at the specified row and column.
int	indexOf(T row) Get the index of the specified row.
void	insert(int rowIndex, Collection<T> rows) Inserts a row or rows at the specified position in the table data list.
void	insert(int rowIndex, T... row) Inserts a row or rows at the specified position in the table data list .
boolean	isCellEnabled(int rowIndex, DialogObjectConstant columnIdentifier) Get the enabled property value of the specified cell.
boolean	isCellShown(int rowIndex, DialogObjectConstant columnIdentifier) Get the shown property value of the specified cell.
boolean	isEmpty() Test if this table model contains any rows.
boolean	isSelected(int rowIndex) Test if the specified row is selected.
void	prettyPrint(PrintStream out) Debug print the table contents to specified print stream.
T	remove(int rowIndex) Removes the row at the specified table data index.
boolean	remove(T... row) Removes specified row or rows from the table data list.
boolean	removeAll(Collection<T> rows) Removes specified row or rows from the table data list.
void	removeRowFilter(RowFilter<?,ListRow> rowFilter) Remove the row filter from this table model.
void	removeRowFilters(Collection<RowFilter<?,ListRow>> rowFilters) Remove the row filters from this table model.
void	setCellEnabled(int rowIndex, DialogObjectConstant columnIdentifier, boolean enabled) Set the enabled property the specified cell.
<U> void	setCellProperty(int rowIndex, DialogObjectConstant columnIdentifier, Property<U> propertyName, U propertyValue) Set the specified property on the specified cell.
void	setCellShown(int rowIndex, DialogObjectConstant columnIdentifier, boolean shown) Set the shown property the specified cell.
void	setColumnEnabled(DialogObjectConstant columnIdentifier, boolean enabled) Set the enabled property for all cells in the specified column.
<U> void	setColumnProperty(DialogObjectConstant columnIdentifier, Property<U> propertyName, U value) Set the specified property on all cells in the column.
void	setColumnShown(DialogObjectConstant columnIdentifier, boolean shown) Set the shown property for all cells in the specified column.
void	setEnabled(boolean enabled) Set the enabled property for all cells in the entire table.
void	setFirstSortingColumn(DialogObjectConstant column) Use the specified column first when comparing list rows.
void	setListRowComparator(List<ListRowComparator<T>> comparatorList) Set the list of ListRowComparators to use when sorting this table model.
<U> void	setProperty(Property<U> property, U propertyValue) Set the specified property on all cells in the table.
void	setRowEnabled(int rowIndex, boolean enabled) Set the enabled property for all cells in the specified row.
void	setRowEnabled(T row, boolean enabled) Set the enabled property for all cells in the specified row.
<U> void	setRowProperty(int rowIndex, Property<U> property, U propertyValue) Set the specified property on all cells in the row.
<U> void	setRowProperty(T row, Property<U> property, U propertyValue) Set the specified property on all cells in the row.
void	setRowShown(int rowIndex, boolean shown) Set the shown property for all cells in the specified row.
void	setRowShown(T row, boolean shown) Set the shown property for all cells in the specified row.
void	setSelected(boolean selected) Set the selected property of all rows.
void	setSelected(int rowIndex, boolean selected) Set the selected property of the specified row.
void	setSelected(T row, boolean selected) Set the selected property of the specified row.
void	setSelectionModel(TableModel.SelectionModel selectionModel) Set the table's selection model.
void	setShown(boolean shown) Set the shown property for all cells in the table.
void	setSorting(ListRowComparator.Sorting sortDirection) Set the sort direction used by the first sorting column.
void	setValueAt(int rowIndex, DialogObjectConstant columnIdentifier, Object value) Set the specified cell value.
void	sortTableView() Sort the table view.
void	toggleSorting() Toggle the sorting used by the first sorting column.
int	toTableDataIndex(int tableViewIndex) Transform the given tableViewIndex to the corresponding table model index.

Method Detail

setListRowComparator

void setListRowComparator(List<ListRowComparator<T>> comparatorList)

Set the list of ListRowComparators to use when sorting this table model. The sequence of the list will determine the initial sorting.

Parameters:

comparatorList - list of comparators to use, one for each sortable column

toggleSorting

void toggleSorting()

Toggle the sorting used by the first sorting column.

See Also:

ListRowComparator.toggleSorting()

getSorting

ListRowComparator.Sorting getSorting()

Get the sort direction used by the first sorting column.

Returns:

the sort direction

See Also:

ListRowComparator.getSorting()

setSorting

void setSorting(ListRowComparator.Sorting sortDirection)

Set the sort direction used by the first sorting column.

Parameters:

sortDirection - the sort direction

See Also:

ListRowComparator.setSorting(Sorting)

setFirstSortingColumn

void setFirstSortingColumn(DialogObjectConstant column)

Use the specified column first when comparing list rows.

Parameters:

column - first column to use when sorting

sortTableView

void sortTableView()

Sort the table view. The table view is sorted according to the defined ListRow comparators.

See Also:

setListRowComparator(List)

getFirstSortingColumn

DialogObjectConstant getFirstSortingColumn()

Get the column that is first in the sorting sequence.

Returns:

the column that is first in the sorting

addRowFilter

void addRowFilter(RowFilter<?,ListRow> rowFilter)

Add the row filter to this table model. The table view list will be updated.

Parameters:

rowFilter - row filter(s) to add

addRowFilters

void addRowFilters(Collection<RowFilter<?,ListRow>> rowFilters)

Add the row filters to this table model. The table view list will be updated.

Parameters:

rowFilters - row filter(s) to add

removeRowFilter

void removeRowFilter(RowFilter<?,ListRow> rowFilter)

Remove the row filter from this table model. The table view list will be updated.

Parameters:

rowFilter - row filter(s) to remove

removeRowFilters

void removeRowFilters(Collection<RowFilter<?,ListRow>> rowFilters)

Remove the row filters from this table model. The table view list will be updated.

Parameters:

rowFilters - row filters to remove

clearRowFilters

void clearRowFilters()

Removes all row filters used by this table model.

getRowFilters

Collection<RowFilter<?,ListRow>> getRowFilters()

Get the registered row filters for this table model.

Returns:

an unmodifiable view of the row filters collection

filterTableView

void filterTableView()

Update the table view list according to the defined filters.

getTableData

List<T> getTableData()

Get the table data list. This is the list used for maintaining the unsorted and un-filtered table list rows.

Note that any changes made directly to this list will be detected by the table model and trigger and update of the table view list.

Returns:

table data list

getTableView

List<T> getTableView()

Get the table view list. This is the sorted and filtered list presented to dialog views.

Note that any changes made directly to this list will not be detected by the table model. Thus adding or removing rows to this list might not yield the desired result.

Returns:

table view list

setSelectionModel

void setSelectionModel(TableModel.SelectionModel selectionModel)

Set the table's selection model.

Parameters:

selectionModel - the selection model for the table

getSelectionModel

TableModel.SelectionModel getSelectionModel()

Get the tables selection model.

Returns:

the

getValueAt

Object getValueAt(int rowIndex,
                  DialogObjectConstant columnIdentifier)

Get the cell value at the specified row and column.

Parameters:

rowIndex - table data's index of the row

columnIdentifier - constant denoting the column

Returns:

the cell value

Throws:

IndexOutOfBoundsException - if the specified row index is out of range ( rowIndex < 0 || rowIndex > getRowCount())

NoSuchElementException - if the specified column is not part of this table data

setValueAt

void setValueAt(int rowIndex,
                DialogObjectConstant columnIdentifier,
                Object value)

Set the specified cell value.

Note: The table view is not updated as a result of invoking this method.

Parameters:

rowIndex - table data's index of the row

columnIdentifier - constant denoting the column

value - cell value

Throws:

IndexOutOfBoundsException - if the specified row index is out of range ( rowIndex < 0 || rowIndex > getRowCount())

NoSuchElementException - if the specified column is not part of this table model data

See Also:

filterTableView()

getTableDataRowCount

int getTableDataRowCount()

Get the number of rows in this table's data list.

Returns:

the data list's row count

getTableViewRowCount

int getTableViewRowCount()

Get the number of rows in this table's view list.

Returns:

the view list's row count

getColumnCount

int getColumnCount()

Get the number of columns in this table model.

Returns:

the column count

indexOf

int indexOf(T row)

Get the index of the specified row. The table's data list are compared with the specified ListRow, and the index of the first row that matches (using the equals method) is returned. If no match is found, -1 is returned.

Parameters:

row - row to get index for

Returns:

the table data's row index or -1 if the table data list does not contain the specified ListRow

Throws:

NullPointerException - if the specified row is null

toTableDataIndex

int toTableDataIndex(int tableViewIndex)

Transform the given tableViewIndex to the corresponding table model index. This method is used to get from a displayed row index to the row's index in the table data.

Parameters:

tableViewIndex - displayed row index

Returns:

the row's table data index

get

T get(int rowIndex)

Get the list row at the specified table data's index (zero-based).

Parameters:

rowIndex - the table data's index of the row to get

Returns:

the row at the specified index

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex %gt;= getRowCount())

insert

void insert(int rowIndex,
            T... row)

Inserts a row or rows at the specified position in the table data list . Shifts the row at that position (if any) an any subsequent rows down.

Parameters:

rowIndex - table data's index at which the specified row is to be inserted

row - row to be inserted

Throws:

IndexOutOfBoundsException - if the specified row index is out of range ( rowIndex < 0 || rowIndex > getTableDataRowCount() )

NullPointerException - if the specified row is null

IllegalArgumentException - if the rows does not match the column definitions

insert

void insert(int rowIndex,
            Collection<T> rows)

Inserts a row or rows at the specified position in the table data list. Shifts the row at that position (if any) an any subsequent rows down. The internal ordering of the inserted rows are determined by the iteration order of the rows collection.

Parameters:

rowIndex - table data's index at which the specified row is to be inserted

rows - rows to be inserted

Throws:

IndexOutOfBoundsException - if the specified row index is out of range ( rowIndex < 0 || rowIndex > getTableDataRowCount() )

NullPointerException - if the specified row is null

IllegalArgumentException - if the rows does not match the column definitions

add

void add(T... row)

Appends the specified rows to this table data's list.

Parameters:

row - the row or rows to append

Throws:

NullPointerException - if rows is null or contains a null reference

IllegalArgumentException - if the rows does not match the column definitions

add

void add(Collection<T> rows)

Appends the specified rows to this table data's list.

Parameters:

rows - the rows append

Throws:

NullPointerException - if rows is null or contains a null reference

IllegalArgumentException - if the rows does not match the column definitions

remove

T remove(int rowIndex)

Removes the row at the specified table data index. Subsequent rows (if any) are shifted up.

Parameters:

rowIndex - table data's index of the row to remove.

Returns:

the removed row

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getRowCount())

remove

boolean remove(T... row)

Removes specified row or rows from the table data list. Subsequent rows (if any) are shifted up.

Parameters:

row - the row or rows to remove.

Returns:

true if the table data changed as a result of the call

removeAll

boolean removeAll(Collection<T> rows)

Removes specified row or rows from the table data list. See remove(ListRow...)

Parameters:

rows - the rows to remove.

Returns:

true if the table data changed as a result of the call

clear

void clear()

Clears this table model by removing all ListRows.

isEmpty

boolean isEmpty()

Test if this table model contains any rows.

Returns:

true if this table model is empty ( getTableDataRowCount() == 0)

setSelected

void setSelected(int rowIndex,
                 boolean selected)

Set the selected property of the specified row.

Parameters:

rowIndex - table data's index of the row

selected - if true the row will be selected

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

IllegalStateException - if the selection model prohibits the selection

See Also:

getSelectionModel()

setSelected

void setSelected(T row,
                 boolean selected)

Set the selected property of the specified row.

Parameters:

row - the row to select

selected - if true the row will be selected

Throws:

IllegalStateException - if the selection model prohibits the selection

See Also:

getSelectionModel()

setSelected

void setSelected(boolean selected)

Set the selected property of all rows.

Parameters:

selected - if true the row will be selected

Throws:

IllegalStateException - if the selection model prohibits the selection

See Also:

getSelectionModel()

isSelected

boolean isSelected(int rowIndex)

Test if the specified row is selected.

Parameters:

rowIndex - table data's index of the row to test

Returns:

true if the specified row is selected.

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

getSelected

List<T> getSelected()

Get the list of selected rows. The list maintains the internal original ordering of the selected rows.

Returns:

a list of selected rows.

getSelectionCount

int getSelectionCount()

Get the number of selected rows.

Returns:

number of selected rows

setEnabled

void setEnabled(boolean enabled)

Set the enabled property for all cells in the entire table.

Parameters:

enabled - if true, all cells in the row will be enabled

See Also:

isCellEnabled(int, DialogObjectConstant)

setRowEnabled

void setRowEnabled(int rowIndex,
                   boolean enabled)

Set the enabled property for all cells in the specified row.

Parameters:

rowIndex - table data's index of the row to set editable

enabled - if true, all cells in the row will be enabled

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

See Also:

isCellEnabled(int, DialogObjectConstant)

setRowEnabled

void setRowEnabled(T row,
                   boolean enabled)

Set the enabled property for all cells in the specified row.

Parameters:

row - the row to set editable

enabled - if true, all cells in the row will be enabled

See Also:

isCellEnabled(int, DialogObjectConstant)

setColumnEnabled

void setColumnEnabled(DialogObjectConstant columnIdentifier,
                      boolean enabled)

Set the enabled property for all cells in the specified column.

Parameters:

columnIdentifier - constant denoting the column

enabled - if true, all cells in the column will be enabled

Throws:

NoSuchElementException - if the specified column is not part of this table model

See Also:

isCellEnabled(int, DialogObjectConstant)

setCellEnabled

void setCellEnabled(int rowIndex,
                    DialogObjectConstant columnIdentifier,
                    boolean enabled)

Set the enabled property the specified cell.

Parameters:

rowIndex - table data's row index

columnIdentifier - constant denoting the column

enabled - if true, the cells will be editable

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

NoSuchElementException - if the specified column is not part of this table model

See Also:

isCellEnabled(int, DialogObjectConstant)

isCellEnabled

boolean isCellEnabled(int rowIndex,
                      DialogObjectConstant columnIdentifier)

Get the enabled property value of the specified cell. If the enabled property of a cell is false the cell will not be able to receive focus. If the cell is visible and enabled the cell will be able to receive focus.

Parameters:

rowIndex - table data's row index

columnIdentifier - constant denoting the column

Returns:

true if the cell is enabled

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

NoSuchElementException - if the specified column is not part of this table model

setShown

void setShown(boolean shown)

Set the shown property for all cells in the table.

Parameters:

shown - if true, all cells in the row will be rendered

See Also:

isCellShown(int, DialogObjectConstant)

setRowShown

void setRowShown(int rowIndex,
                 boolean shown)

Set the shown property for all cells in the specified row.

Parameters:

rowIndex - table data's row index

shown - if true, all cells in the row will be rendered

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

See Also:

isCellShown(int, DialogObjectConstant)

setRowShown

void setRowShown(T row,
                 boolean shown)

Set the shown property for all cells in the specified row.

Parameters:

row - the row to set shown

shown - if true, all cells in the row will be rendered

See Also:

isCellShown(int, DialogObjectConstant)

setColumnShown

void setColumnShown(DialogObjectConstant columnIdentifier,
                    boolean shown)

Set the shown property for all cells in the specified column.

Parameters:

columnIdentifier - constant denoting the column

shown - if true, all cells in the column will be rendered

Throws:

NoSuchElementException - if the specified column is not part of this table model

See Also:

isCellEnabled(int, DialogObjectConstant)

setCellShown

void setCellShown(int rowIndex,
                  DialogObjectConstant columnIdentifier,
                  boolean shown)

Set the shown property the specified cell.

Parameters:

rowIndex - table data's row index

columnIdentifier - constant denoting the column

shown - if true, the cell will be rendered

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

NoSuchElementException - if the specified column is not part of this table model

See Also:

isCellEnabled(int, DialogObjectConstant)

isCellShown

boolean isCellShown(int rowIndex,
                    DialogObjectConstant columnIdentifier)

Get the shown property value of the specified cell. If the shown property of a cell is true the cell will be rendered.

Parameters:

rowIndex - table data's row index

columnIdentifier - constant denoting the column

Returns:

true if the cell is shown

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

NoSuchElementException - if the specified column is not part of this table model

setProperty

<U> void setProperty(Property<U> property,
                     U propertyValue)

Set the specified property on all cells in the table.

Type Parameters:

U - The property value type

Parameters:

property - the property

propertyValue - value of the property

setRowProperty

<U> void setRowProperty(int rowIndex,
                        Property<U> property,
                        U propertyValue)

Set the specified property on all cells in the row.

Type Parameters:

U - The property value type

Parameters:

rowIndex - table data's row index

property - the property

propertyValue - value of the property

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

setRowProperty

<U> void setRowProperty(T row,
                        Property<U> property,
                        U propertyValue)

Set the specified property on all cells in the row.

Type Parameters:

U - The property value type

Parameters:

row - table row to set the property on

property - the property

propertyValue - value of the property

setColumnProperty

<U> void setColumnProperty(DialogObjectConstant columnIdentifier,
                           Property<U> propertyName,
                           U value)

Set the specified property on all cells in the column.

Type Parameters:

U - The property value type

Parameters:

columnIdentifier - constant denoting the column

propertyName - name identifying the property

value - value of the property

Throws:

NoSuchElementException - if the specified column is not part of this table model

setCellProperty

<U> void setCellProperty(int rowIndex,
                         DialogObjectConstant columnIdentifier,
                         Property<U> propertyName,
                         U propertyValue)

Set the specified property on the specified cell.

Type Parameters:

U - The property value type

Parameters:

rowIndex - table data's row index

columnIdentifier - constant denoting the column

propertyName - name identifying the property

propertyValue - value of the property

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

NoSuchElementException - if the specified column is not part of this table model

getCellProperty

<U> U getCellProperty(int rowIndex,
                      DialogObjectConstant columnIdentifier,
                      Property<U> propertyName)

Get the property value for the specified cell.

Type Parameters:

U - The property value type

Parameters:

rowIndex - table data's row index

columnIdentifier - constant denoting the column

propertyName - name identifying the property

Returns:

value of the property

Throws:

IndexOutOfBoundsException - if the specified index is out of range ( rowIndex < 0 || rowIndex >= getTableDataRowCount() )

NoSuchElementException - if the specified column is not part of this table model

prettyPrint

void prettyPrint(PrintStream out)

Debug print the table contents to specified print stream. OBS: This method should not be invoked in production code.

This method is intended for debug purposes only and should be considered as an advanced variant of the general toString() method. The exact format of the printed text may vary between releases (even patches).

Parameters:

out - the print stream to write to.