ca.odell.glazedlists.matchers

Class ThresholdMatcherEditor<E,T>

Implemented Interfaces:
MatcherEditor<E>

public class ThresholdMatcherEditor<E,T>
extends AbstractMatcherEditor<E>

A MatcherEditor that filters elements based on whether they are greater than or less than a threshold. The implementation is based on elements implementing Comparable unless the constructor specifies a Comparator. By default the elements themselves are compared with the threshold value, however, an optional Function can be provided which can be used to extract a value that is appropriate for comparison with the threshold. In this way, ThreshholdMatcherEditor provides a level of indirection when locating the exact value to compare for a given element.
Author:
Rob Eden

Field Summary

static ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation
EQUAL
static ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation
GREATER_THAN
static ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation
GREATER_THAN_OR_EQUAL
static ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation
LESS_THAN
static ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation
LESS_THAN_OR_EQUAL
static ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation
NOT_EQUAL

Fields inherited from class ca.odell.glazedlists.matchers.AbstractMatcherEditor<E>

currentMatcher

Constructor Summary

ThresholdMatcherEditor()
Construct an instance that will require elements to be greater than the threshold (which is not initially set) and relies on the threshold object and elements in the list implementing Comparable.
ThresholdMatcherEditor(T threshold)
Construct an instance that will require elements to be greater than the given threshold and relies on the threshold object and elements in the list implementing Comparable.
ThresholdMatcherEditor(T threshold, ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation operation)
Construct an instance that will require elements to be greater than the given threshold and relies on the threshold object and elements in the list implementing Comparable.
ThresholdMatcherEditor(T threshold, ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation operation, Comparator comparator)
Construct an instance.
ThresholdMatcherEditor(T threshold, ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation operation, Comparator comparator, ca.odell.glazedlists.FunctionList.Function function)
Construct an instance.

Method Summary

Comparator
getComparator()
ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation
getMatchOperation()
See setMatchOperation(ThresholdMatcherEditor.MatchOperation).
T
getThreshold()
See getThreshold().
void
setComparator(Comparator comparator)
Update the comparator.
void
setMatchOperation(ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation operation)
Update the operation used to determine what relation list elements should have to the threshold in order to match (i.e.
void
setThreshold(T threshold)
Update the threshold used to determine what is matched by the list.

Methods inherited from class ca.odell.glazedlists.matchers.AbstractMatcherEditor<E>

addMatcherEditorListener, fireChanged, fireChangedMatcher, fireConstrained, fireMatchAll, fireMatchNone, fireRelaxed, getMatcher, isCurrentlyMatchingAll, isCurrentlyMatchingNone, removeMatcherEditorListener

Field Details

EQUAL

public static final ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation EQUAL

GREATER_THAN

public static final ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation GREATER_THAN

GREATER_THAN_OR_EQUAL

public static final ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation GREATER_THAN_OR_EQUAL

LESS_THAN

public static final ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation LESS_THAN

LESS_THAN_OR_EQUAL

public static final ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation LESS_THAN_OR_EQUAL

NOT_EQUAL

public static final ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation NOT_EQUAL

Constructor Details

ThresholdMatcherEditor

public ThresholdMatcherEditor()
Construct an instance that will require elements to be greater than the threshold (which is not initially set) and relies on the threshold object and elements in the list implementing Comparable.

ThresholdMatcherEditor

public ThresholdMatcherEditor(T threshold)
Construct an instance that will require elements to be greater than the given threshold and relies on the threshold object and elements in the list implementing Comparable.
Parameters:
threshold - the initial threshold, or null if none.

ThresholdMatcherEditor

public ThresholdMatcherEditor(T threshold,
                              ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation operation)
Construct an instance that will require elements to be greater than the given threshold and relies on the threshold object and elements in the list implementing Comparable.

ThresholdMatcherEditor

public ThresholdMatcherEditor(T threshold,
                              ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation operation,
                              Comparator comparator)
Construct an instance.

ThresholdMatcherEditor

public ThresholdMatcherEditor(T threshold,
                              ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation operation,
                              Comparator comparator,
                              ca.odell.glazedlists.FunctionList.Function function)
Construct an instance.
Parameters:
threshold - the initial threshold, or null if none.
operation - the operation to determine what relation list elements should have to the threshold in order to match (i.e., be visible). Specifying null will use GREATER_THAN.
comparator - determines how objects compare with the threshold value. If null, the threshold object and list elements must implement Comparable.
function - an optional Function which produces a value fit to be compared against the threshold. This argument is optional, and if it is null, the raw values will compared against the threshold.

Method Details

getComparator

public Comparator getComparator()

getMatchOperation

public ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation getMatchOperation()

getThreshold

public T getThreshold()

setComparator

public void setComparator(Comparator comparator)
Update the comparator. Setting to null will require that thresholds and elements in the list implement Comparable.

setMatchOperation

public void setMatchOperation(ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation operation)
Update the operation used to determine what relation list elements should have to the threshold in order to match (i.e. be visible). Must be non-null.

setThreshold

public void setThreshold(T threshold)
Parameters:
threshold - The threshold, or null to match everything.

Glazed Lists, Copyright © 2003 publicobject.com, O'Dell Engineering.
Documentation build by pbuilder at 2009-07-14 22:05