Class ReadOnlyAssociationRole

    • Constructor Detail

      • ReadOnlyAssociationRole

        public ReadOnlyAssociationRole()
    • Method Detail

      • getClassIndicator

        public String getClassIndicator()
        Description copied from class: ReadOnlyTMObject
        INTERNAL: Returns the token that can be used to indicate the class of this instance. This indicator is currently only used by item identifiers.
        Specified by:
        getClassIndicator in class ReadOnlyTMObject
      • getObjectId

        public 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
        Specified by:
        getObjectId in class ReadOnlyTMObject
        Returns:
        string which is this object's id.
      • 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.
      • 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.
      • setReifier

        public void setReifier​(TopicIF reifier)
        Description copied from interface: ReifiableIF
        PUBLIC: Sets the reifier of this object.
        Specified by:
        setReifier in interface ReifiableIF