Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

ConverterCollections::ConverterQueryMap Class Reference

#include <coherence/util/ConverterCollections.hpp>

Inherits ConverterCollections::ConverterMap, and QueryMap.

List of all members.


Detailed Description

A Converter QueryMap views an underlying QueryMap through a set of key and value Converters.
 

Public Types

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

Public Member Functions

virtual Set::View keySet (Filter::View vFilter) const
 Return a set of the keys contained in this map for entries that satisfy the criteria expressed by the filter.

Unlike the Map#keySet() method, the set returned by this method may not be backed by the map, so changes to the set may not reflected in the map, and vice-versa.

Parameters:
 vFilter the Filter object representing the criteria that the entries of this map should satisfy
Returns:
a set of keys for entries that satisfy the specified criteria
virtual Set::View entrySet (Filter::View vFilter) const
 Return a set of the entries contained in this map that satisfy the criteria expressed by the filter.

Each element in the returned set is a Map::Entry.

Unlike the Map::entrySet() method, the set returned by this method may not be backed by the map, so changes to the set may not be reflected in the map, and vice-versa.

Parameters:
 vFilter the Filter object representing the criteria that the entries of this map should satisfy
Returns:
a set of entries that satisfy the specified criteria
virtual Set::View entrySet (Filter::View vFilter, Comparator::View vComparator) const
 Return a set of the entries contained in this map that satisfy the criteria expressed by the filter.

Each element in the returned set is a Map::Entry. It is further guaranteed that its iterator will traverse the set in such a way that the entry values come up in ascending order, sorted by the specified Comparator or according to the natural ordering (see Comparable).

Unlike the Map::entrySet() method, the set returned by this method may not be backed by the map, so changes to the set may not be reflected in the map, and vice-versa.

Parameters:
 vFilter the Filter object representing the criteria that the entries of this map should satisfy
 vComparator the Comparator object which imposes an ordering on entries in the resulting set; or NULL if the entries' values natural ordering should be used
Returns:
a set of entries that satisfy the specified criteria
virtual void addIndex (ValueExtractor::View vExtractor, bool fOrdered, Comparator::View vComparator)
 Add an index to this QueryMap.

This allows to correlate values stored in this indexed Map (or attributes of those values) to the corresponding keys in the indexed Map and increase the performance of keySet and entrySet methods.

This method is only intended as a hint to the cache implementation, and as such it may be ignored by the cache if indexes are not supported or if the desired index (or a similar index) already exists. It is expected that an application will call this method to suggest an index even if the index may already exist, just so that the application is certain that index has been suggested. For example in a distributed environment, each server will likely suggest the same set of indexes when it starts, and there is no downside to the application blindly requesting those indexes regardless of whether another server has already requested the same indexes.

Parameters:
 vExtractor the ValueExtractor object that is used to extract an indexable Object from a value stored in the indexed Map. Must not be NULL.
 fOrdered true iff the contents of the indexed information should be ordered; false otherwise
 vComparator the Comparator object which imposes an ordering on entries in the indexed map; or NULL if the entries' values natural ordering should be used
virtual void removeIndex (ValueExtractor::View vExtractor)
 Remove an index from this QueryMap.

Parameters:
 vExtractor the ValueExtractor object that is used to extract an indexable Object from a value stored in the Map
virtual QueryMap::View getQueryMap () const
 Return the underlying InvocableMap.
virtual QueryMap::Handle getQueryMap ()
 Return the underlying CacheMap.

Protected Member Functions

 ConverterQueryMap (QueryMap::Handle hMapDelegate, EntryConverter::View vConvUp, EntryConverter::View vConvDown)
 Create a ConverterQueryMap which delegates to the specified QueryMap.
 ConverterQueryMap (QueryMap::View vMapDelegate, EntryConverter::View vConvUp, EntryConverter::View vConvDown)
 Create a ConverterQueryMap which delegates to the s pecified QueryMap.

Constructor & Destructor Documentation

ConverterQueryMap ( QueryMap::Handle  hMapDelegate,
    EntryConverter::View  vConvUp,
    EntryConverter::View  vConvDown 
  )    [protected]

Create a ConverterQueryMap which delegates to the specified QueryMap.

Parameters:
 hMap the specified InvocableMap
 vConvUp the EntryConverter from the underlying Map
 vConvDown the EntryConverter to the underlying Map

ConverterQueryMap ( QueryMap::View  vMapDelegate,
    EntryConverter::View  vConvUp,
    EntryConverter::View  vConvDown 
  )    [protected]

Create a ConverterQueryMap which delegates to the s pecified QueryMap.

Parameters:
 vMap the specified InvocableMap
 vConvUp the EntryConverter from the underlying Map
 vConvDown the EntryConverter to the underlying Map


Member Function Documentation

virtual QueryMap::View getQueryMap (  )  const [virtual]

Return the underlying InvocableMap.

Returns:
the underlying InvocableMap

virtual QueryMap::Handle getQueryMap (  )  [virtual]

Return the underlying CacheMap.

Returns:
the underlying CacheMap


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