- java.lang.Object
-
- javax.swing.RowFilter<M,I>
-
- Type Parameters:
M
- the type of the model; for examplePersonModel
I
- the type of the identifier; when usingTableRowSorter
this will beInteger
public abstract class RowFilter<M,I> extends Object
RowFilter
is used to filter out entries from the model so that they are not shown in the view. For example, aRowFilter
associated with aJTable
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 aJTable
, an entry corresponds to a row; when associated with aJTree
, an entry corresponds to a node.Subclasses must override the
include
method to indicate whether the entry should be shown in the view. TheEntry
argument can be used to obtain the values in each of the columns in that entry. The following example shows aninclude
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 aRowFilter
for a specific model. For example, the following assumes a specific model that is wrapping objects of typePerson
. OnlyPerson
s 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);
- Since:
- 1.6
- See Also:
TableRowSorter
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
RowFilter.ComparisonType
Enumeration of the possible comparison values supported by some of the defaultRowFilter
s.static class
RowFilter.Entry<M,I>
AnEntry
object is passed to instances ofRowFilter
, allowing the filter to get the value of the entry's data, and thus to determine whether the entry should be shown.
-
Constructor Summary
Constructors Constructor and Description RowFilter()
-
Method Summary
Methods Modifier and Type Method and Description static <M,I> RowFilter<M,I>
andFilter(Iterable<? extends RowFilter<? super M,? super I>> filters)
Returns aRowFilter
that includes entries if all of the supplied filters include the entry.static <M,I> RowFilter<M,I>
dateFilter(RowFilter.ComparisonType type, Date date, int... indices)
Returns aRowFilter
that includes entries that have at least oneDate
value meeting the specified criteria.abstract boolean
include(RowFilter.Entry<? extends M,? extends I> entry)
Returns true if the specified entry should be shown; returns false if the entry should be hidden.static <M,I> RowFilter<M,I>
notFilter(RowFilter<M,I> filter)
Returns aRowFilter
that includes entries if the supplied filter does not include the entry.static <M,I> RowFilter<M,I>
numberFilter(RowFilter.ComparisonType type, Number number, int... indices)
Returns aRowFilter
that includes entries that have at least oneNumber
value meeting the specified criteria.static <M,I> RowFilter<M,I>
orFilter(Iterable<? extends RowFilter<? super M,? super I>> filters)
Returns aRowFilter
that includes entries if any of the supplied filters includes the entry.static <M,I> RowFilter<M,I>
regexFilter(String regex, int... indices)
Returns aRowFilter
that uses a regular expression to determine which entries to include.
-
-
-
Method Detail
-
regexFilter
public static <M,I> RowFilter<M,I> regexFilter(String regex, int... indices)
Returns aRowFilter
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 aRowFilter
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". SeePattern
for a complete description of the supported regular-expression constructs.- Parameters:
regex
- the regular expression to filter onindices
- the indices of the values to check. If not supplied all values are evaluated- Returns:
- a
RowFilter
implementing the specified criteria - Throws:
NullPointerException
- ifregex
isnull
IllegalArgumentException
- if any of theindices
are < 0PatternSyntaxException
- ifregex
is not a valid regular expression.- See Also:
Pattern
-
dateFilter
public static <M,I> RowFilter<M,I> dateFilter(RowFilter.ComparisonType type, Date date, int... indices)
Returns aRowFilter
that includes entries that have at least oneDate
value meeting the specified criteria. For example, the followingRowFilter
includes only entries with at least one date value after the current date:RowFilter.dateFilter(ComparisonType.AFTER, new Date());
- Parameters:
type
- the type of comparison to performdate
- the date to compare againstindices
- the indices of the values to check. If not supplied all values are evaluated- Returns:
- a
RowFilter
implementing the specified criteria - Throws:
NullPointerException
- ifdate
isnull
IllegalArgumentException
- if any of theindices
are < 0 ortype
isnull
- See Also:
Calendar
,Date
-
numberFilter
public static <M,I> RowFilter<M,I> numberFilter(RowFilter.ComparisonType type, Number number, int... indices)
Returns aRowFilter
that includes entries that have at least oneNumber
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);
- Parameters:
type
- the type of comparison to performindices
- the indices of the values to check. If not supplied all values are evaluated- Returns:
- a
RowFilter
implementing the specified criteria - Throws:
IllegalArgumentException
- if any of theindices
are < 0,type
isnull
ornumber
isnull
-
orFilter
public static <M,I> RowFilter<M,I> orFilter(Iterable<? extends RowFilter<? super M,? super I>> filters)
Returns aRowFilter
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);
- Parameters:
filters
- theRowFilter
s to test- Returns:
- a
RowFilter
implementing the specified criteria - Throws:
IllegalArgumentException
- if any of the filters arenull
NullPointerException
- iffilters
is null- See Also:
Arrays.asList(T...)
-
andFilter
public static <M,I> RowFilter<M,I> andFilter(Iterable<? extends RowFilter<? super M,? super I>> filters)
Returns aRowFilter
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);
- Parameters:
filters
- theRowFilter
s to test- Returns:
- a
RowFilter
implementing the specified criteria - Throws:
IllegalArgumentException
- if any of the filters arenull
NullPointerException
- iffilters
is null- See Also:
Arrays.asList(T...)
-
notFilter
public static <M,I> RowFilter<M,I> notFilter(RowFilter<M,I> filter)
Returns aRowFilter
that includes entries if the supplied filter does not include the entry.- Parameters:
filter
- theRowFilter
to negate- Returns:
- a
RowFilter
implementing the specified criteria - Throws:
IllegalArgumentException
- iffilter
isnull
-
include
public abstract boolean include(RowFilter.Entry<? extends M,? extends I> entry)
Returns true if the specified entry should be shown; returns false if the entry should be hidden.The
entry
argument is valid only for the duration of the invocation. Usingentry
after the call returns results in undefined behavior.- Parameters:
entry
- a non-null
object that wraps the underlying object from the model- Returns:
- true if the entry should be shown
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/swing/rowfilter.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.