net.ontopia.topicmaps.impl.remote
Class DynamicAssociationRole

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

All Implemented Interfaces:

java.io.Serializable, AssociationRoleIF, ReifiableIF, TMObjectIF, TypedIF

public class DynamicAssociationRole
extends AssociationRole

INTERNAL: PRIVATE:

See Also:

Serialized Form

Field Summary

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

player, reifier, type

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

MSG_NULL_ARGUMENT, sources

Constructor Summary

DynamicAssociationRole(TopicMap tm)

Method Summary

void	addItemIdentifier(LocatorIF source_locator) PUBLIC: Adds the given item identifier to the set of item item identifiers for this object.
boolean	equals(DynamicAssociationRole obj)
boolean	equals(java.lang.Object obj)
AssociationIF	getAssociation() PUBLIC: Gets the association to which this association role belongs.
java.util.Collection	getItemIdentifiers() PUBLIC: Gets the item identifiers of this object.
java.lang.String	getObjectId() PUBLIC: Gets the id of this object.
TopicIF	getPlayer() PUBLIC: Gets the topic that plays this association role (this member of the association).
TopicMapIF	getTopicMap() PUBLIC: Gets the topic map that this object belongs to.
TopicIF	getType() PUBLIC: Gets the type that this object is an instance of.
int	hashCode()
boolean	isConnected()
boolean	isReadOnly() PUBLIC: Returns true if this object is read-only, otherwise false.
void	removeItemIdentifier(LocatorIF source_locator) PUBLIC: Removes the given item identifier from the set of item identifiers.
void	setPlayer(TopicIF player) PUBLIC: Sets the topic that plays this association role.
void	setTarget(AssociationRole aRole)
void	setType(TopicIF type) PUBLIC: Sets the type that this object is an instance of.
java.lang.String	toString()

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

fireEvent, getReifier, remove, setReifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DynamicAssociationRole

public DynamicAssociationRole(TopicMap tm)

Parameters:

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

Overrides:

getAssociation in class AssociationRole

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

Overrides:

getPlayer in class AssociationRole

Returns:

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

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

Overrides:

getType in class AssociationRole

Returns:

The type of this object; an object implementing TopicIF.

isConnected

public boolean isConnected()

Overrides:

isConnected in class AssociationRole

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

Overrides:

setPlayer in class AssociationRole

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.

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

Overrides:

setType in class AssociationRole

Parameters:

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

setTarget

public void setTarget(AssociationRole aRole)

toString

public java.lang.String toString()

Overrides:

toString in class AssociationRole

addItemIdentifier

public void addItemIdentifier(LocatorIF source_locator)
                       throws ConstraintViolationException

Description copied from interface: TMObjectIF

PUBLIC: Adds the given item identifier to the set of item item identifiers for this object.

Specified by:

addItemIdentifier in interface TMObjectIF

Overrides:

addItemIdentifier in class TMObject

Parameters:

source_locator - The item identifier to be added; an object implementing LocatorIF.

Throws:

ConstraintViolationException - Thrown if another object in the same topic map already has the given item identifier.

getObjectId

public java.lang.String getObjectId()

Description copied from interface: TMObjectIF

PUBLIC: Gets the id of this object. The object id is part of the topic map id space, and must be unique. The object id is not significant (or unique) outside the current topic map. The object id is immutable. The object id is thus stable through this object's lifetime.

Specified by:

getObjectId in interface TMObjectIF

Overrides:

getObjectId in class TMObject

Returns:

string which is this object's id.

getItemIdentifiers

public java.util.Collection getItemIdentifiers()

Description copied from interface: TMObjectIF

PUBLIC: Gets the item identifiers of this object. These locators are pointers back to the locations from where this object originated.

The purpose is to enable the engine to detect when references to external objects refer to objects that are already present within the system, such as topic maps which are already loaded.

Specified by:

getItemIdentifiers in interface TMObjectIF

Overrides:

getItemIdentifiers in class TMObject

Returns:

A collection of LocatorIF objects addressing the item.

getTopicMap

public TopicMapIF getTopicMap()

Description copied from interface: TMObjectIF

PUBLIC: Gets the topic map that this object belongs to. If the object has been removed from its topic map or not added to a topic map yet this will be null.

Specified by:

getTopicMap in interface TMObjectIF

Overrides:

getTopicMap in class TMObject

Returns:

A topic map; an object implementing TopicMapIF.

isReadOnly

public boolean isReadOnly()

Description copied from interface: TMObjectIF

PUBLIC: Returns true if this object is read-only, otherwise false.

Specified by:

isReadOnly in interface TMObjectIF

Overrides:

isReadOnly in class TMObject

Returns:

read-only (true) or not read-only (false).

removeItemIdentifier

public void removeItemIdentifier(LocatorIF source_locator)

Description copied from interface: TMObjectIF

PUBLIC: Removes the given item identifier from the set of item identifiers. If this object does not have the given item identifier the call has no effect.

Specified by:

removeItemIdentifier in interface TMObjectIF

Overrides:

removeItemIdentifier in class TMObject

Parameters:

source_locator - The item identifier to be removed; an object implementing LocatorIF.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(DynamicAssociationRole obj)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object