Package com.tangosol.util.filter

Class ContainsAllFilter<T,​E>

  • Type Parameters:
    T - the type of the input argument to the filter
    E - the type of the extracted attribute to use for comparison
    All Implemented Interfaces:
    ExternalizableLite, PortableObject, Filter<T>, EntryFilter<Object,​T>, IndexAwareFilter<Object,​T>, QueryRecorderFilter<T>, Serializable
    public class ContainsAllFilter<T,​E>
extends ComparisonFilter<T,​E,​Set<?>>
implements IndexAwareFilter<Object,​T>
    Filter which tests a Collection or Object array value returned from a method invocation for containment of all values in a Set.

    More formally, if the specified extractor returns a Collection, evaluate(o) is functionally equivalent to the following code: 

     return ((Collection) extract(o)).containsAll((Collection) getValue());
    If the specified method returns an Object array, evaluate(o) is functionally equivalent to the following code: 
     return Collections.asList((Object[]) extract(o)).containsAll((Collection) getValue());

    Author:
    jh 2005.06.08
    See Also:
    Serialized Form

    • Constructor Detail

      • ContainsAllFilter

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

      • ContainsAllFilter

        public ContainsAllFilter​(ValueExtractor<? super T,​? extends E> extractor,
                         Set<?> setValues)
        Construct an ContainsAllFilter for testing containment of the given Set of values.
        Parameters:
        extractor - the ValueExtractor used by this filter
        setValues - the Set of values that a Collection or Object array is tested to contain

      • ContainsAllFilter

        public ContainsAllFilter​(String sMethod,
                         Set<?> setValues)
        Construct an ContainsAllFilter for testing containment of the given Set of values.
        Parameters:
        sMethod - the name of the method to invoke via reflection
        setValues - the Set of values that a Collection or Object array is tested to contain

    • Method Detail

      • evaluateExtracted

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

      • toStringValue

        public String toStringValue()
        Return the string representation of the value.
        Overrides:
        toStringValue in class ComparisonFilter<T,​E,​Set<?>>
        Returns:
        the string representation of the value

      • 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>
        Overrides:
        calculateEffectiveness in class ExtractorFilter<T,​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>
        Overrides:
        applyIndex in class ExtractorFilter<T,​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