DefaultRowSorter JDK 1.6)

Description

publicabstract abstract class DefaultRowSorter

An implementation of RowSorter that provides sorting and filtering around a grid-based data model.

An implementation of RowSorter that provides sorting and filtering around a grid-based data model. Beyond creating and installing a RowSorter, you very rarely need to interact with one directly. Refer to TableRowSorter for a concrete implementation of RowSorter for JTable.

Sorting is done based on the current SortKeys, in order. If two objects are equal (the Comparator for the column returns 0) the next SortKey is used. If no SortKeys remain or the order is UNSORTED, then the order of the rows in the model is used.

Sorting of each column is done by way of a Comparator that you can specify using the setComparator method. If a Comparator has not been specified, the Comparator returned by Collator.getInstance() is used on the results of calling toString on the underlying objects. The Comparator is never passed null. A null value is treated as occuring before a non-null value, and two null values are considered equal.

If you specify a Comparator that casts its argument to a type other than that provided by the model, a ClassCastException will be thrown when the data is sorted.

In addition to sorting, DefaultRowSorter provides the ability to filter rows. Filtering is done by way of a RowFilter that is specified using the setRowFilter method. If no filter has been specified all rows are included.

By default, rows are in unsorted order (the same as the model) and every column is sortable. The default Comparators are documented in the subclasses (for example, TableRowSorter).

If the underlying model structure changes (the modelStructureChanged method is invoked) the following are reset to their default values: Comparators by column, current sort order, and whether each column is sortable. To find the default Comparators, see the concrete implementation (for example, TableRowSorter). The default sort order is unsorted (the same as the model), and columns are sortable by default.

DefaultRowSorter is an abstract class. Concrete subclasses must provide access to the underlying data by invoking setModelWrapper. The setModelWrapper method must be invoked soon after the constructor is called, ideally from within the subclass's constructor. Undefined behavior will result if you use a DefaultRowSorter without specifying a ModelWrapper.

DefaultRowSorter has two formal type parameters. The first type parameter corresponds to the class of the model, for example DefaultTableModel. The second type parameter corresponds to the class of the identifier passed to the RowFilter. Refer to TableRowSorter and RowFilter for more details on the type parameters.

See also: TableRowSorter DefaultTableModel Collator

Methods

Hide/Show inherited methods

public void addRowSorterListener (RowSorterListener l) [Inherited From RowSorter]

Adds a RowSorterListener to receive notification about this RowSorter.

Adds a RowSorterListener to receive notification
about this RowSorter. If the same
listener is added more than once it will receive multiple
notifications. If l is null nothing
is done.
Parameters:
- l - the RowSorterListener

public void allRowsChanged () [Specified in RowSorter]

Invoked when the contents of the underlying model have completely changed.

public int convertRowIndexToModel (int index) [Specified in RowSorter]

Returns the location of index in terms of the underlying model.

Returns the location of index in terms of the
underlying model. That is, for the row index in
the coordinates of the view this returns the row index in terms
of the underlying model.
Throws:
- IndexOutOfBoundsException - {@inheritDoc}

public int convertRowIndexToView (int index) [Specified in RowSorter]

Returns the location of index in terms of the view.

Returns the location of index in terms of the
view. That is, for the row index in the
coordinates of the underlying model this returns the row index
in terms of the view.
Throws:
- IndexOutOfBoundsException - {@inheritDoc}

protected void fireRowSorterChanged (int[] lastRowIndexToModel) [Inherited From RowSorter]

Notifies listener that the mapping has changed.

Notifies listener that the mapping has changed.
Parameters:
- lastRowIndexToModel - the mapping from model indices to view indices prior to the sort, may be null

pack-private void fireRowSorterChanged (RowSorterEvent event) [Inherited From RowSorter]

protected void fireSortOrderChanged () [Inherited From RowSorter]

Notifies listener that the sort order has changed.

public Comparator<Object> getComparator (int column)

Returns the Comparator for the specified column.

Returns the Comparator for the specified
column. This will return null if a Comparator
has not been specified for the column.
Returns: the Comparator for the specified column
Parameters:
- column - the column to fetch the Comparator for, in terms of the underlying model
Throws:
- IndexOutOfBoundsException - if column is outside the range of the underlying model

public int getMaxSortKeys ()

Returns the maximum number of sort keys.

publicfinal M getModel () [Specified in RowSorter]

Returns the underlying model.

public int getModelRowCount () [Specified in RowSorter]

Returns the number of rows in the underlying model.

protectedfinal ModelWrapper< M, I> getModelWrapper ()

Returns the model wrapper providing the data that is being sorted and filtered.

public RowFilter<Object, Object> getRowFilter ()

Returns the filter that determines which rows, if any, should be hidden from view.

public List<SortKey> getSortKeys () [Specified in RowSorter]

Returns the current sort keys.

Returns the current sort keys. This returns an unmodifiable
non-null List. If you need to change the sort keys,
make a copy of the returned List, mutate the copy
and invoke setSortKeys with the new list.
Returns: the current sort order

public boolean getSortsOnUpdates ()

Returns true if a sort should happen when the underlying model is updated; otherwise, returns false.

public int getViewRowCount () [Specified in RowSorter]

Returns the number of rows in the view.

public boolean isSortable (int column)

Returns true if the specified column is sortable; otherwise, false.

public void modelStructureChanged () [Specified in RowSorter]

Invoked when the underlying model structure has completely changed.

Invoked when the underlying model structure has completely changed. For example, if the number of columns in a TableModel changed, this method would be invoked.

You normally do not call this method. This method is public to allow view classes to call it.

public void removeRowSorterListener (RowSorterListener l) [Inherited From RowSorter]

Removes a RowSorterListener.

