Сортировка и фильтрация таблиц

В версии Java SE 6.0 (кодовое название Mustang) добавлены функции упрощающие сортировку и фильтрацию содержания в компонентах Swing JTable. (Окончательное включение данных функций находится на рассмотрении в JCP). В современных приложениях, использующих таблицы, имеется возможность сортировки колонок при нажатии кнопкой мышки на заголовок колонки. Данная возможность поддерживалась в компоненте Swing JTable и до версии Mustang. Однако данную функциональность необходимо было добавлять вручную для каждой таблицы. В Mustang, применение данных функций требует небольших усилий. Фильтрация является другой широко применяемой функциональностью пользовательских интерфейсов. Фильтрация позволяет отображать только те строки таблицы, которые соответствуют критериям, заданным пользователем. В Mustang, применение фильтрации реализуется также легко.

Сортировка строк

В основе реализации сортировки и фильтрации строк в Mustang лежит абстрактный класс RowSorter. Класс RowSorter поддерживает два вида преобразований, в первом случае строки компонента JTable преобразуются в элементы базовой модели, во втором случае выполняется обратное преобразование. Данные преобразования позволяют производить фильтрацию и сортировку. Класс является достаточно обобщенным, чтобы работать как с объектами TableModel, так и с ListModel. Однако только класс TableRowSorter, предоставляемый Mustang может работать с компонентами JTable.

В простом случае вы передаете объект TableModel конструктору класса TableRowSorter и, затем, передаете, полученный объект RowSorter, методу setRowSorter() компонента JTable. Ниже приведен пример программы SortTable, демонстрирующий данный подход:

import javax.swing.*;
import javax.swing.table.*;
import java.awt.*;

public class SortTable {
 
public static void main(String args[]) {
   
Runnable runner = new Runnable() {
     
public void run() {
       
JFrame frame = new JFrame("Sorting JTable");
        frame.setDefaultCloseOperation
(JFrame.EXIT_ON_CLOSE);
        Object rows
[][] = { { "AMZN", "Amazon", 41.28 },
           
{ "EBAY", "eBay", 41.57 },
           
{ "GOOG", "Google", 388.33 },
           
{ "MSFT", "Microsoft", 26.56 },
           
{ "NOK", "Nokia Corp", 17.13 },
           
{ "ORCL", "Oracle Corp.", 12.52 },
           
{ "SUNW", "Sun Microsystems", 3.86 },
           
{ "TWX", "Time Warner", 17.66 },
           
{ "VOD", "Vodafone Group", 26.02 },
           
{ "YHOO", "Yahoo!", 37.69 } };
        String columns
[] = { "Symbol", "Name", "Price" };
        TableModel model =
new DefaultTableModel(rows, columns) {
         
public Class getColumnClass(int column) {
           
Class returnValue;
           
if ((column >= 0) && (column < getColumnCount())) {
             
returnValue = getValueAt(0, column).getClass();
           
} else {
             
returnValue = Object.class;
           
}
           
return returnValue;
         
}
        }
;

        JTable table =
new JTable(model);
        RowSorter<TableModel> sorter =
new TableRowSorter<TableModel>(
           
model);
        table.setRowSorter
(sorter);
        JScrollPane pane =
new JScrollPane(table);
        frame.add
(pane, BorderLayout.CENTER);
        frame.setSize
(300, 150);
        frame.setVisible
(true);
     
}
    }
;
    EventQueue.invokeLater
(runner);
 
}
}
Sort Table 1

Нажмите на один из столбцов в данной таблице и заметьте, что его содержимое упорядочивается.

Sort Table 2

Вы можете спросить почему нельзя просто использовать класс DefaultTableModel, а необходимо создавать его подкласс. Ответ кроется в том, что класс TableRowSorter содержит набор правил для сортировки столбцов. По умолчанию все столбцы в таблице имеют тип Object. Таким образом, сортировка производится вызовом метода toString(). Переопределяя поведение по умолчанию для метода getColumnClass(), класса DefaultTableModel, класс RowSorter проводит сортировку в соответствии с правилами данного класса, если в нем реализовывается интерфейс Comparable. Вы также можете назначить произвольный объект Comparator для столбца вызвав метод setComparator(int column, Comparator comparator).

Ключевые три строки программы SortTable, ответственный за сортировку, представлены ниже:

JTable table = new JTable(model);
RowSorter<TableModel> sorter =
new TableRowSorter<TableModel>(model);
table.setRowSorter
(sorter);

В первой строке модель ставится в соответствие таблице. Вторая строка создает объект RowSorter для данной модели. В третьей строке устанавливается соответствие объектов RowSorter и JTable. Данные действия позволяют производить сортировку столбца при нажатии на его заголовок. Повторное нажатие на тот же столбец инвертирует сортировку.

В случае если вы хотите добавить свои действия при изменении порядка сортировки, вы можете реализовать интерфейс RowSorterListener в классе RowSorter. В данном интерфейсе определен только один метод:

void sorterChanged(RowSorterEvent e)

Данный метод позволяет вам обновить текст в строке состояния или произвести другие дополнительные действия. Объект RowSorterEvent позволяет вам узнать количество строк появившихся или исчезнувших с экрана после сортировки объекта RowSorter.

Фильтрация строк таблицы

Вы можете связать объект RowFilter с классом TableRowSorter и использовать его для фильтрации содержимого таблицы. Например, вы можете использовать объект RowFilter для отображения строк, начинающихся с буквы А или таких строк в которых цена акции превышает 50$. В абстрактном классе RowFilter определен один метод, применяемый для фильтрации:

