Skip navigation links

com.tangosol.coherence.config.scheme
Class BackingMapScheme

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.BackingMapScheme

All Implemented Interfaces:

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

public class BackingMapScheme

extends AbstractLocalCachingScheme

The BackingMapScheme class is responsible for building a fully configured instance of a backing map.

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

Field Summary

static int	CUSTOM A custom backup storage.
static int	FILE_MAPPED A file mapped backup storage.
static int	FLASHJOURNAL A Flash Journal backup storage.
static int	OFF_HEAP An off-heap backup storage.
static int	ON_HEAP An on-heap backup storage.
static int	RAMJOURNAL A Ram Journal backup storage.
static int	SCHEME A referenced scheme provides backup storage.

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

m_serviceDependencies

Constructor Summary

BackingMapScheme()

Method Summary

CachingScheme	getInnerScheme() Return the inner scheme.
boolean	isPartitioned(com.tangosol.config.expression.ParameterResolver resolver, boolean fDefault) Return true if the partitioned flag is set explicitly or a journal map is used.
boolean	isTransient(com.tangosol.config.expression.ParameterResolver resolver) Return true if the backing map is transient.
java.util.Map	realizeMap(com.tangosol.config.expression.ParameterResolver resolver, MapBuilder.Dependencies dependencies) Realize a Map based on the state of the MapBuilder, resolvable parameters and provided MapBuilder.Dependencies.
void	setInnerScheme(CachingScheme scheme) Set the inner scheme.
void	setPartitioned(com.tangosol.config.expression.Expression expr) Set the partitioned string.
void	setTransient(com.tangosol.config.expression.Expression expr) Set the transient flag.
protected void	validate(com.tangosol.config.expression.ParameterResolver resolver) Validate the properties.

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

establishMapListeners, getDefaultParameterResolver, getListenerBuilder, realizeBackingMapManager, realizeCache, setListenerBuilder

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

getScopedServiceName, getScopedServiceName, getScopeName, getServiceBuilder, getServiceDependencies, getServiceName, getXml, injectScopeNameIntoService, isAutoStart, realizeService, setAutoStart, setScopeName, setServiceDependencies, setServiceName, setXml

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

getSchemeName, isAnonymous, setSchemeName, validate

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

getScopedServiceName, getScopedServiceName, getServiceBuilder, getServiceName, isAutoStart

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

getSchemeName, isAnonymous

Field Detail

ON_HEAP

public static final int ON_HEAP

An on-heap backup storage.

See Also:

Constant Field Values

OFF_HEAP

public static final int OFF_HEAP

An off-heap backup storage.

See Also:

Constant Field Values

FILE_MAPPED

public static final int FILE_MAPPED

A file mapped backup storage.

See Also:

Constant Field Values

CUSTOM

public static final int CUSTOM

A custom backup storage.

See Also:

Constant Field Values

SCHEME

public static final int SCHEME

A referenced scheme provides backup storage.

See Also:

Constant Field Values

FLASHJOURNAL

public static final int FLASHJOURNAL

A Flash Journal backup storage.

See Also:

Constant Field Values

RAMJOURNAL

public static final int RAMJOURNAL

A Ram Journal backup storage.

See Also:

Constant Field Values

Constructor Detail

BackingMapScheme

public BackingMapScheme()

Method Detail

realizeMap

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

Realize a Map based on the state of the MapBuilder, resolvable parameters and provided MapBuilder.Dependencies.

Specified by:

realizeMap in interface MapBuilder

Overrides:

realizeMap in class AbstractCachingScheme

Parameters:

resolver - the ParameterResolver

dependencies - the MapBuilder.Dependencies for realizing the Map

Returns:

a Map

getInnerScheme

public CachingScheme getInnerScheme()

Return the inner scheme.

Returns:

the inner scheme

setInnerScheme

public void setInnerScheme(CachingScheme scheme)

Set the inner scheme.

Parameters:

scheme - the inner scheme

setPartitioned

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

Set the partitioned string.

Parameters:

expr - the Boolean expression set to 'true' or 'observable' if the backing map is partitioned

isPartitioned

public boolean isPartitioned(com.tangosol.config.expression.ParameterResolver resolver,
                             boolean fDefault)

Return true if the partitioned flag is set explicitly or a journal map is used.

Parameters:

resolver - the ParameterResolver

fDefault - the default partitioned flag

Returns:

true if the map is partitioned

isTransient

public boolean isTransient(com.tangosol.config.expression.ParameterResolver resolver)

Return true if the backing map is transient.

Parameters:

resolver - the ParameterResolver

Returns:

true if the backing map is transient

setTransient

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

Set the transient flag.

Parameters:

expr - true to make the backing map transient.

validate

protected void validate(com.tangosol.config.expression.ParameterResolver resolver)

Validate the properties.

Overrides:

validate in class AbstractCachingScheme

Parameters:

resolver - the ParameterResolver needed to resolve expressions

Skip navigation links