|
Oracle® Coherence Java API Reference Release 3.6.1.0 E18814-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.filter.KeyFilter
public class KeyFilter
EntryFilter which checks whether an entry key belongs to a set.
Note: this filter is not serializable and intended to be used only internally by other composite filters to reduce the remaining key set.
As of Coherence 3.2, an equivalent functionality could be achieved using theInFilter
as follows:
new InFilter(new KeyExtractor(IdentityExtractor.INSTANCE), setKeys);
Field Summary | |
---|---|
protected java.util.Set |
m_setKeys The keys that are evaluated to true by this filter. |
Constructor Summary | |
---|---|
KeyFilter(java.util.Set setKeys) Construct a key filter. |
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. |
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. |
java.util.Set |
getKeys() Get the set of keys that are evaluated to true by this filter. |
java.lang.String |
toString() Return a human-readable description for this Filter. |
Field Detail |
---|
protected java.util.Set m_setKeys
Constructor Detail |
---|
public KeyFilter(java.util.Set setKeys)
setKeys
- the keys that this filter will evaluate to trueMethod 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)
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)
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 java.util.Set getKeys()
public java.lang.String toString()
|
Oracle® Coherence Java API Reference Release 3.6.1.0 E18814-01 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |