no.g9.client.core.view.table

Class RowFilter<U,T extends ListRow>

java.lang.Object

no.g9.client.core.view.table.RowFilter<U,T>

Type Parameters:

U - the filter type class

T - the generated ListRow class

public abstract class RowFilter<U,T extends ListRow>
extends Object

ColumnFilter is used to filter ListRows based on a filter value and filter type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RowFilter.FilterType Specifies the criteria used by a Filter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RowFilter(DialogObjectConstant column, U filterValue) Create a new row filter.

Method Summary

Modifier and Type	Method and Description
static <U extends Comparable<U>,T extends ListRow> RowFilter<U,T>	comparableFilter(DialogObjectConstant column, U filterValue, RowFilter.FilterType filterType) Create a filter that uses a java.lang.Comparable filter value.
DialogObjectConstant	getColumn() Get the column this filter applies to.
U	getFilterValue() Get the value used by this filter when checking if a row should be included.
abstract boolean	passFilter(T row) Test if the specified row passes this filter.
static <T extends ListRow> RowFilter<String,T>	regexpFilter(DialogObjectConstant column, String regexp) Create a filter that uses the a regular expression to filter values.
void	setFilterValue(U filterValue) Set the value used by this filter when checking if a row should be included.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RowFilter

protected RowFilter(DialogObjectConstant column,
                    U filterValue)

Create a new row filter. The filter will use the value in the specified column to determine if the row passes this filter.

Parameters:

column - the column used when filtering

filterValue - the filter value

Method Detail

passFilter

public abstract boolean passFilter(T row)

Test if the specified row passes this filter. This method returns true if the row is not caught by this filter.

Parameters:

row - ListRow to test

Returns:

true if the row is accepted by this filter

getFilterValue

public final U getFilterValue()

Get the value used by this filter when checking if a row should be included.

Returns:

the filter value

setFilterValue

public void setFilterValue(U filterValue)

Set the value used by this filter when checking if a row should be included.

Parameters:

filterValue - the filter value

getColumn

public DialogObjectConstant getColumn()

Get the column this filter applies to.

Returns:

the dialog object constant denoting the column

comparableFilter

public static <U extends Comparable<U>,T extends ListRow> RowFilter<U,T> comparableFilter(DialogObjectConstant column,
                                                                                          U filterValue,
                                                                                          RowFilter.FilterType filterType)

Create a filter that uses a java.lang.Comparable filter value. Note that null values will never pass this filter.

Type Parameters:

U - the filter type class

T - the generated ListRow class

Parameters:

column - the column this filter applies to

filterValue - the filter value

filterType - the type of filter

Returns:

a filter that uses Comparable when filtering

regexpFilter

public static <T extends ListRow> RowFilter<String,T> regexpFilter(DialogObjectConstant column,
                                                                   String regexp)

Create a filter that uses the a regular expression to filter values.

Type Parameters:

T - the generated ListRow class

Parameters:

column - the column this filter applies to

regexp - the regular expression

Returns:

a filter that uses the regular expression when filtering