Package psidev.psi.mi.jami.model

Interface Participant<I extends Interaction,​F extends Feature>

    • Method Detail

      • setInteractionAndAddParticipant

        void setInteractionAndAddParticipant​(I interaction)
        Sets the Interaction and add the new Participant to its list of Participants. If the given interaction is null, it will remove the Participant from the previous interaction it was attached to
        Parameters:
        interaction - : interaction

      • getInteraction

        I getInteraction()
        The interaction in which the participant is involved. It can be null if the participant is not attached to any interactions. It can happen if the participant has been removed from an interaction and is now invalid.
        Returns:
        the interaction

      • setInteraction

        void setInteraction​(I interaction)
        Sets the interaction.
        Parameters:
        interaction - : interaction

      • getBiologicalRole

        CvTerm getBiologicalRole()
        The biological role of the participant. It is a controlled vocabulary term and cannot be null. It the biological role of a participant is not known or not relevant, the method should return unspecified role (MI:0499) Ex: enzyme, enzyme target, ...
        Returns:
        the biological role

      • setBiologicalRole

        void setBiologicalRole​(CvTerm bioRole)
        Sets the biological role. If the bioRole is null, should create a bioRole
        Parameters:
        bioRole - : biological role unspecified role (MI:0499)

      • getBiologicalEffect

        CvTerm getBiologicalEffect()
        The biological effect of the participant in a causal interaction. It is a controlled vocabulary term and can be null.
        Returns:
        the biological effect

      • setBiologicalEffect

        void setBiologicalEffect​(CvTerm biologicalEffect)
        Sets the biological effect of the participant in a causal interaction.
        Parameters:
        biologicalEffect - : biological effect

      • getXrefs

        <X extends Xref> Collection<X> getXrefs()
        Collection of cross references which give more information about the participant. The set of xrefs cannot be null. If the participant does not have any xrefs, the method should return an empty Collection. Ex: author identifiers, ...
        Type Parameters:
        X - a X object
        Returns:
        the xrefs

      • getAnnotations

        <A extends Annotation> Collection<A> getAnnotations()
        Collection of annotations describing the participant. The set cannot be null. If the participant does not have any annotations, the method should return an empty Collection.
        Type Parameters:
        A - an A object
        Returns:
        the annotations

      • getAliases

        <A extends Alias> Collection<A> getAliases()
        Collection of aliases which give more information about the participant. The set of aliases cannot be null. If the participant does not have any aliases, the method should return an empty Collection. Ex: author assigned name, ...
        Type Parameters:
        A - an A object
        Returns:
        the xrefs