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

E77779-01

ConverterCollections::ConverterNamedCache Class Reference

#include <coherence/util/ConverterCollections.hpp>

Inherits ConverterCollections::ConverterCacheMap, and NamedCache.

List of all members.


Detailed Description

A ConverterNamedCache views an underlying NamedCache through a set of key and value Converters.

Public Types

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

Public Member Functions

virtual String::View getCacheName () const
 Return the cache name.
virtual
CacheService::Handle 
getCacheService ()
 Return the CacheService that this NamedCache is a part of.
virtual
CacheService::View 
getCacheService () const
 Return the CacheService that this NamedCache is a part of.
virtual bool isActive () const
 Specifies whether or not the NamedCache is active.
virtual void release ()
 Release local resources associated with this instance of NamedCache.
virtual void destroy ()
 Release and destroy this instance of NamedCache.
virtual bool lock (Object::View vKey, int64_t cWait) const
 
virtual bool lock (Object::View vKey) const
 
virtual bool unlock (Object::View vKey) const
 
virtual Object::Holder invoke (Object::View vKey, InvocableMap::EntryProcessor::Handle hAgent)
 
virtual Map::View invokeAll (Collection::View vCollKeys, InvocableMap::EntryProcessor::Handle hAgent)
 
virtual Map::View invokeAll (Filter::View vFilter, InvocableMap::EntryProcessor::Handle hAgent)
 
virtual Object::Holder aggregate (Collection::View vCollKeys, InvocableMap::EntryAggregator::Handle hAgent) const
 
virtual Object::Holder aggregate (Filter::View vFilter, InvocableMap::EntryAggregator::Handle hAgent) const
 
virtual Set::View keySet (Filter::View vFilter) const
 
virtual Set::View entrySet (Filter::View vFilter) const
 
virtual Set::View entrySet (Filter::View vFilter, Comparator::View vComparator) const
 
virtual void addIndex (ValueExtractor::View vExtractor, bool fOrdered, Comparator::View vComparator)
 
virtual void removeIndex (ValueExtractor::View vExtractor)
 
virtual NamedCache::View getNamedCache () const
 Return the underlying InvocableMap.
virtual
NamedCache::Handle 
getNamedCache ()
 Return the underlying CacheMap.
virtual
ConcurrentMap::View 
getConcurrentMap () const
 Return the underlying ConcurrentMap.
virtual
ConcurrentMap::Handle 
getConcurrentMap ()
 Return the underlying ConcurrentMap.
virtual
InvocableMap::View 
getInvocableMap () const
 Return the underlying InvocableMap.
virtual
InvocableMap::Handle 
getInvocableMap ()
 Return the underlying InvocableMap.
virtual QueryMap::View getQueryMap () const
 Return the underlying QueryMap.
virtual QueryMap::Handle getQueryMap ()
 Return the underlying QueryMap.

Protected Member Functions

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

Protected Attributes

FinalHolder
< ConverterConcurrentMap
f_ohMapConcurrent
 A Converter ConcurrentMap around the underlying NamedCache.
FinalHolder
< ConverterInvocableMap
f_ohMapInvocable
 A Converter InvocableMap around the underlying NamedCache.
FinalHolder
< ConverterQueryMap
f_ohMapQuery
 A Converter QueryMap around the underlying NamedCache.

Constructor & Destructor Documentation

ConverterNamedCache ( NamedCache::Handle  hMapDelegate,
EntryConverter::View  vConvUp,
EntryConverter::View  vConvDown 
) [protected]

Create a ConverterQueryMap which delegates to the s pecified QueryMap.

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

ConverterNamedCache ( NamedCache::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 String::View getCacheName (  )  const [virtual]

Return the cache name.

Returns:
the cache name

Implements NamedCache.

virtual CacheService::Handle getCacheService (  )  [virtual]

Return the CacheService that this NamedCache is a part of.

Returns:
the CacheService

Implements NamedCache.

virtual CacheService::View getCacheService (  )  const [virtual]

Return the CacheService that this NamedCache is a part of.

Returns:
the CacheService

Implements NamedCache.

virtual bool isActive (  )  const [virtual]

Specifies whether or not the NamedCache is active.

Returns:
true if the NamedCache is active; false otherwise

Implements NamedCache.

virtual void release (  )  [virtual]

Release local resources associated with this instance of NamedCache.

Releasing a cache makes it no longer usable, but does not affect the cache itself. In other words, all other references to the cache will still be valid, and the cache data is not affected by releasing the reference. Any attempt to use this reference afterword will result in an exception.

See also:
CacheService::releaseCache

Implements NamedCache.

virtual void destroy (  )  [virtual]

Release and destroy this instance of NamedCache.

Warning: This method is used to completely destroy the specified cache across the cluster. All references in the entire cluster to this cache will be invalidated, the cached data will be cleared, and all resources will be released.

See also:
CacheService::destroyCache

Implements NamedCache.

virtual NamedCache::View getNamedCache (  )  const [virtual]

Return the underlying InvocableMap.

Returns:
the underlying InvocableMap

virtual NamedCache::Handle getNamedCache (  )  [virtual]

Return the underlying CacheMap.

Returns:
the underlying CacheMap

virtual ConcurrentMap::View getConcurrentMap (  )  const [virtual]

Return the underlying ConcurrentMap.

Returns:
the underlying ConcurrentMap

virtual ConcurrentMap::Handle getConcurrentMap (  )  [virtual]

Return the underlying ConcurrentMap.

Returns:
the underlying ConcurrentMap

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

Return the underlying InvocableMap.

Returns:
the underlying InvocableMap

virtual InvocableMap::Handle getInvocableMap (  )  [virtual]

Return the underlying InvocableMap.

Returns:
the underlying InvocableMap

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

Return the underlying QueryMap.

Returns:
the underlying QueryMap

virtual QueryMap::Handle getQueryMap (  )  [virtual]

Return the underlying QueryMap.

Returns:
the underlying QueryMap


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