Package adams.gui.core

Interface TableWithColumnFilters

All Known Implementing Classes:

InformativeStatisticFactory.Table, InstanceReportFactory.Table, InstancesTable, InstanceTable, ReportFactory.Table, SortableAndSearchableTable, SpreadSheetCellSelector.Table, SpreadSheetRowReportFactory.Table, SpreadSheetTable, XYSequenceTable

public interface TableWithColumnFilters

Interface for tables that can be filtered per column.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	getColumnFilter(int column)	Returns the filter for the column.
boolean	isAnyColumnFiltered()	Returns whether there is at least one filter active.
boolean	isColumnFiltered(int column)	Returns whether there is a filter active for the column.
boolean	isColumnFilterRegExp(int column)	Returns whether the filter for the column is a regular expression.
void	removeAllColumnFilters()	Removes all column filters
void	removeColumnFilter(int column)	Removes any filter for the column.
void	setColumnFilter(int column, String filter, boolean isRegExp)	Sets the filter for the column.

Method Detail

setColumnFilter

void setColumnFilter(int column,
                     String filter,
                     boolean isRegExp)

Sets the filter for the column.

Parameters:

column - the column to filter

filter - the filter string

isRegExp - whether the filter is a regular expression

getColumnFilter

String getColumnFilter(int column)

Returns the filter for the column.

Parameters:

column - the column to query

Returns:

the filter, null if none present

isColumnFilterRegExp

boolean isColumnFilterRegExp(int column)

Returns whether the filter for the column is a regular expression.

Parameters:

column - the column to query

Returns:

true if filter set and regular expression

isColumnFiltered

boolean isColumnFiltered(int column)

Returns whether there is a filter active for the column.

Parameters:

column - the column to query

Returns:

true if a filter is active

isAnyColumnFiltered

boolean isAnyColumnFiltered()

Returns whether there is at least one filter active.

Returns:

true if at least one filter is active

removeColumnFilter

void removeColumnFilter(int column)

Removes any filter for the column.

Parameters:

column - the column to update

removeAllColumnFilters

void removeAllColumnFilters()

Removes all column filters