org.knime.core.node.util

Interface ColumnSelectionSearchableListPanel.ListModifier

Enclosing class:

ColumnSelectionSearchableListPanel

public static interface ColumnSelectionSearchableListPanel.ListModifier

The ListModifier is returned by calling ColumnSelectionSearchableListPanel.update(DataTableSpec) or ColumnSelectionSearchableListPanel.update(DataTableSpec, ColumnFilter) and provides the functions to add/remove additional DataColumnSpecs. An additional column is one which is not part of the actual DataTableSpec, which also indicates that it is possible to remove them. A special variant of additional columns are the 'invalid' ones created by DataColumnSpecListCellRenderer.createInvalidSpec(String, DataType) indicating columns which are previously configured but actually do not exist in the input table. These columns are rendered with a red border on default. Other types of additional columns and a customized ListCellRenderer may be used for a arbitrary highlighting of certain additional columns.

Author:

Marcel Hanser

Method Summary

Modifier and Type	Method and Description
ColumnSelectionSearchableListPanel.ListModifier	addAdditionalColumn(DataColumnSpec column) Adds an additional column to the model.
ColumnSelectionSearchableListPanel.ListModifier	addAdditionalColumns(DataColumnSpec... columns) Adds additional columns to the model.
ColumnSelectionSearchableListPanel.ListModifier	addAdditionalColumns(Iterable<DataColumnSpec> columns) Adds additional columns to the model.
ColumnSelectionSearchableListPanel.ListModifier	addInvalidColumns(DataType type, String... columns) Creates and adds invalid column specs of the given type for the given column names.
ColumnSelectionSearchableListPanel.ListModifier	addInvalidColumns(String... columns) Creates and adds invalid columns pecs for the given column names.See ColumnSelectionSearchableListPanel.ListModifier for more information about invalid columns.
ColumnSelectionSearchableListPanel.ListModifier	removeAdditionalColumn(String column) Removes an additional column from the model.
ColumnSelectionSearchableListPanel.ListModifier	removeAdditionalColumns(Iterable<String> columns) Removes additional columns from the model.
ColumnSelectionSearchableListPanel.ListModifier	removeAdditionalColumns(String... columns) Removes additional columns from the model.

Method Detail

addInvalidColumns

ColumnSelectionSearchableListPanel.ListModifier addInvalidColumns(DataType type,
                                                                  String... columns)

Creates and adds invalid column specs of the given type for the given column names. See ColumnSelectionSearchableListPanel.ListModifier for more information about invalid columns.

Parameters:

type - the type of the invalud column

columns - the column names

Returns:

this modifier

Throws:

IllegalArgumentException - if one column does already exist in the list, including as well as the additional columns as well as the original DataTableSpec

IllegalStateException - if this modfier is invalid

See Also:

DataColumnSpecListCellRenderer.createInvalidSpec(String, DataType)

addInvalidColumns

ColumnSelectionSearchableListPanel.ListModifier addInvalidColumns(String... columns)

Creates and adds invalid columns pecs for the given column names.See ColumnSelectionSearchableListPanel.ListModifier for more information about invalid columns.

Parameters:

columns - the column names

Returns:

this modifier

Throws:

IllegalArgumentException - if one column does already exist in the list, including as well as the additional columns as well as the original DataTableSpec

IllegalStateException - if this modfier is invalid

See Also:

DataColumnSpecListCellRenderer.createInvalidSpec(String)

addAdditionalColumns

ColumnSelectionSearchableListPanel.ListModifier addAdditionalColumns(Iterable<DataColumnSpec> columns)

Adds additional columns to the model. See ColumnSelectionSearchableListPanel.ListModifier for more information about additional columns.

Parameters:

columns - the columns to add

Returns:

this modfier

Throws:

IllegalArgumentException - if the column does already exist in the list, including as well as the additional columns as well as the original DataTableSpec

IllegalStateException - if this modfier is invalid

addAdditionalColumns

ColumnSelectionSearchableListPanel.ListModifier addAdditionalColumns(DataColumnSpec... columns)

Adds additional columns to the model. See ColumnSelectionSearchableListPanel.ListModifier for more information about additional columns.

Parameters:

columns - the columns to add

Returns:

this modfier

Throws:

IllegalArgumentException - if one column does already exist in the list, including as well as the additional columns as well as the original DataTableSpec

IllegalStateException - if this modfier is invalid

addAdditionalColumn

ColumnSelectionSearchableListPanel.ListModifier addAdditionalColumn(DataColumnSpec column)

Adds an additional column to the model. See ColumnSelectionSearchableListPanel.ListModifier for more information about additional columns.

Parameters:

column - the column to add

Returns:

this modfier

Throws:

IllegalArgumentException - if one column does already exist in the list, including as well as the additional columns as well as the original DataTableSpec

IllegalStateException - if this modfier is invalid

removeAdditionalColumns

ColumnSelectionSearchableListPanel.ListModifier removeAdditionalColumns(String... columns)

Removes additional columns from the model. See ColumnSelectionSearchableListPanel.ListModifier for more information about additional columns.

Parameters:

columns - the columns to remove

Returns:

this modfier

Throws:

IllegalStateException - if this modfier is invalid

IllegalArgumentException - if one column is contained in the original DataTableSpec

removeAdditionalColumns

ColumnSelectionSearchableListPanel.ListModifier removeAdditionalColumns(Iterable<String> columns)

Removes additional columns from the model. See ColumnSelectionSearchableListPanel.ListModifier for more information about additional columns.

Parameters:

columns - the columns to remove

Returns:

this modfier

Throws:

IllegalStateException - if this modfier is invalid

IllegalArgumentException - if one column is contained in the original DataTableSpec

removeAdditionalColumn

ColumnSelectionSearchableListPanel.ListModifier removeAdditionalColumn(String column)

Removes an additional column from the model. See ColumnSelectionSearchableListPanel.ListModifier for more information about additional columns.

Parameters:

column - the column to remove

Returns:

this modfier

Throws:

IllegalStateException - if this modfier is invalid

IllegalArgumentException - if the column is contained in the original DataTableSpec