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

public interface Association

An association between two maps. Associations are set on the MapDataDescriptor. Use the DataDescriptorFactory.createAssociation() methods to create an Association instance.

Since:

7.1.1

See Also:

MapDataDescriptor

Method Summary

String	getAttributeName() Retrieves the name of the attribute.
String	getTargetMapName() Retrieves name of the associated map.
void	setAttributeName(String attributeName) Sets the name of the attribute.
void	setTargetMapName(String mapName) The name of the associated map.

Method Detail

getAttributeName

String getAttributeName()

Retrieves the name of the attribute.

Returns:

the name of the attribute or null if not yet set.

setAttributeName

void setAttributeName(String attributeName)

Sets the name of the attribute.

Attributes names must include letters, digits and the underscore '_' character. Spaces and special characters are not permitted.

Parameters:

attributeName - the name of the attribute. Must not be null.

Throws:

IllegalStateException - if the attribute has been initialized.

getTargetMapName

String getTargetMapName()

Retrieves name of the associated map.

Returns:

the name of the associated map.

setTargetMapName

void setTargetMapName(String mapName)

The name of the associated map.

Parameters:

mapName - the name of the associated map.

Throws:

IllegalStateException - if the association has been initialized.