Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

NotFilter Class Reference

#include <coherence/util/filter/NotFilter.hpp>

Inherits Object, IndexAwareFilter, and PortableObject.

List of all members.


Detailed Description

Provide for "pluggable" conditional behavior that negates.

Author:
djl 2008.03.02
 

Public Types

typedef spec::Handle Handle
 NotFilter Handle definition.
typedef spec::View View
 NotFilter View definition.
typedef spec::Holder Holder
 NotFilter Holder definition.

Public Member Functions

virtual bool evaluateEntry (Map::Entry::View vEntry) const
 Apply the test to a Map::Entry and negate the result.
virtual bool evaluate (Object::View v) const
 Apply the test to the object and negate the result.
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 keySet.size() * <evaluation cost> then a user could avoid using the index and iterate through the keySet calling evaluate rather then applyIndex.

Parameters:
 vMapIndexes the available MapIndex objects keyed by the related ValueExtractor; read-only
 vSetKeys the set of keys that will be filtered; read-only
Returns:
an effectiveness estimate of how well this filter can use the specified indexes to filter the specified keys
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.

Parameters:
 vMapIndexes the available MapIndex objects keyed by the related ValueExtractor; read-only
 hSetKeys the mutable set of keys that remain to be filtered
Returns:
a Filter object (which may be an EntryFilter) that can be used to process the remaining keys, or NULL if no additional filter processing is necessary
virtual void readExternal (PofReader::Handle hIn)
 Restore the contents of a user type instance by reading its state using the specified PofReader.
virtual void writeExternal (PofWriter::Handle hOut) const
 Save the contents of a POF user type instance by writing its state using the specified PofWriter.
virtual bool equals (Object::View v) const
 Compare the NotFilter with another object to determine equality.
virtual size32_t hashCode () const
 Return a hash code value for the Object.

This method is supported for the benefit of hash-based containers.

The general contract of hashCode is:

  • Whenever it is invoked on the same Object more than once during an execution of an application, the hashCode method must consistently return the same value, provided no information used in equals comparisons on the object is modified. This value need not remain consistent from one execution of an application to another execution of the same application.
  • If two Objects are equal according to the equals method, then calling the hashCode method on each of the two Objects must produce the same value.
  • It is not required that if two Objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct results. However, the programmer should be aware that producing distinct results for unequal objects may improve the performance of hash-based containers.

The default implementation is identity based.

Returns:
a hash code value for this Object
virtual void toStream (std::ostream &out) const
 Output a human-readable description of this Object to the given stream.
virtual Filter::View getFilter () const
 Obtain the Filter whose results are negated by this filter.

Protected Member Functions

 NotFilter ()
 Default constructor (necessary for the PortableObject interface).
 NotFilter (Filter::View hFilter)
 Create and return a Handle to a new Object instance.
virtual Map::View getNonPartialIndexes (Map::View vMapIndexes) const
 Get a Map of the available non-partial indexes from the given Map of all available indexes.

Member Function Documentation

virtual bool evaluateEntry ( Map::Entry::View  vEntry  )  const [virtual]

Apply the test to a Map::Entry and negate the result.

Parameters:
 vEntry the Map::Entry to evaluate; never NULL
Returns:
false if the test passes, true otherwise

Implements EntryFilter.

virtual bool evaluate ( Object::View  v  )  const [virtual]

Apply the test to the object and negate the result.

Parameters:
 v the object to test
Returns:
true if the test passes, false otherwise

Implements Filter.

virtual Map::View getNonPartialIndexes ( Map::View  vMapIndexes  )  const [protected, virtual]

Get a Map of the available non-partial indexes from the given Map of all available indexes.

Parameters:
 vMapIndexes the available MapIndex objects keyed by the related ValueExtractor; read-only
Returns:
a Map of the available non-partial MapIndex objects

virtual void readExternal ( PofReader::Handle  hIn  )  [virtual]

Restore the contents of a user type instance by reading its state using the specified PofReader.

Parameters:
 hIn the PofReader from which to read the object's state

virtual void writeExternal ( PofWriter::Handle  hOut  )  const [virtual]

Save the contents of a POF user type instance by writing its state using the specified PofWriter.

Parameters:
 hOut the PofWriter to which to write the object's state

virtual bool equals ( Object::View  v  )  const [virtual]

Compare the NotFilter with another object to determine equality.

Parameters:
 v the object to compare with
Returns:
true iff this NotFilter and the passed object are equivalent NotFilter objects

virtual void toStream ( std::ostream &  out  )  const [virtual]

Output a human-readable description of this Object to the given stream.

Parameters:
 out the stream used to output the description

Reimplemented from Object.

virtual Filter::View getFilter (  )  const [virtual]

Obtain the Filter whose results are negated by this filter.

Returns:
the filter whose results are negated by this filter


The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.