com.sciapp.treetable
Interface FilterTreeTableModel

All Superinterfaces:

TreeModel, TreeTableModel

All Known Implementing Classes:

DefaultFilterTreeTableModel

public interface FilterTreeTableModel
extends TreeTableModel

FilterTreeTableModel is an interface that a treetable model with filtering capabilities should implement.

Field Summary

Fields inherited from interface com.sciapp.treetable.TreeTableModel

CHANGE_COLUMN_SOURCE

Method Summary

void	addFilterTreeTableModelListener(FilterTreeTableModelListener l) Adds a FilterTreeTableModelListener that is notified each time filters are added or removed.
void	clearFilters() Removes all assigned filters.
TableFilter	getFilterAtLevel(int level) Retrieves the TableFilter that is assigned at the node level identified by level.
TableFilter	getFilterAtNode(Object node) Retrieves the TableFilter that is assigned for the node identified by node.
TreeTableModel	getUnfilteredTreeTableModel() Retrieves the TreeTableModel that holds the unfiltered data.
void	removeFilterTreeTableModelListener(FilterTreeTableModelListener l) Removes a FilterTreeTableModelListener that is notified each time filters are added or removed.
TableFilter	retrieveFilter(Object node) Determines the table filter to use for the node identified by node.
void	setFilterAtLevel(TableFilter filter, int level) Assigns a TableFilter at the node level identified by level.
void	setFilterAtNode(TableFilter filter, Object node) Assigns a TableFilter for the node identified by node.

Methods inherited from interface com.sciapp.treetable.TreeTableModel

getColumnClass, getColumnCount, getColumnName, getValueAt, isAggregate, isCellEditable, isFooter, isHeader, setValueAt

Methods inherited from interface javax.swing.tree.TreeModel

addTreeModelListener, getChild, getChildCount, getIndexOfChild, getRoot, isLeaf, removeTreeModelListener, valueForPathChanged

Method Detail

addFilterTreeTableModelListener

void addFilterTreeTableModelListener(FilterTreeTableModelListener l)

Adds a FilterTreeTableModelListener that is notified each time filters are added or removed.

Parameters:

l - the listener to add

clearFilters

void clearFilters()

Removes all assigned filters.

getFilterAtLevel

TableFilter getFilterAtLevel(int level)

Retrieves the TableFilter that is assigned at the node level identified by level.

Returns:

the table filter for level

getFilterAtNode

TableFilter getFilterAtNode(Object node)

Retrieves the TableFilter that is assigned for the node identified by node.

Returns:

the table filter for node

getUnfilteredTreeTableModel

TreeTableModel getUnfilteredTreeTableModel()

Retrieves the TreeTableModel that holds the unfiltered data.

Returns:

the unfiltered treetable model

removeFilterTreeTableModelListener

void removeFilterTreeTableModelListener(FilterTreeTableModelListener l)

Removes a FilterTreeTableModelListener that is notified each time filters are added or removed.

Parameters:

l - the listener to remove

retrieveFilter

TableFilter retrieveFilter(Object node)

Determines the table filter to use for the node identified by node.

Parameters:

node - the node for which the filter is evaluated

Returns:

the table filter

setFilterAtLevel

void setFilterAtLevel(TableFilter filter,
                      int level)

Assigns a TableFilter at the node level identified by level.

Parameters:

filter - the table filter to assign

level - the level to assign the filter at

setFilterAtNode

void setFilterAtNode(TableFilter filter,
                     Object node)

Assigns a TableFilter for the node identified by node.

Parameters:

filter - the table filter to assign

node - the node for which the filter is assigned