Docs For Class AssociationRoleInterface

Description

Interface AssociationRoleInterface: Represents the topic map member / role construct (known as association role in HyTM).

Interface AssociationRoleInterface: Represents the topic map member / role construct (known as association role in HyTM). This class represents a normalised association member / role. In normalising the members / roles of an association, one member must be created for each of the role players of the association. For example the following (XTM) association would result in three Member / Role objects.

   <association>
     <member>
       <instanceOf><topicRef xlink:href="#parent"/></instanceOf>
       <topicRef xlink:href="#homer"/>
     </member>
     <member>
       <instanceOf><topicRef xlink:href="#child"/></instanceOf>
       <topicRef xlink:href="#bart"/>
       <topicRef xlink:href="#lisa"/>
     </member>
   </association>

author: Johannes Schmidt, Andreas Stephan - t8d <kontakt@t8d.de>

Located in /org.phptmapi.core/AssociationRole.interface.php (line 26)

TopicMapObjectInterface
   |
   --AssociationRoleInterface

Method Summary

object AssociationInterface getAssociation ()

object TopicInterface getPlayer ()

object TopicInterface getReifier ()

void setPlayer (TopicInterface $player)

void setReifier (object TopicInterface $reifier)

Methods

getAssociation (line 32)

getAssociation: Returns the association to which this association role belongs.

access: public

object AssociationInterface getAssociation ()

getPlayer (line 47)

getPlayer: Returns the player of this association role or null if there is no role player.

access: public

object TopicInterface getPlayer ()

getReifier (line 54)

getReifier: Returns the topic that reifies this association role.

access: public

object TopicInterface getReifier ()

setPlayer (line 40)

setPlayer: Sets the player of this association role.

setPlayer: Sets the player of this association role. $player overwrites any previous value.

access: public

void setPlayer (TopicInterface $player)

object TopicInterface $player: The topic which plays this role in the association, or null if no topic plays this role.

setReifier (line 68)

setReifier: Sets the reifiying topic of this association role.

access: public

throws: ModelConstraintException if the topic already reifies another object.

    public function setReifier($reifier){
        throw new ModelConstraintException('Exception in '.__method__);
    }

void setReifier (object TopicInterface $reifier)

object TopicInterface $reifier: or null if the reifier should be set to null.

Inherited Methods

Inherited From TopicMapObjectInterface

TopicMapObjectInterface::addItemIdentifier()
TopicMapObjectInterface::getItemIdentifiers()
TopicMapObjectInterface::getObjectId()
TopicMapObjectInterface::getParent()
TopicMapObjectInterface::getTopicMap()
TopicMapObjectInterface::remove()
TopicMapObjectInterface::removeItemIdentifier()