Класс DefaultRowSorter<M,I>

java.lang.Object

javax.swing.RowSorter<M>

javax.swing.DefaultRowSorter<M,I>

Type Parameters:: M - тип модели; I - тип идентификатора, передаваемого в RowFilter

Direct Known Subclasses:: TableRowSorter

public abstract class DefaultRowSorter<M,I> extends RowSorter<M>

Реализация RowSorter, обеспечивающая сортировку и фильтрацию данных вокруг модели данных, основанной на сетке. Помимо создания и установки RowSorter, вам крайне редко потребуется взаимодействовать с ней напрямую. Обратитесь к TableRowSorter для конкретной реализации RowSorter для JTable.

Сортировка выполняется на основе текущих SortKey в порядке следования. Если два объекта равны (метод Comparator для столбца возвращает 0), используется следующий SortKey. Если SortKey больше не остаётся или порядок UNSORTED, используется порядок строк в модели.

Сортировка каждого столбца выполняется с помощью Comparator, который вы можете указать с помощью метода setComparator. Если Comparator не указан, используется метод Comparator, возвращаемый Collator.getInstance(), по результатам вызова toString для базовых объектов. Comparator никогда не передаётся null. Значение null считается предшествующим значению, не являющемуся null, а два значения null считаются равными.

Если вы укажете Comparator , который преобразует свой аргумент в тип, отличный от предоставленного моделью, при сортировке данных будет выброшено исключение ClassCastException.

Помимо сортировки, DefaultRowSorter предоставляет возможность фильтрации строк. Фильтрация выполняется с помощью RowFilter, который указывается методом setRowFilter. Если фильтр не указан, все строки включаются.

По умолчанию строки упорядочены без сортировки (так же, как в модели), и каждый столбец сортируется. Значения по умолчанию Comparator описаны в подклассах (например, TableRowSorter).

Если структура базовой модели изменяется (вызывается метод modelStructureChanged), следующие значения сбрасываются до значений по умолчанию: сортировка по столбцам, текущий порядок сортировки и возможность сортировки каждого столбца. Чтобы найти значения по умолчанию Comparator, см. конкретную реализацию (например, TableRowSorter). Порядок сортировки по умолчанию — без сортировки (так же, как в модели), и столбцы по умолчанию сортируются.

DefaultRowSorter — это абстрактный класс. Конкретные подклассы должны предоставить доступ к базовым данным, вызвав setModelWrapper. Метод setModelWrapper обязательно должен быть вызван сразу после вызова конструктора, в идеале из конструктора подкласса. Неопределённое поведение возникнет, если вы используете DefaultRowSorter без указания ModelWrapper.

DefaultRowSorter имеет два формальных параметра типа. Первый параметр типа соответствует классу модели, например, DefaultTableModel. Второй параметр типа соответствует классу идентификатора, передаваемого RowFilter. Дополнительные сведения о параметрах типа см. в TableRowSorter и RowFilter.

Since:

1.6

See Also:

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`protected static class`	`DefaultRowSorter.ModelWrapper<M,I>`	`DefaultRowSorter.ModelWrapper` отвечает за предоставление данных, которые сортируются по `DefaultRowSorter`.

Вложенные классы/интерфейсы, объявленные в классе javax.swing.RowSorter

RowSorter.SortKey

Краткое описание конструкторов

