systems.dmx.core

Interface Association

Show UML class diagram

All Superinterfaces:

DMXObject, Identifiable, JSONEnabled

All Known Subinterfaces:

AssociationDefinition, RelatedAssociation

All Known Implementing Classes:

AssociationDefinitionImpl, AssociationImpl, RelatedAssociationImpl

public interface Association
extends DMXObject

### FIXDOC: Specification of an association -- A n-ary connection between topics and other associations.

Author:

Jörg Richter

Method Summary

Modifier and Type	Method and Description
AssociationModel	getModel()
long	getOtherPlayerId(long id)
RelatedObject	getPlayer(String roleTypeUri)
DMXObject	getPlayer1()
DMXObject	getPlayer2()
Role	getRole(RoleModel roleModel) ### TODO: rethink this method Returns this association's role which refers to the same object as the given role model.
Role	getRole(String roleTypeUri)
Role	getRole1()
Role	getRole2()
Topic	getTopicByType(String topicTypeUri) ### TODO: make it work for assoc players as well or drop it
boolean	hasSameRoleTypeUris()
boolean	isPlayer(TopicRoleModel roleModel) ### TODO: drop it
Association	loadChildTopics()
Association	loadChildTopics(String assocDefUri)
boolean	matches(String roleTypeUri1, long playerId1, String roleTypeUri2, long playerId2) Checks if the given players match this association.
void	update(AssociationModel model)

Methods inherited from interface systems.dmx.core.DMXObject

delete, getAssociation, getAssociations, getChildTopics, getDatabaseVendorObject, getId, getProperty, getRelatedAssociation, getRelatedAssociations, getRelatedTopic, getRelatedTopics, getRelatedTopics, getRelatedTopics, getSimpleValue, getType, getTypeUri, getUri, hasProperty, removeProperty, setChildTopics, setProperty, setSimpleValue, setSimpleValue, setSimpleValue, setSimpleValue, setSimpleValue, setTypeUri, setUri, updateChildTopics

Methods inherited from interface systems.dmx.core.JSONEnabled

toJSON

Method Detail

getRole1

Role getRole1()

getRole2

Role getRole2()

getPlayer1

DMXObject getPlayer1()

getPlayer2

DMXObject getPlayer2()

getRole

Role getRole(String roleTypeUri)

Returns:

this association's role that matches the given role type. If no role matches, null is returned. If both roles are matching an exception is thrown.

hasSameRoleTypeUris

boolean hasSameRoleTypeUris()

matches

boolean matches(String roleTypeUri1,
                long playerId1,
                String roleTypeUri2,
                long playerId2)

Checks if the given players match this association. The given role type URIs must be different. The player position ("1" vs. "2") is not relevant.

Returns:

true if the given players match this association.

Throws:

IllegalArgumentException - if both given role type URIs are identical.

getOtherPlayerId

long getOtherPlayerId(long id)

getPlayer

RelatedObject getPlayer(String roleTypeUri)

Returns:

this association's player which plays the given role. If there is no such player, null is returned.

If there are 2 such players an exception is thrown.

getTopicByType

Topic getTopicByType(String topicTypeUri)

### TODO: make it work for assoc players as well or drop it

Returns:

this association's topic which has the given type. If there is no such topic, null is returned.

If there are 2 such topics an exception is thrown.

getRole

Role getRole(RoleModel roleModel)

### TODO: rethink this method Returns this association's role which refers to the same object as the given role model. The role returned is found by comparing topic IDs, topic URIs, or association IDs. The role types are not compared.

If the object refered by the given role model is not a player in this association an exception is thrown.

isPlayer

boolean isPlayer(TopicRoleModel roleModel)

### TODO: drop it

update

void update(AssociationModel model)

loadChildTopics

Association loadChildTopics()

Specified by:

loadChildTopics in interface DMXObject

loadChildTopics

Association loadChildTopics(String assocDefUri)

Specified by:

loadChildTopics in interface DMXObject

getModel

AssociationModel getModel()

Specified by:

getModel in interface DMXObject