Removes a RowSorterListener. If
l is null nothing is done.
Parameters:
- l - the RowSorterListener

public void rowsDeleted (int firstRow, int endRow) [Specified in RowSorter]

Invoked when rows have been deleted from the underlying model in the specified range (inclusive).

public void rowsInserted (int firstRow, int endRow) [Specified in RowSorter]

Invoked when rows have been inserted into the underlying model in the specified range (inclusive).

public void rowsUpdated (int firstRow, int endRow) [Specified in RowSorter]

Invoked when rows have been changed in the underlying model between the specified range (inclusive).

public void rowsUpdated (int firstRow, int endRow, int column) [Specified in RowSorter]

Invoked when the column in the rows have been updated in the underlying model between the specified range.

public void setComparator (int column, Comparator<Object> comparator)

Sets the Comparator to use when sorting the specified column.

Sets the Comparator to use when sorting the specified
column. This does not trigger a sort. If you want to sort after
setting the comparator you need to explicitly invoke sort.
Parameters:
- column - the index of the column the Comparator is to be used for, in terms of the underlying model
- comparator - the Comparator to use
Throws:
- IndexOutOfBoundsException - if column is outside the range of the underlying model

public void setMaxSortKeys (int max)

Sets the maximum number of sort keys.

Sets the maximum number of sort keys. The number of sort keys determines how equal values are resolved when sorting. For example, assume a table row sorter is created and setMaxSortKeys(2) is invoked on it. The user clicks the header for column 1, causing the table rows to be sorted based on the items in column 1. Next, the user clicks the header for column 2, causing the table to be sorted based on the items in column 2; if any items in column 2 are equal, then those particular rows are ordered based on the items in column 1. In this case, we say that the rows are primarily sorted on column 2, and secondarily on column 1. If the user then clicks the header for column 3, then the items are primarily sorted on column 3 and secondarily sorted on column 2. Because the maximum number of sort keys has been set to 2 with setMaxSortKeys, column 1 no longer has an effect on the order.

The maximum number of sort keys is enforced by toggleSortOrder. You can specify more sort keys by invoking setSortKeys directly and they will all be honored. However if toggleSortOrder is subsequently invoked the maximum number of sort keys will be enforced. The default value is 3.
Parameters:
- max - the maximum number of sort keys
Throws:
- IllegalArgumentException - if max < 1

protectedfinal void setModelWrapper (ModelWrapper< M, I> modelWrapper)

Sets the model wrapper providing the data that is being sorted and filtered.

public void setRowFilter (RowFilter<Object, Object> filter)

Sets the filter that determines which rows, if any, should be hidden from the view.

Sets the filter that determines which rows, if any, should be hidden from the view. The filter is applied before sorting. A value of null indicates all values from the model should be included.

RowFilter's include method is passed an Entry that wraps the underlying model. The number of columns in the Entry corresponds to the number of columns in the ModelWrapper. The identifier comes from the ModelWrapper as well.

This method triggers a sort.
Parameters:
- filter - the filter used to determine what entries should be included

public void setSortable (int column, boolean sortable)

Sets whether or not the specified column is sortable.

Sets whether or not the specified column is sortable. The specified
value is only checked when toggleSortOrder is invoked.
It is still possible to sort on a column that has been marked as
unsortable by directly setting the sort keys. The default is
true.
Parameters:
- column - the column to enable or disable sorting on, in terms of the underlying model
- sortable - whether or not the specified column is sortable
Throws:
- IndexOutOfBoundsException - if column is outside the range of the model
See Also: DefaultRowSorter.toggleSortOrder(int), DefaultRowSorter.setSortKeys(java.util.List),

public void setSortKeys (List<SortKey> sortKeys) [Specified in RowSorter]

Sets the sort keys.

Sets the sort keys. This creates a copy of the supplied
List; subsequent changes to the supplied
List do not effect this DefaultRowSorter.
If the sort keys have changed this triggers a sort.
Parameters:
- sortKeys - the new SortKeys; null is a shorthand for specifying an empty list, indicating that the view should be unsorted
Throws:
- IllegalArgumentException - if any of the values in sortKeys are null or have a column index outside the range of the model

public void setSortsOnUpdates (boolean sortsOnUpdates)

If true, specifies that a sort should happen when the underlying model is updated (rowsUpdated is invoked).

If true, specifies that a sort should happen when the underlying
model is updated (rowsUpdated is invoked). For
example, if this is true and the user edits an entry the
location of that item in the view may change. The default is
false.
Parameters:
- sortsOnUpdates - whether or not to sort on update events

public void sort ()

Sorts and filters the rows in the view based on the sort keys of the columns currently being sorted and the filter, if any, associated with this sorter.

Sorts and filters the rows in the view based on the sort keys
of the columns currently being sorted and the filter, if any,
associated with this sorter. An empty sortKeys list
indicates that the view should unsorted, the same as the model.
See Also: DefaultRowSorter.setRowFilter(javax.swing.RowFilter), DefaultRowSorter.setSortKeys(java.util.List),

public void toggleSortOrder (int column) [Specified in RowSorter]

Reverses the sort order from ascending to descending (or descending to ascending) if the specified column is already the primary sorted column; otherwise, makes the specified column the primary sorted column, with an ascending sort order.

protected boolean useToString (int column)

Returns whether or not to convert the value to a string before doing comparisons when sorting.

Returns whether or not to convert the value to a string before
doing comparisons when sorting. If true
ModelWrapper.getStringValueAt will be used, otherwise
ModelWrapper.getValueAt will be used. It is up to
subclasses, such as TableRowSorter, to honor this value
in their ModelWrapper implementation.
Parameters:
- column - the index of the column to test, in terms of the underlying model
Throws:
- IndexOutOfBoundsException - if column is not valid