com.jidesoft.grid
Class SingleValueFilter<T>

java.lang.Object
  com.jidesoft.filter.AbstractFilter<T>
      com.jidesoft.grid.AbstractFilter<T>
          com.jidesoft.grid.AbstractTableFilter<T>
              com.jidesoft.grid.SingleValueFilter<T>

All Implemented Interfaces:

Filter<T>, SqlFilterSupport, TableFilter<T>, Serializable, Cloneable

public class SingleValueFilter<T>
extends AbstractTableFilter<T>
implements SqlFilterSupport

A Filter that uses filters away all values except the specified value.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.jidesoft.filter.Filter

ALL, CUSTOM, NULL

Constructor Summary

SingleValueFilter(String name, T value)
Creates SingleValueFilter.

SingleValueFilter(T value)
Creates SingleValueFilter.

Method Summary

String	getName() Gets the name of the filter.
ObjectGrouper	getObjectGrouper()
String	getOperator()
T	getValue() Gets the only allowed value.
boolean	isValueFiltered(T value) Checks if the value is allowed.
void	setObjectGrouper(ObjectGrouper objectGrouper)
void	setValue(T value) Sets the only allowed value.
boolean	stricterThan(Filter inputFilter) Check if this filter is stricter than the input filter while the two filters are with the same class.

Methods inherited from class com.jidesoft.grid.AbstractTableFilter

getColumnIndex, getRowIndex, setColumnIndex, setRowIndex

Methods inherited from class com.jidesoft.filter.AbstractFilter

addFilterListener, clone, fireFilterChanged, fireFilterContentChanged, fireFilterDisabled, fireFilterEnabled, fireFilterNameChanged, getConditionString, getFilterFactory, getFilterFactoryName, getFilterListeners, isEnabled, removeFilterListener, setEnabled, setFilterFactory, setFilterFactoryName, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jidesoft.filter.Filter

addFilterListener, clone, getFilterFactory, getFilterFactoryName, isEnabled, removeFilterListener, setEnabled, setFilterFactory, setFilterFactoryName, setName

Constructor Detail

SingleValueFilter

public SingleValueFilter(T value)

Creates SingleValueFilter.

Parameters:

value - the value that will not be filtered

SingleValueFilter

public SingleValueFilter(String name,
                         T value)

Creates SingleValueFilter.

Parameters:

name - name of the filter

value - the value that will not be filtered

Method Detail

isValueFiltered

public boolean isValueFiltered(T value)

Checks if the value is allowed.

Specified by:

isValueFiltered in interface Filter<T>

Parameters:

value - the value to check.

Returns:

true if not allowed and false if allowed. Please note, this could be the opposite of what you thought as the method name is if the value is filtered.

getObjectGrouper

public ObjectGrouper getObjectGrouper()

setObjectGrouper

public void setObjectGrouper(ObjectGrouper objectGrouper)

getValue

public T getValue()

Gets the only allowed value.

Returns:

the only allowed value.

setValue

public void setValue(T value)

Sets the only allowed value.

Parameters:

value - the value.

getName

public String getName()

Description copied from interface: Filter

Gets the name of the filter.

Specified by:

getName in interface Filter<T>

Overrides:

getName in class AbstractFilter<T>

Returns:

the name of the filter.

stricterThan

public boolean stricterThan(Filter inputFilter)

Check if this filter is stricter than the input filter while the two filters are with the same class.

Specified by:

stricterThan in interface Filter<T>

Overrides:

stricterThan in class AbstractFilter<T>

Parameters:

inputFilter - the input filter

Returns:

true if the fields in this filter are exactly the same with those in the input filter. Otherwise false.

getOperator

public String getOperator()

Specified by:

getOperator in interface SqlFilterSupport