Inherits Object, and IndexAwareFilter.
List of all members.
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);
|KeyFilter Handle definition. |
|KeyFilter View definition. |
|KeyFilter Holder definition. |
Public Member Functions
|virtual bool||evaluateEntry (Map::Entry::View vEntry) const|
|Apply the test to a Map::Entry.|
|virtual bool||evaluate (Object::View v) const|
|Apply the test to the object.|
|virtual size32_t||calculateEffectiveness (Map::View vMapIndexes, Set::View vSetKeys) const|
|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
|virtual Filter::View||applyIndex (Map::View vMapIndexes, Set::Handle hSetKeys) const|
|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.
|virtual void||toStream (std::ostream &out) const|
|Output a human-readable description of this Object to the given stream.|
coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents.
Object::View vKey = ... Object::View vValue = ... std::cout << vKey << " = " << vValue << std::endl; String::Handle hs = COH_TO_STRING(vKey << " = " << vValue);
|virtual Set::View||getKeys () const|
|Get the set of keys that are evaluated to true by this filter. |
Protected Member Functions
|KeyFilter (Set::View vSetKeys)|
|Construct a key filter. |
|FinalView< Set >||f_vSetKeys|
|The keys that are evaluated to true by this filter. |
|virtual Set::View getKeys||(||)|| const
Get the set of keys that are evaluated to true by this filter.