org.jdesktop.swing.decorator
Class Filter

java.lang.Object
  org.jdesktop.swing.decorator.Filter

Direct Known Subclasses:

PatternFilter, Sorter

public abstract class Filter

extends Object

A Filter is used to filter the data presented in a data-aware component such as a JXList or a JXTable. Filtering involves interposing one or more filters in a FilterPipeline between a data model and a view to change the apparent order and/or number of records in the data model.

See Also:

FilterPipeline, JXTable

Field Summary

protected ComponentAdapter

adapter

Constructor Summary

Filter()
Constructs a new filter for the first column of a data model (in model coordinates).

Filter(int col)
Constructs a new filter for the specified column of a data model (in model coordinates).

Method Summary

int	convertRowIndexToModel(int row) Convert row index from view coordinates to model coordinates accounting for the presence of sorters and filters.
int	convertRowIndexToView(int row) Convert row index from model coordinates to view coordinates accounting for the presence of sorters and filters.
protected abstract void	filter() Performs the filter operation defined by this filter.
protected abstract void	generateMappingFromPrevious() Generates the row mappings from the previous filter to this filter.
int	getColumnIndex() Returns the model index of the column that this filter has been bound to.
String	getColumnName()
protected int	getInputSize() Returns the number of records that are processed by this filter.
protected Object	getInputValue(int row, int column) Returns the value of the cell at the specified row and column (in model coordinates).
protected FilterPipeline	getPipeline()
abstract int	getSize() Returns the number of records that remain in this filter's "view" after the input records have been filtered.
Object	getValueAt(int row, int column) Returns the value at the specified row and column.
protected abstract void	init() Provides filter-specific initialization.
boolean	isCellEditable(int row, int column)
void	refresh() Refreshes the internal state of the filter, performs the filter operation and regenerates row mappings from the previous filter.
protected void	refresh(boolean reset) Refreshes the internal state of the filter, optionally resetting the cache of existing row mappings from this filter to the previous filter.
protected abstract void	reset() Resets the internal row mappings from this filter to the previous filter.
void	setValueAt(Object aValue, int row, int column) Sets the specified value as the new value for the cell identified by the specified row and column index.
protected abstract int	translateFromPreviousFilter(int row) Returns the row in this filter that maps to the specified row in the previous filter.
protected abstract int	translateToPreviousFilter(int row) Returns the row in the previous filter that maps to the specified row in this filter.

Methods inherited from class java.lang.Object

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

Field Detail

adapter

protected ComponentAdapter adapter

Constructor Detail

Filter

public Filter()

Constructs a new filter for the first column of a data model (in model coordinates).

Filter

public Filter(int col)

Constructs a new filter for the specified column of a data model (in model coordinates).

Parameters:

col - column index in model coordinates

Method Detail

init

protected abstract void init()

Provides filter-specific initialization. Called from the Filter constructor.

reset

protected abstract void reset()

Resets the internal row mappings from this filter to the previous filter.

generateMappingFromPrevious

protected abstract void generateMappingFromPrevious()

Generates the row mappings from the previous filter to this filter.

filter

protected abstract void filter()

Performs the filter operation defined by this filter.

refresh

public void refresh()

Refreshes the internal state of the filter, performs the filter operation and regenerates row mappings from the previous filter. If this filter is bound to a filter pipeline (as most filters are), it also triggers a filterChanged notification.

refresh

protected void refresh(boolean reset)

Refreshes the internal state of the filter, optionally resetting the cache of existing row mappings from this filter to the previous filter. Always performs the filter operation and regenerates row mappings from the previous filter. If this filter is bound to a filter pipeline (as most filters are), it also triggers a filterChanged notification.

Parameters:

reset - true if existing row mappings from this filter to the previous filter should be reset; false, if the existing row mappings should be preserved.

getPipeline

protected FilterPipeline getPipeline()

getColumnIndex

public int getColumnIndex()

Returns the model index of the column that this filter has been bound to.

Returns:

the model index of the column that this filter has been bound to

getColumnName

public String getColumnName()

convertRowIndexToModel

public int convertRowIndexToModel(int row)

Convert row index from view coordinates to model coordinates accounting for the presence of sorters and filters.

Parameters:

row - row index in view coordinates

Returns:

row index in model coordinates

convertRowIndexToView

public int convertRowIndexToView(int row)

Convert row index from model coordinates to view coordinates accounting for the presence of sorters and filters.

Parameters:

row - row index in model coordinates

Returns:

row index in view coordinates

getSize

public abstract int getSize()

Returns the number of records that remain in this filter's "view" after the input records have been filtered.

Returns:

the number of records that remain in this filter's "view" after the input records have been filtered

translateFromPreviousFilter

protected abstract int translateFromPreviousFilter(int row)

Returns the row in this filter that maps to the specified row in the previous filter. If there is no previous filter in the pipeline, this returns the row in this filter that maps to the specified row in the data model. This method is called from convertRowIndexToView

Parameters:

row - a row index in the previous filter's "view" of the data model

Returns:

the row in this filter that maps to the specified row in the previous filter

translateToPreviousFilter

protected abstract int translateToPreviousFilter(int row)

Returns the row in the previous filter that maps to the specified row in this filter. If there is no previous filter in the pipeline, this returns the row in the data model that maps to the specified row in this filter. This method is called from convertRowIndexToModel

Parameters:

row - a row index in this filter's "view" of the data model

Returns:

the row in the previous filter that maps to the specified row in this filter

getValueAt

public Object getValueAt(int row,
                         int column)

Returns the value at the specified row and column.

Parameters:

row - row index in view coordinates

column - column index in model coordinates

Returns:

the value at the specified row and column

setValueAt

public void setValueAt(Object aValue,
                       int row,
                       int column)

Sets the specified value as the new value for the cell identified by the specified row and column index.

Parameters:

aValue - new value for the specified cell

row - row index in view coordinates

column - column index in model coordinates

isCellEditable

public boolean isCellEditable(int row,
                              int column)

getInputSize

protected int getInputSize()

Returns the number of records that are processed by this filter.

Returns:

the number of records that are processed by this filter

getInputValue

protected Object getInputValue(int row,
                               int column)

Returns the value of the cell at the specified row and column (in model coordinates).

Parameters:

row - in the coordinates of what is the filter's "view" of the model

column - in model coordinates

Returns:

the value of the cell at the specified row and column (in model coordinates)