Class ContainsAnyFilter

IFilter which tests an ICollection or object array value returned from a method invocation for containment of any value in a collection.

Inheritance
object
ExtractorFilter
ComparisonFilter
ContainsAnyFilter
Implements
Inherited Members
Namespace: Tangosol.Util.Filter
Assembly: Coherence.dll
Syntax
public class ContainsAnyFilter : ComparisonFilter, IPortableObject, IIndexAwareFilter, IEntryFilter, IFilter

Constructors

ContainsAnyFilter()

Default constructor.

Declaration
public ContainsAnyFilter()

ContainsAnyFilter(string, ICollection)

Construct an ContainsAnyFilter for testing containment of any value in the given ICollection.

Declaration
public ContainsAnyFilter(string member, ICollection values)
Parameters
Type Name Description
string member

The name of the member to invoke via reflection.
ICollection values

The ICollection of values that a collection or object array is tested to contain.

ContainsAnyFilter(IValueExtractor, ICollection)

Construct an ContainsAnyFilter for testing containment of any value in the given ICollection.

Declaration
public ContainsAnyFilter(IValueExtractor extractor, ICollection values)
Parameters
Type Name Description
IValueExtractor extractor

The IValueExtractor used by this filter.
ICollection values

The ICollection of values that a collection or object array is tested to contain.

Methods

ApplyIndex(IDictionary, ICollection)

Filter remaining keys using an IDictionary of available indexes.

Declaration
public IFilter ApplyIndex(IDictionary indexes, ICollection keys)
Parameters
Type Name Description
IDictionary indexes

The available ICacheIndex objects keyed by the related IValueExtractor; read-only.
ICollection keys

The mutable set of keys that remain to be filtered.
Returns
Type Description
IFilter

An IFilter object that can be used to process the remaining keys, or null if no additional filter processing is necessary.
Remarks

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 IEntryFilter) 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.

CalculateEffectiveness(IDictionary, ICollection)

Given an IDictionary of available indexes, determine if this IIndexAwareFilter can use any of the indexes to assist in its processing, and if so, determine how effective the use of that index would be.

Declaration
public int CalculateEffectiveness(IDictionary indexes, ICollection keys)
Parameters
Type Name Description
IDictionary indexes

The available ICacheIndex objects keyed by the related IValueExtractor; read-only.
ICollection keys

The set of keys that will be filtered; read-only.
Returns
Type Description
int

An effectiveness estimate of how well this filter can use the specified indexes to filter the specified keys.
Remarks

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 keys.size() then a user could avoid using the index and iterate through the keys calling Evaluate rather than ApplyIndex.

EvaluateExtracted(object)

Evaluate the specified extracted value.

Declaration
protected override bool EvaluateExtracted(object extracted)
Parameters
Type Name Description
object extracted

An extracted value to evaluate.
Returns
Type Description
bool

true if the test passes, false otherwise.
Overrides

Implements