Класс DefaultRowSorter<M,I>

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 по столбцам, текущий порядок сортировки и возможность сортировки каждого столбца. Чтобы найти значения Comparator по умолчанию, см. конкретную реализацию (например, TableRowSorter). Порядок сортировки по умолчанию — неупорядоченный (такой же, как в модели), и столбцы по умолчанию сортируются.

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

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

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

Конструкторы

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 находится за пределами диапазона модели

См. также:

toggleSortOrder(int), setSortKeys(java.util.List<? extends javax.swing.RowSorter.SortKey>)

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)

Параметры:

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)

Параметры:

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

getRowFilter

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

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

Возвращает:

фильтр

toggleSortOrder

public void toggleSortOrder(int column)

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

Задано в:

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

Параметры:

column - индекс колонки, которую нужно сделать основной колонкой сортировки, в терминах базовой модели

Исключения:

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

См. также:

setSortable(int,boolean), setMaxSortKeys(int)

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 список указывает, что представление должно быть несортированным, так же как и модель.

См. также:

setRowFilter(javax.swing.RowFilter<? super M, ? super I>), setSortKeys(java.util.List<? extends javax.swing.RowSorter.SortKey>)

useToString

protected boolean useToString(int column)

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

Параметры:

column - индекс колонки для проверки, в терминах базовой модели

Исключения:

IndexOutOfBoundsException - если column недействителен

setComparator

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

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

Параметры:

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

comparator - Comparator для использования

Исключения:

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

getComparator

public Comparator<?> getComparator(int column)

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

Параметры:

column — столбец для извлечения Comparator, в терминах базовой модели

Возвращает:

значение Comparator для указанного столбца

Выбрасывает:

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

getViewRowCount

public int getViewRowCount()

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

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

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

Возвращает:

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

См. также:

RowSorter.getModelRowCount()

getModelRowCount

public int getModelRowCount()

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

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

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

Возвращает:

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

См. также:

RowSorter.getViewRowCount()

modelStructureChanged

public void modelStructureChanged()

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

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

allRowsChanged

public void allRowsChanged()

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

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

rowsInserted

public void rowsInserted(int firstRow,
                         int endRow)

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

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

Параметры:

firstRow — первая строка

endRow — последняя строка

Выбрасывает:

IndexOutOfBoundsException — если любой из аргументов недействителен, или firstRow > endRow

rowsDeleted

public void rowsDeleted(int firstRow,
                        int endRow)

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

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

Параметры:

firstRow — первая строка

endRow — последняя строка

Выбрасывает:

IndexOutOfBoundsException — если любой из аргументов выходит за пределы диапазона модели до изменения, или firstRow > endRow

rowsUpdated

public void rowsUpdated(int firstRow,
                        int endRow)

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

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

Параметры:

firstRow — первая строка, в терминах базовой модели

endRow — последняя строка, в терминах базовой модели

Выбрасывает:

IndexOutOfBoundsException — если любой из аргументов выходит за пределы диапазона базовой модели, или firstRow > endRow

rowsUpdated

public void rowsUpdated(int firstRow,
                        int endRow,
                        int column)

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

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

Параметры:

firstRow — первая строка, в терминах базовой модели

endRow — последняя строка, в терминах базовой модели

column — столбец, который изменился, в терминах базовой модели

Выбрасывает:

IndexOutOfBoundsException — если любой из аргументов выходит за пределы диапазона базовой модели после изменения, firstRow > endRow, или column выходит за пределы диапазона базовой модели