Oracle Coherence for C++ API
Release 3.7.1.0
E22845-01

coherence::util::filter::ArrayFilter

ArrayFilter Class Reference

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

Inherits Object, IndexAwareFilter, and PortableObject.

Inherited by AllFilter, AnyFilter, and XorFilter.

List of all members.

Detailed Description

Filter which is a logical operator of a filter array.

Author:
djl 2008.03.23
 

Public Types
typedef spec::Handle  Handle
  ArrayFilter Handle definition.
typedef spec::View  View
  ArrayFilter View definition.
typedef spec::Holder  Holder
  ArrayFilter Holder definition.

Public Member Functions
virtual void  readExternal (PofReader::Handle hIn)
   
virtual void  writeExternal (PofWriter::Handle hOut) const
   
virtual bool  equals (Object::View v) const
  Compare the ArrayFilter 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.

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);
Parameters:
  out  the stream used to output the description
virtual ObjectArray::View  getFilters () const
  Obtain the Filter array.

Protected Member Functions
  ArrayFilter ()
  Default constructor (necessary for the PortableObject interface).
  ArrayFilter (ObjectArray::View vaFilter)
  Construct a logical filter that applies a binary operator to a filter array.
virtual ObjectArray::View  calculateFilters (Map::View vMapIndexes, Set::View vSetKeys) const
  Calculate the effectiveness and sort all the participating filters according to their effectiveness.
virtual Filter::View  applyFilter (IndexAwareFilter::View vFilter, Map::View vMapIndexes, Set::Handle hSetKeys) const
  Apply the specified IndexAwareFilter to the specified keySet.

Protected Attributes
MemberView< ObjectArray >  m_vaFilter
  The Filter array.

Classes
class   WeightedFilter
  A thin wrapper around a Filter allowing for sorting the filters according to their effectiveness. More...

Constructor & Destructor Documentation

ArrayFilter ( ObjectArray::View  vaFilter  )  [protected]

Construct a logical filter that applies a binary operator to a filter array.

The result is defined as: vaFilter[0] <op> vaFilter[1] ... <op> vaFilter[n]

Parameters:
  vaFilter  the filter array

Member Function Documentation

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

Compare the ArrayFilter with another object to determine equality.

Two ArrayFilter objects are considered equal iff they belong to the same class and their underlying Filter arrays are deep-equal.

Returns:
true iff this ArrayFilter and the passed object are equivalent

virtual ObjectArray::View getFilters (    )  const [virtual]

Obtain the Filter array.

Returns:
the Filter array

virtual ObjectArray::View calculateFilters ( Map::View  vMapIndexes,
    Set::View  vSetKeys  
  )     const [protected, virtual]

Calculate the effectiveness and sort all the participating filters according to their effectiveness.

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:
the array of WeightedFilter objects sorted by the effectiveness (the most effective in the front)

virtual Filter::View applyFilter ( IndexAwareFilter::View  vFilter,
    Map::View  vMapIndexes,
    Set::Handle  hSetKeys  
  )     const [protected, virtual]

Apply the specified IndexAwareFilter to the specified keySet.

Parameters:
  vFilter  the IndexAwareFilter to apply an index to
  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 that can be used to process the remaining keys, or null if no additional filter processing is necessary

The documentation for this class was generated from the following file:

Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.