net.ontopia.topicmaps.impl.basic
Class AssociationRole

java.lang.Object
  net.ontopia.topicmaps.impl.basic.TMObject
      net.ontopia.topicmaps.impl.basic.AssociationRole

All Implemented Interfaces:

Serializable, AssociationRoleIF, ReifiableIF, TMObjectIF, TypedIF

Direct Known Subclasses:

DynamicAssociationRole

public class AssociationRole
extends TMObject
implements AssociationRoleIF

INTERNAL: The basic association role implementation.

See Also:

Serialized Form

Field Summary

protected TopicIF	player
protected TopicIF	reifier
protected TopicIF	type

Fields inherited from class net.ontopia.topicmaps.impl.basic.TMObject

MSG_NULL_ARGUMENT, sources

Fields inherited from interface net.ontopia.topicmaps.core.AssociationRoleIF

EVENT_ADDED, EVENT_REMOVED, EVENT_SET_PLAYER, EVENT_SET_TYPE

Fields inherited from interface net.ontopia.topicmaps.core.ReifiableIF

EVENT_SET_REIFIER

Fields inherited from interface net.ontopia.topicmaps.core.TMObjectIF

EVENT_ADD_ITEMIDENTIFIER, EVENT_REMOVE_ITEMIDENTIFIER

Constructor Summary

protected

AssociationRole(TopicMap tm)

Method Summary

protected void	fireEvent(String event, Object new_value, Object old_value) INTERNAL: Fires an event, so that listeners can be informed about the event.
AssociationIF	getAssociation() PUBLIC: Gets the association to which this association role belongs.
TopicIF	getPlayer() PUBLIC: Gets the topic that plays this association role (this member of the association).
TopicIF	getReifier() PUBLIC: Returns the topic that reifies this object.
TopicIF	getType() PUBLIC: Gets the type that this object is an instance of.
boolean	isConnected()
void	remove() PUBLIC: Removes the object from its parent.
void	setPlayer(TopicIF player) PUBLIC: Sets the topic that plays this association role.
void	setReifier(TopicIF _reifier) PUBLIC: Sets the reifier of this object.
void	setType(TopicIF type) PUBLIC: Sets the type that this object is an instance of.
String	toString()

Methods inherited from class net.ontopia.topicmaps.impl.basic.TMObject

addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, removeItemIdentifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ontopia.topicmaps.core.TMObjectIF

addItemIdentifier, getItemIdentifiers, getObjectId, getTopicMap, isReadOnly, removeItemIdentifier

Field Detail

reifier

protected TopicIF reifier

type

protected TopicIF type

player

protected TopicIF player

Constructor Detail

AssociationRole

protected AssociationRole(TopicMap tm)

Method Detail

getAssociation

public AssociationIF getAssociation()

Description copied from interface: AssociationRoleIF

PUBLIC: Gets the association to which this association role belongs.

Specified by:

getAssociation in interface AssociationRoleIF

Returns:

The association to which this association role belongs; an object implementing AssociationIF.

getPlayer

public TopicIF getPlayer()

Description copied from interface: AssociationRoleIF

PUBLIC: Gets the topic that plays this association role (this member of the association).

Specified by:

getPlayer in interface AssociationRoleIF

Returns:

The topic (member) which plays this role in the association.

setPlayer

public void setPlayer(TopicIF player)

Description copied from interface: AssociationRoleIF

PUBLIC: Sets the topic that plays this association role. Note that this has the side-effect of removing the role from its current player, if any, and inserting it on the new player, if any.

Specified by:

setPlayer in interface AssociationRoleIF

Parameters:

player - The topic (member) which plays this role in the association. Can be null; if null, then the effect is that there is no player of this role in this association.

remove

public void remove()

Description copied from interface: TMObjectIF

PUBLIC: Removes the object from its parent.

Specified by:

remove in interface TMObjectIF

getType

public TopicIF getType()

Description copied from interface: TypedIF

PUBLIC: Gets the type that this object is an instance of.

Specified by:

getType in interface TypedIF

Returns:

The type of this object; an object implementing TopicIF.

setType

public void setType(TopicIF type)

Description copied from interface: TypedIF

PUBLIC: Sets the type that this object is an instance of.

Specified by:

setType in interface TypedIF

Parameters:

type - The type for this object; an object implementing TopicIF.

getReifier

public TopicIF getReifier()

Description copied from interface: ReifiableIF

PUBLIC: Returns the topic that reifies this object.

Specified by:

getReifier in interface ReifiableIF

setReifier

public void setReifier(TopicIF _reifier)

Description copied from interface: ReifiableIF

PUBLIC: Sets the reifier of this object.

Specified by:

setReifier in interface ReifiableIF

fireEvent

protected void fireEvent(String event,
                         Object new_value,
                         Object old_value)

Description copied from class: TMObject

INTERNAL: Fires an event, so that listeners can be informed about the event. This method is typically called when the object id modified.

Overrides:

fireEvent in class TMObject

isConnected

public boolean isConnected()

Overrides:

isConnected in class TMObject

toString

public String toString()

Overrides:

toString in class Object