Oracle Coherence for C++ API
Release 3.6.1.0

E18813-01

ConverterCollections::ConverterInvocableMap Class Reference

#include <coherence/util/ConverterCollections.hpp>

Inherits ConverterCollections::ConverterMap, and InvocableMap.

List of all members.


Detailed Description

A ConverterInvocable views an underlying InvocableMap through a set of key and value Converters.

Public Types

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

Public Member Functions

virtual Object::Holder  invoke (Object::View vKey, InvocableMap::EntryProcessor::Handle hAgent)
  Invoke the passed EntryProcessor against the Entry specified by the passed key, returning the result of the invocation.
Parameters:
vKey  the key to process; it is not required to exist within the Map
hAgent  the EntryProcessor to use to process the specified key
Returns:
the result of the invocation as returned from the EntryProcessor

virtual Map::View  invokeAll (Collection::View vCollKeys, InvocableMap::EntryProcessor::Handle hAgent)
  Invoke the passed EntryProcessor against the entries specified by the passed keys, returning the result of the invocation for each.
Parameters:
vCollKeys  the keys to process; these keys are not required to exist within the Map
hAgent  the EntryProcessor to use to process the specified keys
Returns:
a Map containing the results of invoking the EntryProcessor against each of the specified keys

virtual Map::View  invokeAll (Filter::View vFilter, InvocableMap::EntryProcessor::Handle hAgent)
  Invoke the passed EntryProcessor against the entries specified by the passed keys, returning the result of the invocation for each.
Parameters:
vCollKeys  the keys to process; these keys are not required to exist within the Map
hAgent  the EntryProcessor to use to process the specified keys
Returns:
a Map containing the results of invoking the EntryProcessor against each of the specified keys

virtual Object::Holder  aggregate (Collection::View vCollKeys, InvocableMap::EntryAggregator::Handle hAgent) const
  Perform an aggregating operation against the entries specified by the passed keys.
Parameters:
vCollKeys  the Collection of keys that specify the entries within this Map to aggregate across
hAgent  the EntryAggregator that is used to aggregate across the specified entries of this Map
Returns:
the result of the aggregation

virtual Object::Holder  aggregate (Filter::View vFilter, InvocableMap::EntryAggregator::Handle hAgent) const
  Perform an aggregating operation against the entries specified by the passed keys.
Parameters:
vCollKeys  the Collection of keys that specify the entries within this Map to aggregate across
hAgent  the EntryAggregator that is used to aggregate across the specified entries of this Map
Returns:
the result of the aggregation

virtual
InvocableMap::View 
getInvocableMap () const
  Return the underlying InvocableMap.
virtual
InvocableMap::Handle 
getInvocableMap ()
  Return the underlying CacheMap.

Protected Member Functions

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

Constructor & Destructor Documentation

ConverterInvocableMap ( InvocableMap::Handle  hMapDelegate,
EntryConverter::View  vConvUp,
EntryConverter::View  vConvDown  
) [protected]

Create a ConverterInvocableMap which delegates to the s pecified InvocableMap.

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

ConverterInvocableMap ( InvocableMap::View  vMapDelegate,
EntryConverter::View  vConvUp,
EntryConverter::View  vConvDown  
) [protected]

Create a ConverterInvocableMap which delegates to the s pecified InvocableMap.

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

Member Function Documentation

virtual InvocableMap::View getInvocableMap (  )  const [virtual]

Return the underlying InvocableMap.

Returns:
the underlying InvocableMap

virtual InvocableMap::Handle getInvocableMap (  )  [virtual]

Return the underlying CacheMap.

Returns:
the underlying CacheMap

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