Oracle Coherence for C++ API
Release 3.6.1.0

E18813-01

ContainsAllFilter Class Reference

#include <coherence/util/filter/ContainsAllFilter.hpp>

Inherits ComparisonFilter, and IndexAwareFilter.

List of all members.


Detailed Description

Filter which tests a Collection or ObjectArray value returned from a method invocation for containment of all values in a Set.

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

 return ((Collection) extract(o))->containsAll((Collection) getValue());
 
If the specified method returns an ObjectArray, evaluate is functionally equivalent to the following code:
 return Collections->asList((ObjectArray::View) extract(o))->containsAll(
        (Collection) getValue());
 
Author:
djl 2008.04.07

Public Types

typedef spec::Handle  Handle
  ContainsAllFilter Handle definition.
typedef spec::View  View
  ContainsAllFilter View definition.
typedef spec::Holder  Holder
  ContainsAllFilter Holder definition.

Public Member Functions

virtual size32_t  calculateEffectiveness (Map::View vMapIndexes, Set::View vSetKeys) const
  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.

Parameters:
vMapIndexes  the available MapIndex objects keyed by the related ValueExtractor; read-only
vSetKeys  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

virtual Filter::View  applyIndex (Map::View vMapIndexes, Set::Handle hSetKeys) const
  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.

Parameters:
vMapIndexes  the available MapIndex objects keyed by the related ValueExtractor; read-only
hSetKeys  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


Protected Member Functions

  ContainsAllFilter ()
  Default constructor (necessary for the PortableObject interface).
  ContainsAllFilter (ValueExtractor::View vExtractor, Set::View vSetValues)
  Construct an ContainsAllFilter for testing containment of the given Set of values.
virtual bool  evaluateExtracted (Object::View vExtracted) const
  Evaluate the specified extracted value.

Constructor & Destructor Documentation

ContainsAllFilter ( ValueExtractor::View  vExtractor,
Set::View  vSetValues  
) [protected]

Construct an ContainsAllFilter for testing containment of the given Set of values.

Parameters:
vExtractor  the ValueExtractor used by this filter
vSetValues  the Set of values that a Collection or ObjectArray is tested to contain

Member Function Documentation

virtual bool evaluateExtracted ( Object::View  vExtracted  )  const [protected, virtual]

Evaluate the specified extracted value.

Parameters:
vExtracted  an extracted value to evaluate

Implements ExtractorFilter.


The documentation for this class was generated from the following file:
Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.