Конструктор	Описание
`DefaultRowSorter()`	Создаёт пустой `DefaultRowSorter`.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`allRowsChanged()`	Вызывается, когда содержимое базовой модели полностью изменилось.
`int`	`convertRowIndexToModel(int index)`	Возвращает расположение `index` в терминах базовой модели.
`int`	`convertRowIndexToView(int index)`	Возвращает расположение `index` в терминах представления.
`Comparator<?>`	`getComparator(int column)`	Возвращает `Comparator` для указанного столбца.
`int`	`getMaxSortKeys()`	Возвращает максимальное количество ключей сортировки.
`final M`	`getModel()`	Возвращает базовая модель.
`int`	`getModelRowCount()`	Возвращает количество строк в базовой модели.
`protected final DefaultRowSorter.ModelWrapper<M,I>`	`getModelWrapper()`	Возвращает оболочку модели, предоставляющую данные, которые сортируются и фильтруются.
`RowFilter<? super M,? super I>`	`getRowFilter()`	Возвращает фильтр, определяющий, какие строки, если таковые имеются, должны быть скрыты от просмотра.
`List<? extends RowSorter.SortKey>`	`getSortKeys()`	Возвращает текущие ключи сортировки.
`boolean`	`getSortsOnUpdates()`	Возвращает true, если сортировка должна происходить при обновлении базовой модели; в противном случае возвращает false.
`int`	`getViewRowCount()`	Возвращает количество строк в представлении.
`boolean`	`isSortable(int column)`	Возвращает true, если указанный столбец сортируемый; в противном случае false.
`void`	`modelStructureChanged()`	Вызывается, когда структура базовой модели полностью изменилась.
`void`	`rowsDeleted(int firstRow, int endRow)`	Вызывается, когда строки были удалены из базовой модели в указанном диапазоне (включительно).
`void`	`rowsInserted(int firstRow, int endRow)`	Вызывается, когда строки были вставлены в базовая модель в указанном диапазоне (включительно).
`void`	`rowsUpdated(int firstRow, int endRow)`	Вызывается, когда строки были изменены в базовой модели в указанном диапазоне (включительно).
`void`	`rowsUpdated(int firstRow, int endRow, int column)`	Вызывается, когда столбцы строк были обновлены в базовой модели в указанном диапазоне.
`void`	`setComparator(int column, Comparator<?> comparator)`	Устанавливает `Comparator` для использования при сортировке указанного столбца.
`void`	`setMaxSortKeys(int max)`	Устанавливает максимальное количество ключей сортировки.
`protected final void`	`setModelWrapper(DefaultRowSorter.ModelWrapper<M,I> modelWrapper)`	Устанавливает оболочку модели, предоставляющую данные, которые сортируются и фильтруются.
`void`	`setRowFilter(RowFilter<? super M,? super I> filter)`	Устанавливает фильтр, определяющий, какие строки, если таковые имеются, должны быть скрыты от представления.
`void`	`setSortable(int column, boolean sortable)`	Устанавливает, является ли указанный столбец сортируемым.
`void`	`setSortKeys(List<? extends RowSorter.SortKey> sortKeys)`	Устанавливает ключи сортировки.
`void`	`setSortsOnUpdates(boolean sortsOnUpdates)`	Если true, указывает, что сортировка должна происходить при обновлении базовой модели (вызывается `rowsUpdated`).
`void`	`sort()`	Сортирует и фильтрует строки в представлении на основе ключей сортировки столбцов, которые в данный момент сортируются, и фильтра, если таковой имеется, связанного с этим сортировщиком.
`void`	`toggleSortOrder(int column)`	Инвертирует порядок сортировки от возрастающего к убывающему (или от убывающего к возрастающему), если указанный столбец уже является основным отсортированным столбцом; в противном случае делает указанный столбец основным отсортированным столбцом с возрастающим порядком сортировки.
`protected boolean`	`useToString(int column)`	Возвращает, нужно ли преобразовывать значение в строку перед выполнением сравнений при сортировке.

Методы, объявленные в классе javax.swing.RowSorter

addRowSorterListener, fireRowSorterChanged, fireSortOrderChanged, removeRowSorterListener

Методы, объявленные в классе java.lang.Object

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

Подробное описание конструкторов

DefaultRowSorter

public DefaultRowSorter()

Создаёт пустой DefaultRowSorter.

Подробное описание методов

setModelWrapper

protected final void setModelWrapper(DefaultRowSorter.ModelWrapper<M,I> modelWrapper)

Устанавливает обёртку модели, предоставляющую данные, которые сортируются и фильтруются.

Параметры:: modelWrapper - обёртка модели, ответственная за предоставление данных, которые сортируются и фильтруются
Исключения:: IllegalArgumentException - если modelWrapper является null

getModelWrapper

protected final DefaultRowSorter.ModelWrapper<M,I> getModelWrapper()

Возвращает обёртку модели, предоставляющую данные, которые сортируются и фильтруются.

Возвращает:: обёртка модели, ответственная за предоставление данных, которые сортируются и фильтруются

getModel

public final M getModel()

Возвращает базовую модель.

Определено в:: getModel в классе RowSorter<M>
Возвращает:: базовая модель

setSortable

public void setSortable(int column, boolean sortable)

Устанавливает, сортируется ли указанный столбец. Указанное значение проверяется только при вызове toggleSortOrder. По-прежнему возможно сортировать по столбцу, помеченному как несортируемый, напрямую установив ключи сортировки. По умолчанию значение равно true.

