Inherits Object, IndexAwareFilter, and PortableObject.
List of all members.
|InKeySetFilter Handle definition.|
|InKeySetFilter View definition.|
|InKeySetFilter 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||readExternal (PofReader::Handle hIn)|
|virtual void||writeExternal (PofWriter::Handle hOut) const|
|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 Filter::View||getFilter () const|
|Obtain the Filter.|
|virtual void||ensureConverted (Converter::View vConverter)|
|Ensure that the underlying keys are converted using the specified converter.|
Protected Member Functions
|Default constructor (necessary for the PortableObject interface).|
|InKeySetFilter (Filter::View vFilter, Set::View vSetKeys)|
|Construct an InSetFilter for testing "In" condition.|
|virtual void ensureConverted||(||Converter::View||vConverter||)||
Ensure that the underlying keys are converted using the specified converter.
This method must be called prior to index application or evaluation when the keys being evaluated exist in an internal form.
|vConverter||the converter that should be used for key conversions|