Interface BioEntryRelationship

  • All Superinterfaces:
    Changeable, java.lang.Comparable
    All Known Implementing Classes:
    SimpleBioEntryRelationship

    public interface BioEntryRelationship
    extends java.lang.Comparable, Changeable
    Represents the relation between two bioentries. The bioentry_relationship in BioSQL is what this represents.
    Since:
    1.5
    Author:
    Mark Schreiber, Richard Holland
    See Also:
    BioEntry
    • Method Detail

      • setRank

        void setRank​(java.lang.Integer rank)
              throws ChangeVetoException
        Sets the rank of this relationship. The rank may be null in the database, hence the use of an Integer object here and not an int primitive.
        Parameters:
        rank - Value of property rank.
        Throws:
        ChangeVetoException - if the rank rankles.
      • getRank

        java.lang.Integer getRank()
        Returns the rank of this relationship. The rank may be null in the database, hence the use of an Integer object here and not an int primitive.
        Returns:
        Value of property rank.
      • getObject

        BioEntry getObject()
        Returns the object of this relationship (ie. the BioEntry which this relationship starts from). This is an immutable property set by the constructor of an instantiating class.
        Returns:
        Value of property object.
      • getSubject

        BioEntry getSubject()
        Returns the subject of this relationship (ie. the BioEntry which this relationship targets). This is an immutable property set by the constructor of an instantiating class.
        Returns:
        Value of property subject.
      • getTerm

        ComparableTerm getTerm()
        Returns the term describing the relationship. This is an immutable property set by the constructor of an instantiating class.
        Returns:
        Value of property term.