Skip navigation links

com.tangosol.coherence.config.scheme
Class NearScheme

java.lang.Object
com.tangosol.coherence.config.scheme.AbstractScheme
com.tangosol.coherence.config.scheme.AbstractServiceScheme
com.tangosol.coherence.config.scheme.AbstractCachingScheme
com.tangosol.coherence.config.scheme.AbstractLocalCachingScheme
com.tangosol.coherence.config.scheme.AbstractCompositeScheme
com.tangosol.coherence.config.scheme.NearScheme

All Implemented Interfaces:

BackingMapManagerBuilder, BuilderCustomization, MapBuilder, NamedCacheBuilder, ServiceBuilder, CachingScheme, ObservableCachingScheme, Scheme, ServiceScheme

public class NearScheme

extends AbstractCompositeScheme

implements NamedCacheBuilder

The NearScheme is used to realize (create) an instance of a NearCache.

Since:

Coherence 12.1.2

Author:

pfm 2011.11.30

Nested Class Summary

Nested classes/interfaces inherited from interface com.tangosol.coherence.config.builder.MapBuilder

MapBuilder.Dependencies

Constructor Summary

NearScheme()

Method Summary

void	establishMapListeners(java.util.Map map, com.tangosol.config.expression.ParameterResolver resolver, MapBuilder.Dependencies dependencies) Establishes an appropriate MapListener (provided by the ObservableCachingScheme.getListenerBuilder()) on the ObservableMap that was produced by the ObservableCachingScheme.
java.lang.String	getInvalidationStrategy(com.tangosol.config.expression.ParameterResolver resolver) Return the invalidation strategy.
ServiceBuilder	getServiceBuilder() Return the ServiceBuilder that is needed to build a service.
NamedCache	realizeCache(com.tangosol.config.expression.ParameterResolver resolver, MapBuilder.Dependencies dependencies) Realizes a NamedCache (possibly "ensuring it") based on the state of the builder, the provided ParameterResolver and MapBuilder dependencies.
void	setInvalidationStrategy(com.tangosol.config.expression.Expression expr) Set the invalidation strategy.

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractCompositeScheme

getBackScheme, getFrontScheme, setBackScheme, setFrontScheme, validate

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractLocalCachingScheme

getCustomBuilder, getEventInterceptorBuilders, getServiceType, isRunningClusterNeeded, setCustomBuilder

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractCachingScheme

getDefaultParameterResolver, getListenerBuilder, realizeBackingMapManager, realizeMap, setListenerBuilder

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractServiceScheme

getScopedServiceName, getScopedServiceName, getScopeName, getServiceName, getXml, injectScopeNameIntoService, isAutoStart, realizeService, setAutoStart, setScopeName, setServiceName, setXml, validate

Methods inherited from class com.tangosol.coherence.config.scheme.AbstractScheme

getSchemeName, isAnonymous, setSchemeName

Methods inherited from interface com.tangosol.coherence.config.scheme.ServiceScheme

getScopedServiceName, getScopedServiceName, getServiceName, isAutoStart

Methods inherited from interface com.tangosol.coherence.config.scheme.Scheme

getSchemeName, isAnonymous

Constructor Detail

NearScheme

public NearScheme()

Method Detail

getServiceBuilder

public ServiceBuilder getServiceBuilder()

Return the ServiceBuilder that is needed to build a service.

Specified by:

getServiceBuilder in interface ServiceScheme

Overrides:

getServiceBuilder in class AbstractServiceScheme

Returns:

the ServiceBuilder or null if the scheme does not support services.

realizeCache

public NamedCache realizeCache(com.tangosol.config.expression.ParameterResolver resolver,
                               MapBuilder.Dependencies dependencies)

Realizes a NamedCache (possibly "ensuring it") based on the state of the builder, the provided ParameterResolver and MapBuilder dependencies.

The MapBuilder dependencies are required to satisfy the requirement when realizing a NamedCache additionally involves realizing one or more internal Maps.

Specified by:

realizeCache in interface NamedCacheBuilder

Overrides:

realizeCache in class AbstractCachingScheme

Parameters:

resolver - the ParameterResolver

dependencies - the MapBuilder dependencies

Returns:

a NamedCache

establishMapListeners

public void establishMapListeners(java.util.Map map,
                                  com.tangosol.config.expression.ParameterResolver resolver,
                                  MapBuilder.Dependencies dependencies)

Establishes an appropriate MapListener (provided by the ObservableCachingScheme.getListenerBuilder()) on the ObservableMap that was produced by the ObservableCachingScheme.

This method will automatically inject the following types and named values into realized classes that have been annotated with @Injectable.

• BackingMapManagerContext (optionally named "manager-context")
• ConfigurableCacheFactory
• Cache Name (as a String.class named "cache-name")
• Context ClassLoader (optionally named "class-loader")
• ResourceRegistry
• CacheConfig
• together with any other resource, named or otherwise, available in the ResourceRegistry provided by the ConfigurableCacheFactory.

  Specified by:

  establishMapListeners in interface ObservableCachingScheme

  Overrides:

  establishMapListeners in class AbstractCachingScheme

  Parameters:

  map - an ObservableMap to which to add a MapListener (if the map is not observable, no listeners are added)

  resolver - the ParameterResolver to use for resolving builder parameters

  dependencies - the MapBuilder dependencies from which to obtain builder information

  See Also:

  Injectable

  getInvalidationStrategy

  public java.lang.String getInvalidationStrategy(com.tangosol.config.expression.ParameterResolver resolver)
  

  Return the invalidation strategy.

  Parameters:

  resolver - the ParameterResolver

  Returns:

  the invalidation strategy

  setInvalidationStrategy

  @Injectable
  public void setInvalidationStrategy(com.tangosol.config.expression.Expression expr)
  

  Set the invalidation strategy.

  Parameters:

  expr - the invalidation strategy