org.jdesktop.swingx.decorator
Class PatternFilter

java.lang.Object
  extended by org.jdesktop.swingx.decorator.Filter
      extended by org.jdesktop.swingx.decorator.PatternFilter
All Implemented Interfaces:
PatternMatcher

public class PatternFilter
extends Filter
implements PatternMatcher

Pluggable pattern filter.

Author:
Ramesh Gupta

Constructor Summary
PatternFilter()
          Instantiates a includeAll PatternFilter with matchFlag 0 on column 0.
PatternFilter(java.lang.String regularExpr, int matchFlags, int col)
          Instantiates a PatternFilter with a Pattern compiled from the given regex and matchFlags on the column in model coordinates.
 
Method Summary
 java.util.regex.Pattern getPattern()
          Returns the pattern used by this filter for matching.
 int getSize()
          Returns the number of records that remain in this filter's output ("view") after the input records have been filtered.
 void setPattern(java.util.regex.Pattern pattern)
          Sets the pattern used by this filter for matching.
 void setPattern(java.lang.String regularExpr, int matchFlags)
          Convenience to set the pattern in terms of a regex and matchFlags, which are used to compile the pattern to apply.
 boolean test(int row)
          Tests whether the given row (in this filter's coordinates) should be added.
 
Methods inherited from class org.jdesktop.swingx.decorator.Filter
convertRowIndexToModel, convertRowIndexToView, getColumnIndex, getColumnName, getStringAt, getValueAt, isCellEditable, refresh, setColumnIndex, setValueAt
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PatternFilter

public PatternFilter()
Instantiates a includeAll PatternFilter with matchFlag 0 on column 0.


PatternFilter

public PatternFilter(java.lang.String regularExpr,
                     int matchFlags,
                     int col)
Instantiates a PatternFilter with a Pattern compiled from the given regex and matchFlags on the column in model coordinates.

Parameters:
regularExpr - the regex to compile, a null or empty String is interpreted as ".*"
matchFlags - the matchflags to use in the compile
col - the column to filter in model coordinates.
Method Detail

setPattern

public void setPattern(java.lang.String regularExpr,
                       int matchFlags)
Convenience to set the pattern in terms of a regex and matchFlags, which are used to compile the pattern to apply.

Parameters:
regularExpr - the regex to compile, a null or empty String is interpreted as ".*"
matchFlags - the matchflags to use in the compile
See Also:
for details

setPattern

public void setPattern(java.util.regex.Pattern pattern)
Sets the pattern used by this filter for matching.

Specified by:
setPattern in interface PatternMatcher
Parameters:
pattern - the pattern used by this filter for matching
See Also:
Pattern

getPattern

public java.util.regex.Pattern getPattern()
Returns the pattern used by this filter for matching.

Specified by:
getPattern in interface PatternMatcher
Returns:
the pattern used by this filter for matching
See Also:
Pattern

test

public boolean test(int row)
Tests whether the given row (in this filter's coordinates) should be added.

PENDING JW: why is this public? called from a protected method?

Parameters:
row - the row to test
Returns:
true if the row should be added, false if not.

getSize

public int getSize()
Returns the number of records that remain in this filter's output ("view") after the input records have been filtered.

Specified by:
getSize in class Filter
Returns:
the number of records that remain in this filter's output ("view") after the input records have been filtered