Class InFilter

IFilter which checks whether the result of a member invocation belongs to a predefined collection of values.

Inheritance

object

ExtractorFilter

ComparisonFilter

InFilter

Implements

Inherited Members

ComparisonFilter.Value

ComparisonFilter.Equals(object)

ComparisonFilter.GetHashCode()

ComparisonFilter.ToString()

ComparisonFilter.CalculateMatchEffectiveness(IDictionary, ICollection)

ComparisonFilter.CalculateRangeEffectiveness(IDictionary, ICollection)

ComparisonFilter.CalculateIteratorEffectiveness(int)

ComparisonFilter.m_value

ExtractorFilter.ValueExtractor

ExtractorFilter.Evaluate(object)

ExtractorFilter.EvaluateEntry(ICacheEntry)

ExtractorFilter.Extract(object)

ExtractorFilter.EVAL_COST

ExtractorFilter.m_extractor

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Tangosol.Util.Filter

Assembly: Coherence.dll

Syntax

public class InFilter : ComparisonFilter, IPortableObject, IIndexAwareFilter, IEntryFilter, IFilter

Constructors

InFilter()

Default constructor.

Declaration

public InFilter()

InFilter(string, ICollection)

Construct an InFilter for testing "In" condition.

Declaration

public InFilter(string member, ICollection values)

Parameters

Type	Name	Description
string	member	The name of the member to invoke via reflection.
ICollection	values	The collection of values to compare the result with.

InFilter(IValueExtractor, ICollection)

Construct an InFilter for testing "In" condition.

Declaration

public InFilter(IValueExtractor extractor, ICollection values)

Parameters

Type	Name	Description
IValueExtractor	extractor	The IValueExtractor to use by this filter.
ICollection	values	The collection of values to compare the result with.

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

ExtractorFilter.EvaluateExtracted(object)

ReadExternal(IPofReader)

Restore the contents of a user type instance by reading its state using the specified IPofReader object.

Declaration

public override void ReadExternal(IPofReader reader)

Parameters

Type	Name	Description
IPofReader	reader	The IPofReader from which to read the object's state.

Overrides

ComparisonFilter.ReadExternal(IPofReader)

Exceptions

Type	Condition
IOException	If an I/O error occurs.

WriteExternal(IPofWriter)

Save the contents of a POF user type instance by writing its state using the specified IPofWriter object.

Declaration

public override void WriteExternal(IPofWriter writer)

Parameters

Type	Name	Description
IPofWriter	writer	The IPofWriter to which to write the object's state.

Overrides

ComparisonFilter.WriteExternal(IPofWriter)

Exceptions

Type	Condition
IOException	If an I/O error occurs.

Implements

IPortableObject

IIndexAwareFilter

IEntryFilter

IFilter