Skip navigation links

com.tangosol.util.filter
Class InFilter

java.lang.Object
com.tangosol.util.Base
com.tangosol.util.BitHelper
com.tangosol.util.ExternalizableHelper
com.tangosol.util.filter.AbstractQueryRecorderFilter
com.tangosol.util.filter.ExtractorFilter
com.tangosol.util.filter.ComparisonFilter
com.tangosol.util.filter.InFilter

All Implemented Interfaces:

ExternalizableLite, PortableObject, Filter, EntryFilter, IndexAwareFilter, QueryRecorderFilter, java.io.Serializable

public class InFilter

extends ComparisonFilter

implements IndexAwareFilter

Filter which checks whether the result of a method invocation belongs to a predefined set of values.

Author:

cp/gg 2002.11.08

Field Summary

Fields inherited from class com.tangosol.util.filter.ComparisonFilter

m_oValue

Fields inherited from class com.tangosol.util.filter.ExtractorFilter

EVAL_COST, m_extractor

Constructor Summary

InFilter()
Default constructor (necessary for the ExternalizableLite interface).

InFilter(java.lang.String sMethod, java.util.Set setValues)
Construct an InFilter for testing "In" condition.

InFilter(ValueExtractor extractor, java.util.Set setValues)
Construct an InFilter for testing "In" condition.

Method Summary

Filter	applyIndex(java.util.Map mapIndexes, java.util.Set setKeys) Filter remaining keys using a Map of available indexes.
int	calculateEffectiveness(java.util.Map mapIndexes, java.util.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.
protected boolean	evaluateExtracted(java.lang.Object oExtracted) Evaluate the specified extracted value.
void	readExternal(PofReader in) Restore the contents of a user type instance by reading its state using the specified PofReader object.
java.lang.String	toStringValue() Return the string representation of the value.
void	writeExternal(PofWriter out) Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Methods inherited from class com.tangosol.util.filter.ComparisonFilter

calculateMatchEffectiveness, calculateRangeEffectiveness, equals, getValue, hashCode, readExternal, toString, writeExternal

Methods inherited from class com.tangosol.util.filter.ExtractorFilter

calculateIteratorEffectiveness, evaluate, evaluateEntry, extract, getValueExtractor

Methods inherited from class com.tangosol.util.filter.AbstractQueryRecorderFilter

explain, explain, trace, trace, trace, trace

Methods inherited from class com.tangosol.util.BitHelper

countBits, countBits, countBits, indexOfLSB, indexOfLSB, indexOfLSB, indexOfMSB, indexOfMSB, indexOfMSB, rotateLeft, rotateLeft, rotateLeft, rotateRight, rotateRight, rotateRight, toBitString, toBitString, toBitString, toBytes, toBytes, toBytes, toBytes, toInt, toInt, toLong, toLong

Methods inherited from interface com.tangosol.util.filter.EntryFilter

evaluateEntry

Methods inherited from interface com.tangosol.util.Filter

evaluate

Constructor Detail

InFilter

public InFilter()

Default constructor (necessary for the ExternalizableLite interface).

InFilter

public InFilter(ValueExtractor extractor,
                java.util.Set setValues)

Construct an InFilter for testing "In" condition.

Parameters:

extractor - the ValueExtractor to use by this filter

setValues - the set of values to compare the result with

InFilter

public InFilter(java.lang.String sMethod,
                java.util.Set setValues)

Construct an InFilter for testing "In" condition.

Parameters:

sMethod - the name of the method to invoke via reflection

setValues - the set of values to compare the result with

Method Detail

evaluateExtracted

protected boolean evaluateExtracted(java.lang.Object oExtracted)

Evaluate the specified extracted value.

Specified by:

evaluateExtracted in class ExtractorFilter

Parameters:

oExtracted - an extracted value to evaluate

Returns:

true iff the test passes

toStringValue

public java.lang.String toStringValue()

Return the string representation of the value.

Overrides:

toStringValue in class ComparisonFilter

Returns:

the string representation of the value

calculateEffectiveness

public int calculateEffectiveness(java.util.Map mapIndexes,
                                  java.util.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

Overrides:

calculateEffectiveness in class ExtractorFilter

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(java.util.Map mapIndexes,
                         java.util.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

Overrides:

applyIndex in class ExtractorFilter

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

readExternal

public void readExternal(PofReader in)
                  throws java.io.IOException

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

Specified by:

readExternal in interface PortableObject

Overrides:

readExternal in class ComparisonFilter

Parameters:

in - the PofReader from which to read the object's state

Throws:

java.io.IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   throws java.io.IOException

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

Specified by:

writeExternal in interface PortableObject

Overrides:

writeExternal in class ComparisonFilter

Parameters:

out - the PofWriter to which to write the object's state

Throws:

java.io.IOException - if an I/O error occurs

Skip navigation links