Home > Articles > Programming > Java

  • Print
  • + Share This
Like this article? We recommend

Table Sorting and Filtering

Swing’s table component has been enhanced in several new ways. One enhancement enables you to sort a table’s rows into ascending/descending order and filter out those rows (from the table model) to appear in the component’s view. To prevent confusion, remember that sorting and filtering affect the view, not the model.

Sorting and filtering are based on the concept of a row sorter object that sorts (and filters) rows. The simplest way to introduce a row sorter to a table component is to invoke javax.swing.JTable’s new public void setAutoCreateRowSorter(boolean autoCreateRowSorter) method, which I demonstrate below:

TableModel model = createTableModel ();
JTable table = new JTable (model);
table.setAutoCreateRowSorter (true);

Passing true to setAutoCreateRowSorter() causes JTable to install a new javax.swing.table.TableRowSorter<M> instance as the row sorter every time the model changes. To prevent new row sorters from being created during future model changes, pass false in a subsequent method call.

You’ll probably call setAutoCreateRowSorter() when you don’t plan to customize the row sorter. But you can still customize the row sorter after calling this method, by first calling JTable’s new public RowSorter<? extends TableModel> getRowSorter() method to return the current row sorter.

Because the compiler spits out an unchecked warning message when you attempt to store the returned row sorter’s reference in a TableRowSorter, you might prefer to create the table row sorter yourself and use JTable’s new public void setRowSorter(RowSorter<? extends TableModel> sorter) method to install it:

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

The TableRowSorter customizations include the capability to install a row filter object (that accepts rows based on certain criteria) via its public void setRowFilter(RowFilter<? super M,? super I> filter) method. This method takes a javax.swing.RowFilter<M,I> argument, whose methods return different kinds of row filters.

One kind of row filter uses regular expressions. To obtain this row filter, invoke the RowFilter public static <M,I> RowFilter<M,I> regexFilter(String regex, int... indices) method. For example, sorter.setRowFilter (RowFilter.regexFilter ("^A")); establishes a row filter whose ^A regular expression accepts only rows beginning with A.

JTable provides additional new methods related to row sorting and row filtering. Two of these methods are public int convertRowIndexToModel(int viewRowIndex) and public int convertRowIndexToView(int modelRowIndex), which map a row's index (in terms of the view) to the underlying model and map a row's index (in terms of the underlying model) to the view, respectively.

To prove to you that only the view is affected by sorting and filtering, I employ the former "convert" method in a TableSortFilterDemo demonstration application. Apart from passing null to the TableRowSorter’s public void setSortKeys(List<? extends RowSorter.SortKey> sortKeys) method to unsort the view after changing the row filter, there’s nothing in Listing 4 not already discussed.

Listing 4 TableSortFilterDemo.java

// TableSortFilterDemo.java

import java.awt.*;
import java.awt.event.*;

import javax.swing.*;
import javax.swing.border.*;
import javax.swing.event.*;
import javax.swing.table.*;

class TableSortFilterDemo extends JFrame
{
   JLabel lblStatus;

