Oracle® Fusion Middleware C++ API Reference for Oracle Coherence
12c (12.2.1.1.0)

E69640-01

InKeySetFilter Class Reference

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

List of all members.


Detailed Description

Filter that limits the underlying filter evaluation only to the specified set of keys.

Author:
djl 2008.04.14

Public Types

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

Public Member Functions

virtual bool evaluateEntry (Map::Entry::View vEntry) const
 
virtual bool evaluate (Object::View v) const
 
virtual size32_t calculateEffectiveness (Map::View vMapIndexes, Set::View vSetKeys) const
 
virtual Filter::View applyIndex (Map::View vMapIndexes, Set::Handle hSetKeys) const
 
virtual void readExternal (PofReader::Handle hIn)
 
virtual void writeExternal (PofWriter::Handle hOut) const
 
virtual TypedHandle
< const String > 
toString () const
 
virtual Filter::View getFilter () const
 Obtain the Filter.
virtual Set::View getKeys () const
 Obtain the underying key set.
virtual void ensureConverted (Converter::View vConverter) const
 Ensure that the underlying keys are converted using the specified converter.

Protected Member Functions

 InKeySetFilter ()
 Default constructor (necessary for the PortableObject interface).
 InKeySetFilter (Filter::View vFilter, Set::View vSetKeys)
 Construct an InSetFilter for testing "In" condition.

Constructor & Destructor Documentation

InKeySetFilter ( Filter::View  vFilter,
Set::View  vSetKeys 
) [protected]

Construct an InSetFilter for testing "In" condition.

Parameters:
vFilter the underlying filter
vSetKeys the set of keys to limit the filter evaluation to


Member Function Documentation

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

Obtain the Filter.

Returns:
the Filter

virtual Set::View getKeys (  )  const [virtual]

Obtain the underying key set.

Returns:
the underlying key set
Since:
12.2.1

virtual void ensureConverted ( Converter::View  vConverter  )  const [virtual]

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.

Note: for convenience, this method will be automatically called by the partitioned cache service when this filter appears as the outermost filter in a query.

Parameters:
vConverter the converter that should be used for key conversions


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