hydra

Class RegionDescription

java.lang.Object

hydra.AbstractDescription

hydra.RegionDescription

All Implemented Interfaces:

java.io.Serializable

public class RegionDescription
extends AbstractDescription
implements java.io.Serializable

Encodes information needed to describe and create a region.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RegionDescription()

Method Summary

Modifier and Type	Method and Description
void	configure(com.gemstone.gemfire.cache.AttributesFactory f, boolean instantiate) Configures the attributes factory using this region description.
protected void	configure(java.lang.String regionName, com.gemstone.gemfire.cache.AttributesFactory f, boolean instantiate) Configures the attributes factory using this region description.
protected static void	configure(TestConfig config) Creates region descriptions from the region parameters in the test configuration.
java.util.List<AsyncEventQueueDescription>	getAsyncEventQueueDescriptions() Returns the async event queue descriptions.
java.util.List<java.lang.String>	getAsyncEventQueueNames() Returns the async event queue names.
com.gemstone.gemfire.cache.CacheWriter	getCacheWriterInstance(boolean instantiate) Returns a cache writer instance.
com.gemstone.gemfire.cache.DataPolicy	getDataPolicy() Returns the data policy.
DiskStoreDescription	getDiskStoreDescription() Returns the disk store description.
java.lang.String	getDiskStoreName() Returns the disk store description name.
com.gemstone.gemfire.cache.EvictionAttributes	getEvictionAttributes() Returns the eviction attributes.
java.util.List<GatewaySenderDescription>	getGatewaySenderDescriptions() Returns the gateway sender descriptions.
java.util.List<java.lang.String>	getGatewaySenderNames() Returns the gateway sender names.
HDFSStoreDescription	getHDFSStoreDescription() Returns the HDFS store description.
java.lang.String	getHDFSStoreName() Returns the HDFS store description name.
java.lang.String	getName() Returns the logical name of this region description.
PartitionDescription	getPartitionDescription() Returns the partition description.
PoolDescription	getPoolDescription() Returns the pool description.
java.lang.String	getRegionName() Returns the actual name of this region.
protected static java.lang.String	regionAttributesToString(com.gemstone.gemfire.cache.RegionAttributes r) Returns the region attributes as a string.
protected static java.lang.String	regionAttributesToStringPartial(com.gemstone.gemfire.cache.RegionAttributes r) Returns the partial region attributes as a string.
java.util.SortedMap	toSortedMap() Returns a sorted map of description fields and their values.

Methods inherited from class hydra.AbstractDescription

addProperties, asList, convertPrm, convertPrmDefault, getBooleanFor, getClass, getClassname, getInstance, getIntegerFor, getNonnegativeIntegerFor, getParametersAndDefaults, getPath, getSSLDescription, loadClass, parseMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RegionDescription

public RegionDescription()

Method Detail

getName

public java.lang.String getName()

Returns the logical name of this region description.

getAsyncEventQueueDescriptions

public java.util.List<AsyncEventQueueDescription> getAsyncEventQueueDescriptions()

Returns the async event queue descriptions.

getAsyncEventQueueNames

public java.util.List<java.lang.String> getAsyncEventQueueNames()

Returns the async event queue names.

getDataPolicy

public com.gemstone.gemfire.cache.DataPolicy getDataPolicy()

Returns the data policy.

getDiskStoreName

public java.lang.String getDiskStoreName()

Returns the disk store description name.

getDiskStoreDescription

public DiskStoreDescription getDiskStoreDescription()

Returns the disk store description.

getEvictionAttributes

public com.gemstone.gemfire.cache.EvictionAttributes getEvictionAttributes()

Returns the eviction attributes.

getGatewaySenderDescriptions

public java.util.List<GatewaySenderDescription> getGatewaySenderDescriptions()

Returns the gateway sender descriptions.

getGatewaySenderNames

public java.util.List<java.lang.String> getGatewaySenderNames()

Returns the gateway sender names.

getHDFSStoreName

public java.lang.String getHDFSStoreName()

Returns the HDFS store description name.

getHDFSStoreDescription

public HDFSStoreDescription getHDFSStoreDescription()

Returns the HDFS store description.

getPartitionDescription

public PartitionDescription getPartitionDescription()

Returns the partition description.

getPoolDescription

public PoolDescription getPoolDescription()

Returns the pool description.

getRegionName

public java.lang.String getRegionName()

Returns the actual name of this region.

configure

public void configure(com.gemstone.gemfire.cache.AttributesFactory f,
                      boolean instantiate)

Configures the attributes factory using this region description. Has the option to skip instantiating cache listeners, loaders, and writers when creating dummy regions to generate cache XML files. Passes the default region name to the fixed partition attributes mapping algorithm, if any.

configure

protected void configure(java.lang.String regionName,
                         com.gemstone.gemfire.cache.AttributesFactory f,
                         boolean instantiate)

Configures the attributes factory using this region description. Has the option to skip instantiating cache listeners, loaders, and writers when creating dummy regions to generate cache XML files. Passes the region name, if any, to the fixed partition attributes mapping algorithm, if any.

regionAttributesToString

protected static java.lang.String regionAttributesToString(com.gemstone.gemfire.cache.RegionAttributes r)

Returns the region attributes as a string. For use only by RegionHelper.regionAttributesToString(RegionAttributes).

regionAttributesToStringPartial

protected static java.lang.String regionAttributesToStringPartial(com.gemstone.gemfire.cache.RegionAttributes r)

Returns the partial region attributes as a string. Omits possibly HDFS side-effected attributes. For use only by #regionAttributesToString(RegionAttributes).

toSortedMap

public java.util.SortedMap toSortedMap()

Description copied from class: AbstractDescription

Returns a sorted map of description fields and their values.

Specified by:

toSortedMap in class AbstractDescription

configure

protected static void configure(TestConfig config)

Creates region descriptions from the region parameters in the test configuration.

getCacheWriterInstance

public com.gemstone.gemfire.cache.CacheWriter getCacheWriterInstance(boolean instantiate)

Returns a cache writer instance.

Manages singletons if instantiate is true, which means that this is a real runtime instance rather than a test configuration instance.

This method is public to support DynamicRegionFactory configuration only.