public class KeyFilter<T> extends Base implements Filter<T>, EntryFilter<Object,T>, IndexAwareFilter<Object,T>
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 the
InFilter as follows:
new InFilter(new KeyExtractor(IdentityExtractor.INSTANCE), setKeys);
Base.LoggingWriter, Base.StackFrame| Modifier and Type | Field and Description |
|---|---|
protected Set |
m_setKeys
The keys that are evaluated to true by this filter.
|
| Constructor and Description |
|---|
KeyFilter(Set<T> setKeys)
Construct a key filter.
|
| Modifier and Type | Method and Description |
|---|---|
Filter |
applyIndex(Map mapIndexes,
Set setKeys)
Filter remaining keys using a Map of available indexes.
|
int |
calculateEffectiveness(Map mapIndexes,
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(Object o)
Apply the test to the input argument.
|
boolean |
evaluateEntry(Map.Entry entry)
Apply the test to a Map Entry.
|
Set |
getKeys()
Get the set of keys that are evaluated to true by this filter.
|
String |
toString()
Return a human-readable description for this Filter.
|
azzert, azzert, azzert, azzertFailed, breakLines, breakLines, capitalize, checkNotEmpty, checkNotNull, checkRange, computeSafeWaitTime, decimalValue, dup, dup, ensureBigDecimal, ensureClassLoader, ensureRuntimeException, ensureRuntimeException, equals, equalsDeep, err, err, err, err, err, escape, formatDateTime, getCallerStackFrame, getCommonMonitor, getCommonMonitor, getCommonMonitor, getContextClassLoader, getContextClassLoader, getDeepMessage, getErr, getLastSafeTimeMillis, getLog, getMaxDecDigits, getMaxHexDigits, getOriginalException, getOut, getProcessRandom, getRandom, getRandomBinary, getRandomBinary, getRandomString, getSafeTimeMillis, getStackFrame, getStackFrames, getStackTrace, getStackTrace, getThreadFactory, getTimeZone, getUpTimeMillis, hashCode, hexValue, indentString, indentString, isDecimal, isHex, isLogEcho, isOctal, log, log, log, log, log, makeInteger, makeLong, makeThread, mod, mod, octalValue, out, out, out, out, out, pad, parseBandwidth, parseBandwidth, parseDelimitedString, parseHex, parseHex, parseMemorySize, parseMemorySize, parsePercentage, parseTime, parseTime, parseTimeNanos, parseTimeNanos, printStackTrace, randomize, randomize, randomize, randomize, read, read, read, read, read, read, read, replace, setErr, setLog, setLogEcho, setOut, sleep, toBandwidthString, toBandwidthString, toCharEscape, toCrc, toCrc, toCrc, toCrc, toCrc, toDecString, toDelimitedString, toDelimitedString, toDelimitedString, toDelimitedString, toHex, toHex, toHexDump, toHexEscape, toHexEscape, toHexEscape, toHexEscape, toHexString, toMemorySizeString, toMemorySizeString, toQuotedCharEscape, toQuotedStringEscape, toSqlString, toString, toString, toStringEscape, toUnicodeEscape, trace, trace, trace, trace, trace, trace, trace, trace, trace, truncateString, truncateString, waitclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitand, asLimitFilter, associatedWith, forKeys, forPartitions, or, xorprotected Set m_setKeys
public boolean evaluate(Object o)
public boolean evaluateEntry(Map.Entry entry)
evaluateEntry in interface EntryFilter<Object,T>entry - the Map Entry to evaluate; never nullpublic int calculateEffectiveness(Map mapIndexes, 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<Object,T>mapIndexes - the available MapIndex objects keyed by the
related ValueExtractor; read-onlysetKeys - the set of keys that will be filtered; read-onlypublic Filter applyIndex(Map mapIndexes, 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<Object,T>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 Set getKeys()