RowFilter JDK 1.6)

Description

publicabstract abstract class RowFilter

RowFilter is used to filter out entries from the model so that they are not shown in the view.

RowFilter is used to filter out entries from the model so that they are not shown in the view. For example, a RowFilter associated with a JTable might only allow rows that contain a column with a specific string. The meaning of entry depends on the component type. For example, when a filter is associated with a JTable, an entry corresponds to a row; when associated with a JTree, an entry corresponds to a node.

Subclasses must override the include method to indicate whether the entry should be shown in the view. The Entry argument can be used to obtain the values in each of the columns in that entry. The following example shows an include method that allows only entries containing one or more values starting with the string "a":

 RowFilter<Object,Object> startsWithAFilter = new RowFilter<Object,Object>() {
   public boolean include(Entry<? extends Object, ? extends Object> entry) {
     for (int i = entry.getValueCount() - 1; i >= 0; i--) {
       if (entry.getStringValue(i).startsWith("a")) {
         // The value starts with "a", include it
         return true;
       }
     }
     // None of the columns start with "a"; return false so that this
     // entry is not shown
     return false;
   }
 };

RowFilter has two formal type parameters that allow you to create a RowFilter for a specific model. For example, the following assumes a specific model that is wrapping objects of type Person. Only Persons with an age over 20 will be shown:

 RowFilter<PersonModel,Integer> ageFilter = new RowFilter<PersonModel,Integer>() {
   public boolean include(Entry<? extends PersonModel, ? extends Integer> entry) {
     PersonModel personModel = entry.getModel();
     Person person = personModel.getPerson(entry.getIdentifier());
     if (person.getAge() > 20) {
       // Returning true indicates this row should be shown.
       return true;
     }
     // Age is <= 20, don't show it.
     return false;
   }
 };
 PersonModel model = createPersonModel();
 TableRowSorter<PersonModel> sorter = new TableRowSorter<PersonModel>(model);
 sorter.setRowFilter(ageFilter);

See also: TableRowSorter

Methods

Hide/Show inherited methods

publicstatic RowFilter< M, I> andFilter (Iterable<RowFilter> filters)

Returns a RowFilter that includes entries if all of the supplied filters include the entry.

The following example creates a RowFilter that will include any entries containing the string "foo" and the string "bar":

   List<RowFilter<Object,Object>> filters = new ArrayList<RowFilter<Object,Object>>(2);
   filters.add(RowFilter.regexFilter("foo"));
   filters.add(RowFilter.regexFilter("bar"));
   RowFilter<Object,Object> fooBarFilter = RowFilter.andFilter(filters);

Returns: a RowFilter implementing the specified criteria
Parameters:
- filters - the RowFilters to test
Throws:
- IllegalArgumentException - if any of the filters are null
- NullPointerException - if filters is null
See Also: Arrays.asList(T...),

publicstatic RowFilter< M, I> dateFilter (ComparisonType type, Date date, int[] indices)

Returns a RowFilter that includes entries that have at least one Date value meeting the specified criteria.

Returns a RowFilter that includes entries that
have at least one Date value meeting the specified
criteria. For example, the following RowFilter includes
only entries with at least one date value after the current date:


   RowFilter.dateFilter(ComparisonType.AFTER, new Date());

Returns: a RowFilter implementing the specified criteria
Parameters:
- type - the type of comparison to perform
- date - the date to compare against
- indices - the indices of the values to check. If not supplied all values are evaluated
Throws:
- NullPointerException - if date is null
- IllegalArgumentException - if any of the indices are < 0 or type is null
See Also: Calendar, Date,

publicabstract boolean include (Entry<Object, Object> entry)

Returns true if the specified entry should be shown; returns false if the entry should be hidden.

publicstatic RowFilter< M, I> notFilter (RowFilter< M, I> filter)

Returns a RowFilter that includes entries if the supplied filter does not include the entry.

Returns a RowFilter that includes entries if the
supplied filter does not include the entry.
Returns: a RowFilter implementing the specified criteria
Parameters:
- filter - the RowFilter to negate
Throws:
- IllegalArgumentException - if filter is null

publicstatic RowFilter< M, I> numberFilter (ComparisonType type, Number number, int[] indices)

Returns a RowFilter that includes entries that have at least one Number value meeting the specified criteria.

Returns a RowFilter that includes entries that
have at least one Number value meeting the
specified criteria. For example, the following
filter will only include entries with at
least one number value equal to 10:


   RowFilter.numberFilter(ComparisonType.EQUAL, 10);

Returns: a RowFilter implementing the specified criteria
Parameters:
- type - the type of comparison to perform
- indices - the indices of the values to check. If not supplied all values are evaluated
Throws:
- IllegalArgumentException - if any of the indices are < 0, type is null or number is null

publicstatic RowFilter< M, I> orFilter (Iterable<RowFilter> filters)

Returns a RowFilter that includes entries if any of the supplied filters includes the entry.

The following example creates a RowFilter that will include any entries containing the string "foo" or the string "bar":

   List<RowFilter<Object,Object>> filters = new ArrayList<RowFilter<Object,Object>>(2);
   filters.add(RowFilter.regexFilter("foo"));
   filters.add(RowFilter.regexFilter("bar"));
   RowFilter<Object,Object> fooBarFilter = RowFilter.orFilter(filters);

publicstatic RowFilter< M, I> regexFilter (String regex, int[] indices)

Returns a RowFilter that uses a regular expression to determine which entries to include.

Returns a RowFilter that uses a regular expression to determine which entries to include. Only entries with at least one matching value are included. For example, the following creates a RowFilter that includes entries with at least one value starting with "a":

   RowFilter.regexFilter("^a");

The returned filter uses Matcher.find() to test for inclusion. To test for exact matches use the characters '^' and '$' to match the beginning and end of the string respectively. For example, "^foo$" includes only rows whose string is exactly "foo" and not, for example, "food". See Pattern for a complete description of the supported regular-expression constructs.
Returns: a RowFilter implementing the specified criteria
Parameters:
- regex - the regular expression to filter on
- indices - the indices of the values to check. If not supplied all values are evaluated
Throws:
- NullPointerException - if regex is null
- IllegalArgumentException - if any of the indices are < 0
- PatternSyntaxException - if regex is not a valid regular expression.
See Also: Pattern,