|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.tangosol.util.Base
com.tangosol.util.BitHelper
com.tangosol.util.ExternalizableHelper
com.tangosol.util.filter.AbstractQueryRecorderFilter
com.tangosol.util.filter.InKeySetFilter
public class InKeySetFilter
Filter that limits the underlying filter evaluation only to the specified set of keys.
Constructor Summary | |
---|---|
InKeySetFilter() Default constructor (necessary for the ExternalizableLite interface). |
|
InKeySetFilter(Filter filter, java.util.Set setKeys) 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. |
void |
ensureConverted(Converter converter) Ensure that the underlying keys are converted using the specified converter. |
boolean |
evaluate(java.lang.Object o) Apply the test to the object. |
boolean |
evaluateEntry(java.util.Map.Entry entry) Apply the test to a Map Entry. |
Filter |
getFilter() Obtain the underying Filter. |
void |
readExternal(java.io.DataInput in) Restore the contents of this object by loading the object's state from the passed DataInput object. |
void |
readExternal(PofReader in) Restore the contents of a user type instance by reading its state using the specified PofReader object. |
java.lang.String |
toString() Return a human-readable description for this Filter. |
void |
writeExternal(java.io.DataOutput out) Save the contents of this object by storing the object's state into the passed DataOutput object. |
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.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 |
Constructor Detail |
---|
public InKeySetFilter()
public InKeySetFilter(Filter filter, java.util.Set setKeys)
filter
- the underlying filtersetKeys
- the set of keys to limit the filter evaluation toMethod Detail |
---|
public boolean evaluate(java.lang.Object o)
evaluate
in interface Filter
o
- the object to testpublic boolean evaluateEntry(java.util.Map.Entry entry)
evaluateEntry
in interface EntryFilter
entry
- the Map Entry to evaluate; never nullpublic int calculateEffectiveness(java.util.Map mapIndexes, java.util.Set setKeys)
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.
calculateEffectiveness
in interface IndexAwareFilter
mapIndexes
- the available MapIndex
objects keyed by the related ValueExtractor; read-onlysetKeys
- the set of keys that will be filtered; read-onlypublic Filter applyIndex(java.util.Map mapIndexes, java.util.Set setKeys)
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.
applyIndex
in interface IndexAwareFilter
mapIndexes
- the available MapIndex
objects keyed by the related ValueExtractor; read-onlysetKeys
- the mutable set of keys that remain to be filteredFilter
object (which may be an EntryFilter
) that can be used to process the remaining keys, or null if no additional filter processing is necessarypublic Filter getFilter()
public void ensureConverted(Converter converter)
This method must be called prior to index application or evaluation when the keys being evaluated exist in an internal form.
Note: for convenience, this method will be automatically called by the partitioned cache service when this filter appears as the outermost filter in a query.
converter
- the converter that should be used for key conversionspublic java.lang.String toString()
public void readExternal(java.io.DataInput in) throws java.io.IOException
readExternal
in interface ExternalizableLite
in
- the DataInput stream to read data from in order to restore the state of this objectjava.io.IOException
- if an I/O exception occursjava.io.NotActiveException
- if the object is not in its initial state, and therefore cannot be deserialized intopublic void writeExternal(java.io.DataOutput out) throws java.io.IOException
writeExternal
in interface ExternalizableLite
out
- the DataOutput stream to write the state of this object tojava.io.IOException
- if an I/O exception occurspublic void readExternal(PofReader in) throws java.io.IOException
readExternal
in interface PortableObject
in
- the PofReader from which to read the object's statejava.io.IOException
- if an I/O error occurspublic void writeExternal(PofWriter out) throws java.io.IOException
writeExternal
in interface PortableObject
out
- the PofWriter to which to write the object's statejava.io.IOException
- if an I/O error occurs
|
Oracle® Coherence Java API Reference Release 3.7.1.0 E22843-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |