com.jidesoft.filter
Class SimpleValueFilter<E>

java.lang.Object
  com.jidesoft.filter.AbstractFilter<E>
      com.jidesoft.filter.AbstractValueFilter<E>
          com.jidesoft.filter.AbstractMutableValueFilter<E>
              com.jidesoft.filter.SimpleValueFilter<E>

All Implemented Interfaces:

Filter<E>, MutableValueFilter<E>, ObjectGrouperSupport, ValueFilter<E>, Serializable, Cloneable, Iterable<E>

public final class SimpleValueFilter<E>
extends AbstractMutableValueFilter<E>

A simple mutable filter implementation.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.jidesoft.filter.Filter

ALL, CUSTOM, NULL, SEPARATOR

Constructor Summary

SimpleValueFilter()

Method Summary

void	clearFilter()
void	clearFilter(Object lock)
int	getFilteredCount() Returns the number of elements currently filtered.
boolean	isActive() Indicates whether at least one element is currently filtered.
boolean	isOnlyValueFiltered(E element, Object lock) Indicates whether a given element is filtered or not exclusively by the given lock.
boolean	isValueFiltered(E element) Checks to see if the value should be filtered.
boolean	isValueFiltered(E element, Object lock) Indicates whether a given element is filtered or not by the given lock.
Iterator<E>	iterator()
void	setFiltered(E element, boolean filtered, Object lock)

Methods inherited from class com.jidesoft.filter.AbstractMutableValueFilter

setEnabled

Methods inherited from class com.jidesoft.filter.AbstractValueFilter

addValueFilterListener, addWeakFilterListener, isEnabled, notifyFilteredChanged, removeFilterListener, removeFilterListeners

Methods inherited from class com.jidesoft.filter.AbstractFilter

addFilterListener, clone, fireFilterChanged, fireFilterContentChanged, fireFilterDisabled, fireFilterEnabled, fireFilterNameChanged, getConditionString, getFilterFactory, getFilterFactoryName, getFilterListeners, getName, getObjectGrouper, getObjectGrouperName, getPreference, isFilterValid, removeFilterListener, setFilterFactory, setFilterFactoryName, setName, setObjectGrouper, setObjectGrouperName, setPreference, stricterThan

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jidesoft.filter.ValueFilter

addValueFilterListener, addWeakFilterListener, removeFilterListener, removeFilterListeners

Methods inherited from interface com.jidesoft.filter.Filter

addFilterListener, clone, getFilterFactory, getFilterFactoryName, getName, getPreference, isEnabled, removeFilterListener, setFilterFactory, setFilterFactoryName, setName, setPreference, stricterThan

Constructor Detail

SimpleValueFilter

public SimpleValueFilter()

Method Detail

isActive

public boolean isActive()

Description copied from interface: ValueFilter

Indicates whether at least one element is currently filtered.

Returns:

true if at least one element is filtered, false otherwise.

isValueFiltered

public boolean isValueFiltered(E element)

Description copied from interface: Filter

Checks to see if the value should be filtered.

Parameters:

element - the value to filter

Returns:

true if the value should be filtered. Otherwise false.

clearFilter

public void clearFilter()

clearFilter

public void clearFilter(Object lock)

isValueFiltered

public boolean isValueFiltered(E element,
                               Object lock)

Description copied from interface: ValueFilter

Indicates whether a given element is filtered or not by the given lock.

Parameters:

element - the element to be tested

lock - the object used to filter the element

Returns:

true if the element is filtered, false otherwise

isOnlyValueFiltered

public boolean isOnlyValueFiltered(E element,
                                   Object lock)

Description copied from interface: ValueFilter

Indicates whether a given element is filtered or not exclusively by the given lock.

Parameters:

element - the element to be tested

lock - the object used to filter the element

Returns:

true if the element is filtered, false otherwise

getFilteredCount

public int getFilteredCount()

Description copied from interface: ValueFilter

Returns the number of elements currently filtered.

Returns:

the number of filtered elements.

setFiltered

public void setFiltered(E element,
                        boolean filtered,
                        Object lock)

iterator

public Iterator<E> iterator()