Package psidev.psi.mi.jami.model

Interface Entity<F extends Feature>

    • Method Detail

      • getInteractor

        Interactor getInteractor()
        The molecule/complex of molecules which interacts. It cannot be null.
        Returns:
        the interactor

      • setInteractor

        void setInteractor​(Interactor interactor)
        Sets the interactor
        Parameters:
        interactor - : interactor
        Throws:
        IllegalArgumentException - when interactor is null

      • getCausalRelationships

        <C extends CausalRelationship> Collection<C> getCausalRelationships()
        The causal relationships of this entity on other entities usually part of an interaction. The set of causal relationship cannot be null. If the entity does not have any causal relationship, the method should return an empty Collection. Ex: increasing, decreasing, disrupting, etc.
        Type Parameters:
        C - a C object
        Returns:
        the collection of causal relationships attached to this entity

      • getFeatures

        <F2 extends F> Collection<F2> getFeatures()
        Properties for this entity. The collection cannot be null. If the entity does not have any features, the method should return an empty collection.
        Type Parameters:
        F2 - a F2 object
        Returns:
        the features

      • getChangeListener

        EntityInteractorChangeListener getChangeListener()
        The entity change listener if set, null otherwise. The entity change listener listen to changes in entity (interactor changes)
        Returns:
        the participant change listener

      • setChangeListener

        void setChangeListener​(EntityInteractorChangeListener listener)
        Sets the entity change listener
        Parameters:
        listener - : the entity change listener

      • addFeature

        boolean addFeature​(F feature)
        This method will add the feature and set the entity of the new feature to this current entity
        Parameters:
        feature - : feature to add
        Returns:
        true if feature is added to the list of features

      • removeFeature

        boolean removeFeature​(F feature)
        This method will remove the feature and set the entity of the removed feature to null.
        Parameters:
        feature - : feature to remove
        Returns:
        true if feature is removed from the list of features

      • addAllFeatures

        boolean addAllFeatures​(Collection<? extends F> features)
        This method will add all features and set the entity of the new features to this current entity
        Parameters:
        features - : features to add
        Returns:
        true if features are added to the list of features

      • removeAllFeatures

        boolean removeAllFeatures​(Collection<? extends F> features)
        This method will remove all the features and set the entity of the removed features to null.
        Parameters:
        features - : features to remove
        Returns:
        true if features are removed from the list of features

      • getStoichiometry

        Stoichiometry getStoichiometry()
        The stoichiometry for this participant. If the stoichiometry for this participant is unknown, the method should return null.
        Returns:
        the stoichiometry

      • setStoichiometry

        void setStoichiometry​(Integer stoichiometry)
        Sets the mean stoichiometry for this participant.
        Parameters:
        stoichiometry - : mean stoichiometry value

      • setStoichiometry

        void setStoichiometry​(Stoichiometry stoichiometry)
        Sets the stoichiometry for this participant.
        Parameters:
        stoichiometry - : the stoichiometry