boolean include(RowFilter.Entry entry)

Для каждого элемента модели, связанной с объектом RowSorter, данный метод определяет должен ли он отображаться для текущего представления модели. В большинстве случаев вам не нужно создавать свою реализацию класса RowFilter. Для создания фильтров в классе RowFilter определены шесть статических методов:

  • andFilter(Iterable<? extends RowFilter<? super M,? super I>> filters)
  • dateFilter(RowFilter.ComparisonType type, Date date, int... indices)
  • notFilter(RowFilter<M,I> filter)
  • numberFilter(RowFilter.ComparisonType type, Number number, int... indices)
  • orFilter(Iterable<:? extends RowFilter<? super M,? super I>> filters)
  • regexFilter(String regex, int... indices)

Для методов класса RowFilter принимающих в качестве аргумента индексы (indices) (dateFilter, numberFilter, regexFilter) данной модели проверяется только набор столбцов, для которых переданы индексы. Если в качестве аргумента не передано ни одного индекса, то на совпадение проверяются все столбцы.

Метод dateFilter позволяет вам находить совпадения по дате. Метод numberFilter находит совпадения по числу. Метод notFilter используется для инвертирования результатов, полученных другим фильтром, другими словами он возвращает результаты, отброшенные другим фильтром. Он может быть использован в ситуации, когда, например, необходимо найти значения соответствующие не выполненным заданиям от 12/25/2005. Методы andFilter и orFilter используются для логических операций с фильтрами. В методе regexFilter для фильтрации применяются регулярные выражения. Ниже приведена программа FilterTable, использующая метод regexFilter для фильтрации содержимого таблицы:

import javax.swing.*;
import javax.swing.table.*;
import java.awt.*;
import java.awt.event.*;
import java.util.regex.*;

public class FilterTable {
 
public static void main(String args[]) {
   
Runnable runner = new Runnable() {
     
public void run() {
       
JFrame frame = new JFrame("Sorting JTable");
        frame.setDefaultCloseOperation
(JFrame.EXIT_ON_CLOSE);
        Object rows
[][] = { { "AMZN", "Amazon", 41.28 },
           
{ "EBAY", "eBay", 41.57 },
           
{ "GOOG", "Google", 388.33 },
           
{ "MSFT", "Microsoft", 26.56 },
           
{ "NOK", "Nokia Corp", 17.13 },
           
{ "ORCL", "Oracle Corp.", 12.52 },
           
{ "SUNW", "Sun Microsystems", 3.86 },
           
{ "TWX", "Time Warner", 17.66 },
           
{ "VOD", "Vodafone Group", 26.02 },
           
{ "YHOO", "Yahoo!", 37.69 } };
        Object columns
[] = { "Symbol", "Name", "Price" };
        TableModel model =
new DefaultTableModel(rows, columns) {
         
public Class getColumnClass(int column) {
           
Class returnValue;
           
if ((column >= 0) && (column < getColumnCount())) {
             
returnValue = getValueAt(0, column).getClass();
           
} else {
             
returnValue = Object.class;
           
}
           
return returnValue;
         
}
        }
;
        JTable table =
new JTable(model);
       
final TableRowSorter<TableModel> sorter = new TableRowSorter<TableModel>(
           
model);
        table.setRowSorter
(sorter);
        JScrollPane pane =
new JScrollPane(table);
        frame.add
(pane, BorderLayout.CENTER);
        JPanel panel =
new JPanel(new BorderLayout());
        JLabel label =
new JLabel("Filter");
        panel.add
(label, BorderLayout.WEST);
       
final JTextField filterText = new JTextField("SUN");
        panel.add
(filterText, BorderLayout.CENTER);
        frame.add
(panel, BorderLayout.NORTH);
        JButton button =
new JButton("Filter");
        button.addActionListener
(new ActionListener() {
         
public void actionPerformed(ActionEvent e) {
           
String text = filterText.getText();
           
if (text.length() == 0) {
             
sorter.setRowFilter(null);
           
} else {
             
try {
               
sorter
                    .setRowFilter
(RowFilter
                        .regexFilter
(text));
             
} catch (PatternSyntaxException pse) {
               
System.err.println("Bad regex pattern");
             
}
            }
          }
        })
;
        frame.add
(button, BorderLayout.SOUTH);
        frame.setSize
(300, 250);
        frame.setVisible
(true);
     
}
    }
;
    EventQueue.invokeLater
(runner);
 
}
}

На экране показан фильтр, который выбирает все строки, в которых присутствуют символы SUN. Данное условие задается строкой вида "SUN". Используйте соответсвующие символы '^' и '$' для нахождения точных соответствий, в начале и в конце строки.

Filter Table 1

В своей реализации фильтр использует метод Matcher.find() для отображения результатов фильтрации после нажатия кнопки "Filter".

Filter Table 2

Измените текст фильтра для получения другого набора строк. Если вы хотите увидеть все строки таблицы, удалите текст фильтрации.

Последней вещь, которую необходимо упомянуть о сортировке и фильтрации, является выбор в представлении просмотра. Таким образом, если вам необходимо обратиться к модели, вы должны вызвать метод convertRowIndexToModel(). Также, если вы хотите преобразовать модель в отображение, вызовите метод convertRowIndexToView().

Теги: java JFrame swing