org.knime.core.node.util.dialog

Class FieldsTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

javax.swing.table.DefaultTableModel

org.knime.core.node.util.DefaultConfigTableModel

org.knime.core.node.util.dialog.FieldsTableModel

All Implemented Interfaces:

Serializable, TableModel, ConfigTableModel

Direct Known Subclasses:

OutFieldsTableModel

public abstract class FieldsTableModel
extends DefaultConfigTableModel

Extends the table model by validation methods.

This class might change and is not meant as public API.

Since:

3.3

Author:

Christian Albrecht, KNIME.com GmbH, Konstanz Germany

See Also:

Serialized Form

No public API: not to be instantiated by clients

This class is not intended to be instantiated by clients.

No public API: not to be extended by clients

This class is not intended to be subclassed by clients.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldsTableModel.Column The columns of the output table.

Field Summary

Fields inherited from class javax.swing.table.DefaultTableModel

columnIdentifiers, dataVector

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor and Description
FieldsTableModel(String[] columns) Create a model with the given column names.

Method Summary

Modifier and Type	Method and Description
abstract String	getErrorMessage(int row, FieldsTableModel.Column column) Gives the error message when isValidValue(row, column) returns false.
String	getErrorMessage(int row, int column) Gives the error message when isValidValue(row, column) returns false.
int	getIndex(FieldsTableModel.Column column) Get the index of the column.
Object	getValueAt(int row, FieldsTableModel.Column column) Returns an attribute value for the cell at row and column.
boolean	isUnique(Object value, int row, FieldsTableModel.Column column, FieldsTableModel.Column typeColumn) Checks whether to given value is unique in the given column.
abstract boolean	isValidValue(int row, FieldsTableModel.Column column) Test whether the value of the cell defined by row and column is valid.
(package private) boolean	isValidValue(int row, int column) Test whether the value of the cell defined by row and column is valid.
protected void	setColumnsMap(Map<FieldsTableModel.Column,Integer> columns) Fill the mapping of columns to there actual position on the table.
void	setValueAt(Object aValue, int row, FieldsTableModel.Column column) Sets the object value for the cell at column and row.
boolean	validateValues() Checks whether the all cell values are valid.
boolean	validateValues(int row) Checks whether the cell values in the given row are valid.

Methods inherited from class org.knime.core.node.util.DefaultConfigTableModel

addRow, clear, cloneModel, getColumnName, isCellEditable, removeRows, setColumnName, setTableData

Methods inherited from class javax.swing.table.DefaultTableModel

addColumn, addColumn, addColumn, addRow, addRow, convertToVector, convertToVector, getColumnCount, getDataVector, getRowCount, getValueAt, insertRow, insertRow, moveRow, newDataAvailable, newRowsAdded, removeRow, rowsRemoved, setColumnCount, setColumnIdentifiers, setColumnIdentifiers, setDataVector, setDataVector, setNumRows, setRowCount, setValueAt

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getColumnClass, getListeners, getTableModelListeners, removeTableModelListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, getColumnClass, getColumnCount, getRowCount, getValueAt, removeTableModelListener, setValueAt

Constructor Detail

FieldsTableModel

public FieldsTableModel(String[] columns)

Create a model with the given column names.

Parameters:

columns - the column names.

Method Detail

setColumnsMap

protected void setColumnsMap(Map<FieldsTableModel.Column,Integer> columns)

Fill the mapping of columns to there actual position on the table.

Parameters:

columns - the columns map to fill.

getValueAt

public Object getValueAt(int row,
                         FieldsTableModel.Column column)

Returns an attribute value for the cell at row and column.

Parameters:

row - the row whose value is to be queried

column - the column whose value is to be queried

Returns:

the value Object at the specified cell

Throws:

ArrayIndexOutOfBoundsException - if an invalid row or column was given

setValueAt

public void setValueAt(Object aValue,
                       int row,
                       FieldsTableModel.Column column)

Sets the object value for the cell at column and row. aValue is the new value. This method will generate a tableChanged notification.

Parameters:

aValue - the new value; this can be null

row - the row whose value is to be changed

column - the column whose value is to be changed

Throws:

ArrayIndexOutOfBoundsException - if an invalid row or column was given

getIndex

public int getIndex(FieldsTableModel.Column column)

Get the index of the column.

Parameters:

column - the column

Returns:

the index of the column of -1 if the column is not found.

isValidValue

public abstract boolean isValidValue(int row,
                                     FieldsTableModel.Column column)

Test whether the value of the cell defined by row and column is valid.

Parameters:

row - the row index of the cell

column - the column of the cell

Returns:

true when cell value is valid

getErrorMessage

public abstract String getErrorMessage(int row,
                                       FieldsTableModel.Column column)

Gives the error message when isValidValue(row, column) returns false.

Parameters:

row - the row index of the cell

column - the column index of the cell

Returns:

the error message or null when cell value is valid.

isValidValue

boolean isValidValue(int row,
                     int column)

Test whether the value of the cell defined by row and column is valid.

Parameters:

row - the row index of the cell

column - the column of the cell

Returns:

true when cell value is valid

getErrorMessage

public String getErrorMessage(int row,
                              int column)

Gives the error message when isValidValue(row, column) returns false.

Parameters:

row - the row index of the cell

column - the column index of the cell

Returns:

the error message or null when cell value is valid.

validateValues

public boolean validateValues(int row)

Checks whether the cell values in the given row are valid.

Parameters:

row - the row to check

Returns:

true when all tested values are valid

validateValues

public boolean validateValues()

Checks whether the all cell values are valid.

Returns:

true when all values are valid

isUnique

public boolean isUnique(Object value,
                        int row,
                        FieldsTableModel.Column column,
                        FieldsTableModel.Column typeColumn)

Checks whether to given value is unique in the given column. Optionally provide a type column to ensure uniqueness in the column per type.

Parameters:

value - the value to check

row - the row

column - the column

typeColumn - the type column, can be null

Returns:

true when value is unique with special constraints.