com.gemstone.gemfire.cache
Interface PartitionAttributes

public interface PartitionAttributes

Attributes that define the partitioned character of a Partitioned Region. This interface allows for the discovery of Partitioned Region attributes using RegionAttributes.getPartitionAttributes() as well as the configuration of a Partitioned Region using AttributesFactory.setPartitionAttributes(PartitionAttributes). PartitionAttributes are created using the PartitionAttributesFactory The default PartitionAttributes can be determined using PartitionAttributesFactory.create() with out calling any of its mutator methods e.g. PartitionAttributesFactory.setLocalMaxMemory(int) Also see DataPolicy.PARTITION.

Since:

5.0

Method Summary

CacheLoader	getCacheLoader() Deprecated. RegionAttributes.getCacheLoader() should be used, along with the corresponding AttributesFactory.setCacheLoader(com.gemstone.gemfire.cache.CacheLoader) method for establishing the cache loader
Properties	getGlobalProperties() Deprecated. use getTotalMaxMemory() and getTotalNumBuckets() in GemFire 5.1 and later releases
int	getLocalMaxMemory() This method returns the maximum amount of local memory that can be used by the Region.
Properties	getLocalProperties() Deprecated. use getLocalMaxMemory() in GemFire 5.1 and later releases
int	getRedundantCopies() The number of Backups for an entry in PartitionedRegion.
long	getTotalMaxMemory() This method returns the maximum total size of the region, in megabytes
int	getTotalNumBuckets() This method returns total number of buckets for a PartitionedRegion.
long	getTotalSize() Deprecated. use getTotalMaxMemory() instead

Method Detail

getCacheLoader

CacheLoader getCacheLoader()

Deprecated. RegionAttributes.getCacheLoader() should be used, along with the corresponding AttributesFactory.setCacheLoader(com.gemstone.gemfire.cache.CacheLoader) method for establishing the cache loader

returns cacheLoader for the PartitionedRegion (PR).

Returns:

cacheLoader.

getRedundantCopies

int getRedundantCopies()

The number of Backups for an entry in PartitionedRegion. This value should be between 0 and 3 (for a total of 1 to 4 instances of the data)

Returns:

redundantCopies.

getTotalSize

long getTotalSize()

Deprecated. use getTotalMaxMemory() instead

This method returns the maximum total size of the region in megabytes.

Returns:

total size in megabytes.

getTotalMaxMemory

long getTotalMaxMemory()

This method returns the maximum total size of the region, in megabytes

Returns:

maximum size of the partitioned region, in megabytes

getTotalNumBuckets

int getTotalNumBuckets()

This method returns total number of buckets for a PartitionedRegion.

Returns:

total number of buckets for a PartitionedRegion.

getLocalMaxMemory

int getLocalMaxMemory()

This method returns the maximum amount of local memory that can be used by the Region.

getLocalProperties

Properties getLocalProperties()

Deprecated. use getLocalMaxMemory() in GemFire 5.1 and later releases

This method returns local properties. There are currently no local properties defined that are not also deprecated.

Returns:

localProperties

getGlobalProperties

Properties getGlobalProperties()

Deprecated. use getTotalMaxMemory() and getTotalNumBuckets() in GemFire 5.1 and later releases

This method returns global properties. There are currently no global properties defined that are not also deprecated.

Returns:

globalProperties