net.ontopia.topicmaps.impl.basic
Class Association

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

All Implemented Interfaces:

java.io.Serializable, AssociationIF, ReifiableIF, ScopedIF, TMObjectIF, TypedIF

Direct Known Subclasses:

DynamicAssociation

public class Association
extends TMObject
implements AssociationIF

INTERNAL: The basic association implementation.

See Also:

Serialized Form

Field Summary

protected TopicIF	reifier
protected java.util.Set<AssociationRoleIF>	roles
protected UniqueSet<TopicIF>	scope
protected TopicIF	type

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

MSG_NULL_ARGUMENT, sources

Constructor Summary

protected

Association(TopicMap tm)

Method Summary

void	addTheme(TopicIF theme) PUBLIC: Add a topic to this scope.
TopicIF	getReifier() PUBLIC: Returns the topic that reifies this object.
java.util.Collection<AssociationRoleIF>	getRoles() PUBLIC: Gets all the association roles of the association.
java.util.Collection<AssociationRoleIF>	getRolesByType(TopicIF roletype) PUBLIC: Gets the association roles in this association which are of the given role type.
java.util.Collection<TopicIF>	getRoleTypes() PUBLIC: Gets a Collection of association role types found in this association.
java.util.Collection<TopicIF>	getScope() PUBLIC: Returns the set of topics that are the stated scope of this object.
TopicIF	getType() PUBLIC: Gets the type that this object is an instance of.
void	remove() PUBLIC: Removes the object from its parent.
void	removeTheme(TopicIF theme) PUBLIC: Remove a topic from this scope.
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.
java.lang.String	toString()

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

addItemIdentifier, fireEvent, getItemIdentifiers, getObjectId, getTopicMap, isConnected, 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

scope

protected UniqueSet<TopicIF> scope

roles

protected java.util.Set<AssociationRoleIF> roles

Constructor Detail

Association

protected Association(TopicMap tm)

Method Detail

getRoleTypes

public java.util.Collection<TopicIF> getRoleTypes()

Description copied from interface: AssociationIF

PUBLIC: Gets a Collection of association role types found in this association. The returned collection does not contain any duplicates. Even if some roles have no type, null will not be returned as one of the role types in the returned set.

Specified by:

getRoleTypes in interface AssociationIF

Returns:

A Collection of TopicIF objects.

getRolesByType

public java.util.Collection<AssociationRoleIF> getRolesByType(TopicIF roletype)

Description copied from interface: AssociationIF

PUBLIC: Gets the association roles in this association which are of the given role type.

Specified by:

getRolesByType in interface AssociationIF

Parameters:

roletype - The type of the roles returned; an object implementing TopicIF. If null the method will return the roles that have no type.

Returns:

A Collection of AssociationRoleIF objects.

getRoles

public java.util.Collection<AssociationRoleIF> getRoles()

Description copied from interface: AssociationIF

PUBLIC: Gets all the association roles of the association. The returned roles may appear in any order.

Specified by:

getRoles in interface AssociationIF

Returns:

A collection of AssociationRoleIF objects.

remove

public void remove()

Description copied from interface: TMObjectIF

PUBLIC: Removes the object from its parent.

Specified by:

remove in interface TMObjectIF

getScope

public java.util.Collection<TopicIF> getScope()

Description copied from interface: ScopedIF

PUBLIC: Returns the set of topics that are the stated scope of this object. Scoping topics inherited from parent objects are not included. There is no guarantee as to which order these topics are returned in.

Specified by:

getScope in interface ScopedIF

Returns:

A collection of TopicIF objects.

addTheme

public void addTheme(TopicIF theme)

Description copied from interface: ScopedIF

PUBLIC: Add a topic to this scope. (A topic used in a scope is also called a theme.) If the topic is already part of the scope the method call has no effect.

Specified by:

addTheme in interface ScopedIF

Parameters:

theme - A topic to be added to this scope; an object implementing TopicIF.

removeTheme

public void removeTheme(TopicIF theme)

Description copied from interface: ScopedIF

PUBLIC: Remove a topic from this scope. If the topic is not already in the scope this method has no effect. (A topic used in a scope is also called a theme.)

Specified by:

removeTheme in interface ScopedIF

Parameters:

theme - A topic to be removed from this scope; an object implementing TopicIF.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object