org.wandora.topicmap

Interface Association

All Known Implementing Classes:

AssociationImpl, DatabaseAssociation, DatabaseAssociation, LayeredAssociation, LinkedAssociation, QueryAssociation, RemoteAssociation, T2WAssociation, UndoAssociation, WebServiceAssociation

public interface Association

Author:

olli

Method Summary

Modifier and Type	Method and Description
void	addPlayer(Topic player, Topic role) Sets the player with the specified role replacing previous player with that role if it exists already.
void	addPlayers(java.util.Map<Topic,Topic> players) Adds players to the association.
Topic	getPlayer(Topic role) Gets the player with the specified role.
java.util.Collection<Topic>	getRoles() Gets a Collection of Topics containing the roles of this association.
TopicMap	getTopicMap() Gets the topic map this association belongs to.
Topic	getType() Gets the type of this association.
boolean	isRemoved() Tests if this association has been removed and thus this object is now invalid.
void	remove() Removes this association.
void	removePlayer(Topic role) Removes the player with the specified role.
void	setType(Topic t) Sets the type of this association replacing the previous type.

Method Detail

getType

Topic getType()
       throws TopicMapException

Gets the type of this association.

Throws:

TopicMapException

setType

void setType(Topic t)
      throws TopicMapException

Sets the type of this association replacing the previous type.

Throws:

TopicMapException

getPlayer

Topic getPlayer(Topic role)
         throws TopicMapException

Gets the player with the specified role.

Throws:

TopicMapException

addPlayer

void addPlayer(Topic player,
               Topic role)
        throws TopicMapException

Sets the player with the specified role replacing previous player with that role if it exists already.

Throws:

TopicMapException

addPlayers

void addPlayers(java.util.Map<Topic,Topic> players)
         throws TopicMapException

Adds players to the association. Players are given in a map which maps roles to players.

Throws:

TopicMapException

removePlayer

void removePlayer(Topic role)
           throws TopicMapException

Removes the player with the specified role.

Throws:

TopicMapException

getRoles

java.util.Collection<Topic> getRoles()
                              throws TopicMapException

Gets a Collection of Topics containing the roles of this association.

Throws:

TopicMapException

getTopicMap

TopicMap getTopicMap()

Gets the topic map this association belongs to.

remove

void remove()
     throws TopicMapException

Removes this association.

Throws:

TopicMapException

isRemoved

boolean isRemoved()
           throws TopicMapException

Tests if this association has been removed and thus this object is now invalid.

Throws:

TopicMapException