Oracle® Fusion Middleware C++ API Reference for Oracle Coherence
12c (12.2.1.4.0)
E90870-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 TypedHandle
< const String > 		toString () const
 Output a human-readable description of this Object to the given stream.

Note that when overriding this method the return type must be TypedHandle<const String> rather then String::View. These two types are assignment compatible but not equivalent and declaring the override with String::View will not be a compatible override.

coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toString 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 and is generally how toString() will be implemented.

 Object::View vKey   = ...
 Object::View vValue = ...
 std::cout << vKey << " = " << vValue << std::endl;

 String::View vs = COH_TO_STRING(vKey << " = " << vValue);

The COH_TO_STRING macro is also the most common way to implement the toString method. For example:

 virtual TypedHandle<const String> Person::toString() const
     {
     return COH_TO_STRING("Name: " << f_sName << " SSN: " << f_nSSN);
     }

Returns:
a string representation of this object

virtual ObjectArray::View getFilters () const
 Obtain the Filter array.
virtual void honorOrder ()
 Ensure that the order of underlying filters is preserved by the applyIndex() and evaluateEntry() implementations.

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 Filter::View applyFilter (IndexAwareFilter::View vFilter, Map::View vMapIndexes, Set::Handle hSetKeys) const
 Apply the specified IndexAwareFilter to the specified keySet.
virtual void optimizeFilterOrder (Map::View vMapIndexes, Set::View vSetKeys) const
 Sort all the participating filters according to their effectiveness.

Protected Attributes

MemberView< ObjectArray > m_vaFilter
 The Filter array.
bool m_fPreserveOrder
 Flag indicating whether or not the filter order should be preserved.

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 void honorOrder (  )  [virtual]

Ensure that the order of underlying filters is preserved by the applyIndex() and evaluateEntry() implementations.

Since:
12.2.1

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

virtual void optimizeFilterOrder ( Map::View  vMapIndexes,
Set::View  vSetKeys 
) const [protected, virtual]

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
Since:
12.2.1

Member Data Documentation

bool m_fPreserveOrder [mutable, protected]

Flag indicating whether or not the filter order should be preserved.

Since:
Coherence 12.2.1

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