Параметры:

column - столбец, по которому следует включить или отключить сортировку, с точки зрения базовой модели

sortable - сортируется ли указанный столбец

Исключения:

IndexOutOfBoundsException - если column выходит за пределы диапазона модели

См. также:

isSortable

public boolean isSortable(int column)

Возвращает true, если указанный столбец сортируется; в противном случае, false.

Параметры:: column - столбец, для которого проверяется сортировка, с точки зрения базовой модели
Возвращает:: true, если столбец сортируется
Исключения:: IndexOutOfBoundsException - если столбец выходит за пределы диапазона базовой модели

setSortKeys

public void setSortKeys(List<? extends RowSorter.SortKey> sortKeys)

Устанавливает ключи сортировки. Это создаёт копию предоставленного List; последующие изменения в предоставленном List не влияют на этот DefaultRowSorter. Если ключи сортировки изменились, это запускает сортировку.

Определено в:: setSortKeys в классе RowSorter<M>
Параметры:: sortKeys - новые SortKeys; null - сокращённая запись для указания пустого списка, указывающего, что представление должно быть не отсортированным
Исключения:: IllegalArgumentException - если любое из значений в sortKeys равно null или имеет индекс столбца, выходящий за пределы диапазона модели

getSortKeys

public List<? extends RowSorter.SortKey> getSortKeys()

Возвращает текущие ключи сортировки. Возвращает неизменяемый non-null List. Если вам нужно изменить ключи сортировки, сделайте копию возвращённого List, измените копию и вызовите setSortKeys со списком.

Определено в:: getSortKeys в классе RowSorter<M>
Возвращает:: текущий порядок сортировки

setMaxSortKeys

public void setMaxSortKeys(int max)

Устанавливает максимальное количество ключей сортировки. Количество ключей сортировки определяет, как разрешаются равные значения при сортировке. Например, предположим, что создан сортировщик строк таблицы и вызван setMaxSortKeys(2). Пользователь нажимает заголовок столбца 1, что приводит к сортировке строк таблицы на основе элементов в столбце 1. Затем пользователь нажимает заголовок столбца 2, что приводит к сортировке таблицы на основе элементов в столбце 2; если любые элементы в столбце 2 равны, то эти конкретные строки упорядочиваются на основе элементов в столбце 1. В этом случае мы говорим, что строки в первую очередь сортируются по столбцу 2, а во вторую очередь по столбцу 1. Если пользователь затем нажимает заголовок столбца 3, то элементы сортируются в первую очередь по столбцу 3, а во вторую очередь по столбцу 2. Поскольку максимальное количество ключей сортировки установлено в 2 с помощью setMaxSortKeys, столбец 1 больше не влияет на порядок.

Максимальное количество ключей сортировки контролируется toggleSortOrder. Вы можете указать больше ключей сортировки, вызвав setSortKeys напрямую, и они будут учтены. Однако, если впоследствии будет вызвано toggleSortOrder, максимальное количество ключей сортировки будет соблюдено. Значение по умолчанию равно 3.

Параметры:: max - максимальное количество ключей сортировки
Исключения:: IllegalArgumentException - если max < 1

getMaxSortKeys

public int getMaxSortKeys()

Возвращает максимальное количество ключей сортировки.

Возвращает:: максимальное количество ключей сортировки

setSortsOnUpdates

public void setSortsOnUpdates(boolean sortsOnUpdates)

Если true, указывает, что сортировка должна происходить при обновлении базовой модели (вызывается rowsUpdated). Например, если это true, и пользователь редактирует запись, положение этого элемента в представлении может измениться. По умолчанию значение равно false.

Параметры:: sortsOnUpdates - нужно ли сортировать при событиях обновления

getSortsOnUpdates

public boolean getSortsOnUpdates()

Возвращает true, если сортировка должна происходить при обновлении базовой модели; в противном случае возвращает false.

Возвращает:: нужно ли сортировать при обновлении модели

setRowFilter

public void setRowFilter(RowFilter<? super M,? super I> filter)

Устанавливает фильтр, определяющий, какие строки, если таковые имеются, должны быть скрыты от представления. Фильтр применяется до сортировки. Значение null указывает, что все значения из модели должны быть включены.

Метод RowFilter include получает обёртку Entry базовой модели. Количество столбцов в Entry соответствует количеству столбцов в ModelWrapper. Идентификатор также поступает из ModelWrapper.

