Package ca.odell.glazedlists.matchers

Class ThresholdMatcherEditor<E,​T>

  • All 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 Detail

      • 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

      • EQUAL

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

      • NOT_EQUAL

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

    • Constructor Detail

      • 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.
        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.

      • ThresholdMatcherEditor

        public ThresholdMatcherEditor​(T threshold,
                              ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation operation,
                              java.util.Comparator<T> comparator)
        Construct an instance.
        Parameters:
        threshold - rhe initial threshold, or null if none.
        operation - rhe 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. If null, the threshold object and list elements must implement Comparable.

      • ThresholdMatcherEditor

        public ThresholdMatcherEditor​(T threshold,
                              ca.odell.glazedlists.matchers.ThresholdMatcherEditor.MatchOperation operation,
                              java.util.Comparator<T> comparator,
                              FunctionList.Function<E,​T> 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 Detail

      • setThreshold

        public void setThreshold​(T threshold)
        Update the threshold used to determine what is matched by the list. This coupled with the match operation determines what's matched.
        Parameters:
        threshold - The threshold, or null to match everything.

      • 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.
        See Also:
        GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, EQUAL, NOT_EQUAL

      • setComparator

        public void setComparator​(java.util.Comparator<T> comparator)
        Update the comparator. Setting to null will require that thresholds and elements in the list implement Comparable.

      • getComparator

        public java.util.Comparator<T> getComparator()