   TableSortFilterDemo (String title)
   {
      // Assign title to the frame window's title bar.

      super (title);

      // Tell application to automatically exit when the user selects the Close
      // menu item from the frame window's system menu.

      setDefaultCloseOperation (EXIT_ON_CLOSE);

      // Create the table's model and a table based on this model. Also set
      // the selection mode to allow only a single row to be selected.

      TableModel model = createTableModel ();
      final JTable table = new JTable (model);
      table.setSelectionMode (ListSelectionModel.SINGLE_SELECTION);

      // Attach a list selection listener to the table's selection model, to
      // be notified whenever the user selects a row. Use this opportunity to
      // output the view and model indices on the status label.

      ListSelectionListener lsl;
      lsl = new ListSelectionListener ()
            {
                public void valueChanged (ListSelectionEvent lse)
                {
                   int index = table.getSelectedRow ();
                   if (index != -1)
                   {
                       String status;
                       status = "View index = " + index + ", Model index = ";
                       status += table.convertRowIndexToModel (index);
                       lblStatus.setText (status);
                   }
                }
            };
      table.getSelectionModel ().addListSelectionListener (lsl);

      // Create and install the table's row sorter.

      final TableRowSorter sorter;
      sorter = new TableRowSorter (model);
      table.setRowSorter (sorter);

      // Place the table in a JScrollPane object to allow the table to be
      // vertically scrolled and display scrollbars, as necessary.

      JScrollPane jsp = new JScrollPane (table);
      jsp.setPreferredSize (new Dimension (300, 100));

      // Fill northern region of GUI with scrollpane.

      getContentPane ().add (jsp, BorderLayout.NORTH);

      // Create and populate a panel for establishing row filter components.

      JPanel pnlFilter = new JPanel ();

      pnlFilter.add (new JLabel ("Filter expression:"));

      final JTextField txtFilter = new JTextField (20);
      pnlFilter.add (txtFilter);

      JButton btnSetFilter = new JButton ("Set Filter");
      ActionListener al;
      al = new ActionListener ()
           {
               public void actionPerformed (ActionEvent e)
               {
                  // Install a new row filter.

                  String expr = txtFilter.getText ();
                  sorter.setRowFilter (RowFilter.regexFilter (expr));

                  // Unsort the view.

                  sorter.setSortKeys (null);
               }
           };
      btnSetFilter.addActionListener (al);
      pnlFilter.add (btnSetFilter);

      // Fill center region of GUI with filter panel.

      getContentPane ().add (pnlFilter, BorderLayout.CENTER);

      // Create a status label for presenting the view and model indices for
      // the selected row.

      lblStatus = new JLabel (" ", JLabel.CENTER);

      // Fill southern region of GUI with status label.

      getContentPane ().add (lblStatus, BorderLayout.SOUTH);

      // Wrap an empty border around the GUI for aesthetic purposes.

      Border border = BorderFactory.createEmptyBorder (10, 10, 10, 10);
      getRootPane ().setBorder (border);

      // Resize the GUI to its preferred size.

      pack ();

      // Display GUI and start the AWT's event-dispatching thread.

      setVisible (true);
   }

   TableModel createTableModel ()
   {
      // Create a model consisting of 12 rows by 2 columns.

      DefaultTableModel model = new DefaultTableModel (12, 2);

      // Assign column identifiers (headers) to the columns.

      String [] columnTitles =
      {
         "Month",
         "Days",
      };

      model.setColumnIdentifiers (columnTitles);

      // Populate all cells in the model.

      String [] months =
      {
         "January",
         "February",
         "March",
         "April",
         "May",
         "June",
         "July",
         "August",
         "September",
         "October",
         "November",
         "December"
      };

      String [] days =
      {
         "31",
         "28 (29 on leap year)",
         "31",
         "30",
         "31",
         "30",
         "31",
         "31",
         "30",
         "31",
         "30",
         "31"
      };

      int nrows = model.getRowCount ();
      int ncols = model.getColumnCount ();

      for (int i = 0; i < nrows; i++)
      {
           model.setValueAt (months [i], i, 0);
           model.setValueAt (days [i], i, 1);
      }

      return model;
   }

   public static void main (String [] args)
   {
      Runnable r = new Runnable ()
                   {
                       public void run ()
                       {
                          new TableSortFilterDemo ("Table Sorting and "+
                                                   "Filtering Demo");
                       }
                   };
      EventQueue.invokeLater (r);
   }
}

After compiling and running this application, initiate a sort by clicking a column’s header. In response, all rows are rearranged into the ascending or descending order of the clicked column’s values (each click toggles between ascending/descending). The selected column and the sort order are indicated by an up/down arrow on the column’s header, as Figure 3 reveals.

Figure 3

Figure 3 An up arrow reflects an ascending order sort.

In addition to sorting, you can install a filter to determine which rows are shown in the view. Accomplish this task by typing a regular expression (such as ^J or J) into the text field and clicking the Set Filter button. In response, all rows matching the regexp will be displayed in unsorted order, which is shown in Figure 4. You can then sort these rows.

Figure 4

Figure 4 Clicking Set Filter establishes an unsorted view of filtered rows.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020