Oracle Coherence for C++ API
Release 3.6.1.0

E18813-01

DefaultConfigurableCacheFactory::CacheInfo Class Reference

#include <coherence/net/DefaultConfigurableCacheFactory.hpp>

Inherits Object.

List of all members.


Detailed Description

CacheInfo is a placeholder for cache attributes retrieved during parsing the corresponding cache mapping element.

Public Types

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

Public Member Functions

virtual String::View  getCacheName () const
  Obtain the cache name.
virtual String::View  getSchemeName () const
  Obtain the scheme name.
virtual Map::View  getAttributes () const
  Obtain the attribute map.
virtual void  replaceAttributes (XmlElement::Handle hXml) const
  Find and replace the attributes names in "{}" format with the corresponding values for this cache info.
virtual CacheInfo::Handle  getSyntheticInfo (String::View vsSuffix) const
  Generate a synthetic CacheInfo for a cache that has a name suffixed with the specified string.

Protected Member Functions

  CacheInfo (String::View vsCacheName, String::View vsSchemeName, Map::View vMapAttribute)
  Create a new CacheInfo.

Protected Attributes

FinalView< String m_vsCacheName
  The cache name.
FinalView< String m_vsSchemeName
  The corresponding scheme name.
FinalView< Map m_vMapAttribute
  Map of scheme attributes.

Constructor & Destructor Documentation

CacheInfo ( String::View  vsCacheName,
String::View  vsSchemeName,
Map::View  vMapAttribute  
) [protected]

Create a new CacheInfo.

Parameters:
vsCacheName  the cache name
vsSchemeName  the corresponding scheme name
vMapAttribute  the corresponding map of attributes

Member Function Documentation

virtual String::View getCacheName (  )  const [virtual]

Obtain the cache name.

Returns:
the cache name

virtual String::View getSchemeName (  )  const [virtual]

Obtain the scheme name.

Returns:
the scheme name

virtual Map::View getAttributes (  )  const [virtual]

Obtain the attribute map.

Returns:
the attribute map

virtual void replaceAttributes ( XmlElement::Handle  hXml  )  const [virtual]

Find and replace the attributes names in "{}" format with the corresponding values for this cache info.

Note: the content of the specified XmlElement could be modified, so the caller is supposed to clone the passed in XML if necessary.

Parameters:
hXml  the XmlElement to replace "{}" attributes at

virtual CacheInfo::Handle getSyntheticInfo ( String::View  vsSuffix  )  const [virtual]

Generate a synthetic CacheInfo for a cache that has a name suffixed with the specified string.

Parameters:
vsSuffix  the cache name suffix
Returns:
the "cloned" synthetic CacheInfo

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