|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents the topic map association construct.
Method Summary | |
AssociationRole |
createAssociationRole(Topic player,
Topic type)
Creates a new AssociationRole representing a role in this association. |
java.util.Set |
getAssociationRoles()
Returns the AssociationRole objects representing all of the roles in this association. |
Topic |
getReifier()
Returns the Topic that reifies this association. |
Topic |
getType()
Returns the topic which defines the type of the association. |
void |
remove()
Removes this Association from the collection of Associations managed by the parent TopicMap. |
void |
setType(Topic type)
Sets the topic which defines the type of the association. |
Methods inherited from interface org.tmapi.core.ScopedObject |
addScopingTopic, getScope, removeScopingTopic |
Methods inherited from interface org.tmapi.core.TopicMapObject |
addSourceLocator, equals, getObjectId, getSourceLocators, getTopicMap, hashCode, removeSourceLocator |
Method Detail |
public void setType(Topic type)
type
- The topic specifying the new type of the association,
or null
to set the association to be untyped.public Topic getType()
null
if the association is untyped.public AssociationRole createAssociationRole(Topic player, Topic type)
player
- The topic playing the role or null
if there is no
player of this role.type
- The topic defining the role of the new AssociationRole,
or null
if the role is untyped.
public java.util.Set getAssociationRoles()
null
.
public Topic getReifier()
null
if the association is not reified.public void remove() throws TMAPIException
remove
in interface TopicMapObject
TMAPIException
- if the object cannot be removed from the container. Derived
interfaces may define specific circumstances under which a subclass of TMAPIException
must be raised.
Implementations MUST NOT use a TMAPIException to
wrap a failure raised in the underlying engine - such errors must always be wrapped in a
TMAPIRuntimeException.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |