Package com.tangosol.util.filter

Class GreaterEqualsFilter<T,E extends Comparable<? super E>>

java.lang.Object
com.tangosol.util.Base
com.tangosol.util.BitHelper
com.tangosol.util.ExternalizableHelper
com.tangosol.util.filter.AbstractQueryRecorderFilter<T>
com.tangosol.util.filter.ExtractorFilter<T,E>
com.tangosol.util.filter.ComparisonFilter<T,E,E>
com.tangosol.util.filter.GreaterEqualsFilter<T,E>
Type Parameters:
T - the type of the input argument to the filter
E - the type of the value to use for comparison
All Implemented Interfaces:
ExternalizableLite, PortableObject, Filter<T>, EntryFilter<Object,T>, IndexAwareFilter<Object,T>, QueryRecorderFilter<T>, Serializable
public class GreaterEqualsFilter<T,E extends Comparable<? super E>> extends ComparisonFilter<T,E,E> implements IndexAwareFilter<Object,T>
Filter which compares the result of a method invocation with a value for "Greater or Equal" condition. In a case when either result of a method invocation or a value to compare are equal to null, the evaluate test yields false. This approach is equivalent to the way the NULL values are handled by SQL.
Author:
cp/gg 2002.10.29
See Also:

  • Constructor Details

    • GreaterEqualsFilter

      public GreaterEqualsFilter()
      Default constructor (necessary for the ExternalizableLite interface).

    • GreaterEqualsFilter

      public GreaterEqualsFilter(ValueExtractor<? super T,? extends E> extractor, E value)
      Construct a GreaterEqualFilter for testing "Greater or Equal" condition.
      Parameters:
      extractor - the ValueExtractor to use by this filter
      value - the object to compare the result with

    • GreaterEqualsFilter

      public GreaterEqualsFilter(String sMethod, E value)
      Construct a GreaterEqualFilter for testing "Greater or Equal" condition.
      Parameters:
      sMethod - the name of the method to invoke via reflection
      value - the object to compare the result with

  • Method Details

    • evaluateExtracted

      protected boolean evaluateExtracted(E extracted)
      Evaluate the specified extracted value.
      Specified by:
      evaluateExtracted in class ExtractorFilter<T,E extends Comparable<? super E>>
      Parameters:
      extracted - an extracted value to evaluate
      Returns:
      true iff the test passes

    • calculateEffectiveness

      public int calculateEffectiveness(Map mapIndexes, Set setKeys)
      Given a Map of available indexes, determine if this IndexAwareFilter can use any of the indexes to assist in its processing, and if so, determine how effective the use of that index would be.

      The returned value is an effectiveness estimate of how well this filter can use the specified indexes to filter the specified keys. An operation that requires no more than a single access to the index content (i.e. Equals, NotEquals) has an effectiveness of one. Evaluation of a single entry is assumed to have an effectiveness that depends on the index implementation and is usually measured as a constant number of the single operations. This number is referred to as evaluation cost.

      If the effectiveness of a filter evaluates to a number larger than the keySet.size() * <evaluation cost> then a user could avoid using the index and iterate through the keySet calling evaluate rather then applyIndex.

      Specified by:
      calculateEffectiveness in interface IndexAwareFilter<T,E extends Comparable<? super E>>
      Overrides:
      calculateEffectiveness in class ExtractorFilter<T,E extends Comparable<? super E>>
      Parameters:
      mapIndexes - the available MapIndex objects keyed by the related ValueExtractor; read-only
      setKeys - the set of keys that will be filtered; read-only
      Returns:
      an effectiveness estimate of how well this filter can use the specified indexes to filter the specified keys

    • applyIndex

      public Filter applyIndex(Map mapIndexes, Set setKeys)
      Filter remaining keys using a Map of available indexes.

      The filter is responsible for removing all keys from the passed set of keys that the applicable indexes can prove should be filtered. If the filter does not fully evaluate the remaining keys using just the index information, it must return a filter (which may be an EntryFilter) that can complete the task using an iterating implementation. If, on the other hand, the filter does fully evaluate the remaining keys using just the index information, then it should return null to indicate that no further filtering is necessary.

      Specified by:
      applyIndex in interface IndexAwareFilter<T,E extends Comparable<? super E>>
      Overrides:
      applyIndex in class ExtractorFilter<T,E extends Comparable<? super E>>
      Parameters:
      mapIndexes - the available MapIndex objects keyed by the related ValueExtractor; read-only
      setKeys - the mutable set of keys that remain to be filtered
      Returns:
      a Filter object (which may be an EntryFilter) that can be used to process the remaining keys, or null if no additional filter processing is necessary