com.ibm.websphere.objectgrid.plugins.io.datadescriptor
Interface MapDataDescriptor

All Superinterfaces:

Destroyable, Initializable

public interface MapDataDescriptor
extends Initializable, Destroyable

MapSerializerPlugin plug-ins create a MapDataDescriptor using the DataDescriptorFactory to expose any relationships that it wants to expose to the eXtreme Scale runtime.

Since:

7.1.1

Field Summary

static String

DEFAULT_ADDRESSABLEKEYNAME The default name used to identify the key for APIs that refer to maps.

Method Summary

String	getAddressableKeyName() Retrieves the addressable attribute name to use for accessing KeyDataSerializer data when using partial key lookups such as a query.
Map<String,Association>	getAssociations() Returns the associations between this map and another map.
void	setAddressableKeyName(String addressableKeyName) Identify the addressable attribute name to use for accessing KeyDataSerialier data when using partial key lookups such as a query.
void	setAssociations(Map<String,Association> associations) Identifies any associations between this map and another map.

Methods inherited from interface com.ibm.websphere.objectgrid.plugins.Initializable

initialize, isInitialized

Methods inherited from interface com.ibm.websphere.objectgrid.plugins.Destroyable

destroy, isDestroyed

Field Detail

DEFAULT_ADDRESSABLEKEYNAME

static final String DEFAULT_ADDRESSABLEKEYNAME

The default name used to identify the key for APIs that refer to maps.

See Also:

Constant Field Values

Method Detail

getAddressableKeyName

String getAddressableKeyName()

Retrieves the addressable attribute name to use for accessing KeyDataSerializer data when using partial key lookups such as a query.

Returns:

the attribute name to use to identify the key, this value is required and must not be null.

setAddressableKeyName

void setAddressableKeyName(String addressableKeyName)

Identify the addressable attribute name to use for accessing KeyDataSerialier data when using partial key lookups such as a query. If the addressable name cannot exists in associated ValueDataDescriptor, the key will have priority.

Parameters:

addressableKeyName - the attribute name to use to identify the key, this value is required and must not be null.

Throws:

IllegalStateException - if the descriptor has been initialized.

getAssociations

Map<String,Association> getAssociations()

Returns the associations between this map and another map. Each association identifies a relationship between two maps using a foreign key.

If associations are part of an embedded attribute, then the association is represented as a series of Associated types with embedded Associated types.

Example: A one-to-one association to the grandchildkey:

 parent/child/grandchildkey
 

Becomes:

 OneToOne(name=parent, type=Embedded, tgtMap=GrandChildMap, EmbeddedType=   <--- Path Association
   OneToOne(name=child, type=Embedded, tgtMap=GrandChildMap, EmbeddedType=  <--- Path Association
     OneToOne(name=grandchildkey, tgtMap=GrandChildMap, type=EmbeddedType=  <--- The Actual Association Key
       OneToOne(name=id, type=INT32))))
 

If the MapDataDescriptor has been initialized, the Map will be read-only.

Returns:

the map of Associations

setAssociations

void setAssociations(Map<String,Association> associations)

Identifies any associations between this map and another map. Each association identifies a relationship between two maps using a foreign key.

Parameters:

associations - a Map of association names to the Association definition, or null if no associations are defined.

Throws:

IllegalStateException - if the descriptor has been initialized.