Этот метод запускает сортировку.

Параметры:: filter - фильтр, используемый для определения того, какие записи следует включать

getRowFilter

public RowFilter<? super M,? super I> getRowFilter()

Возвращает фильтр, определяющий, какие строки, если таковые имеются, должны быть скрыты от представления.

Возвращает:: фильтр

toggleSortOrder

public void toggleSortOrder(int column)

Инвертирует порядок сортировки с возрастающего на убывающий (или убывающего на возрастающий), если указанный столбец уже является основным столбцом сортировки; в противном случае делает указанный столбец основным столбцом сортировки с возрастающим порядком сортировки. Если указанный столбец не сортируется, этот метод не оказывает никакого эффекта.

Определено в:

toggleSortOrder в классе RowSorter<M>

Параметры:

column - индекс столбца, который должен стать основным столбцом сортировки, с точки зрения базовой модели

Исключения:

IndexOutOfBoundsException - если столбец выходит за пределы диапазона базовой модели

См. также:

convertRowIndexToView

public int convertRowIndexToView(int index)

Возвращает расположение index с точки зрения представления. То есть для строки index в координатах базовой модели это возвращает индекс строки с точки зрения представления.

Определено в:: convertRowIndexToView в классе RowSorter<M>
Параметры:: index - индекс строки с точки зрения базовой модели
Возвращает:: индекс строки с точки зрения представления или -1, если строка была отфильтрована из представления
Исключения:: IndexOutOfBoundsException - если index выходит за пределы диапазона модели

convertRowIndexToModel

public int convertRowIndexToModel(int index)

Возвращает расположение index с точки зрения базовой модели. То есть для строки index в координатах представления это возвращает индекс строки с точки зрения базовой модели.

Определено в:: convertRowIndexToModel в классе RowSorter<M>
Параметры:: index - индекс строки с точки зрения представления
Возвращает:: индекс строки с точки зрения представления
Исключения:: IndexOutOfBoundsException - если index выходит за пределы диапазона представления

sort

public void sort()

Сортирует и фильтрует строки в представлении на основе ключей сортировки столбцов, которые в настоящее время сортируются, и фильтра, если таковой имеется, связанного с этим сортировщиком. Пустой список sortKeys указывает, что представление должно быть не отсортировано, так же как и модель.

См. также:

useToString

protected boolean useToString(int column)

Возвращает, нужно ли преобразовывать значение в строку перед сравнением при сортировке. Если true, ModelWrapper.getStringValueAt будет использоваться, иначе ModelWrapper.getValueAt будет использоваться. Подклассам, таким как TableRowSorter, предоставляется возможность учитывать это значение в реализации их ModelWrapper.

Parameters:: column - индекс столбца для проверки, с точки зрения базовой модели
Returns:: true, если значения должны быть преобразованы в строки перед сравнением при сортировке
Throws:: IndexOutOfBoundsException - если column недействителен

setComparator

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

Устанавливает Comparator для использования при сортировке указанного столбца. Это не вызывает сортировку. Если вы хотите отсортировать данные после установки компаратора, вам нужно явно вызвать sort.

Parameters:: column - индекс столбца, для которого будет использоваться Comparator, с точки зрения базовой модели; comparator - используемый Comparator
Throws:: IndexOutOfBoundsException - если column выходит за пределы диапазона базовой модели

getComparator

public Comparator<?> getComparator(int column)

Возвращает Comparator для указанного столбца. Возвращает null если для столбца не был задан Comparator.

Parameters:: column - столбец, для которого нужно получить Comparator, с точки зрения базовой модели
Returns:: Comparator для указанного столбца
Throws:: IndexOutOfBoundsException - если столбец выходит за пределы диапазона базовой модели

getViewRowCount

public int getViewRowCount()

Возвращает количество строк в представлении. Если содержимое было отфильтровано, это может отличаться от количества строк в базовой модели.

Specified by:

getViewRowCount в классе RowSorter<M>

Returns:

количество строк в представлении

See Also:

getModelRowCount

public int getModelRowCount()

Возвращает количество строк в базовой модели.

Specified by:

getModelRowCount в классе RowSorter<M>

Returns:

количество строк в базовой модели

See Also:

modelStructureChanged

public void modelStructureChanged()

Вызывается, когда структура базовой модели полностью изменилась. Например, если количество столбцов в TableModel изменилось, этот метод будет вызван.