Package org.biojavax

Interface Note

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

    public interface Note
    extends java.lang.Comparable, Changeable
    Note is a generic class intended to hold a term describing the note, a value to associate with that term, and a rank. It is a generic representation of the various qualifier_value tables in BioSQL. It is used inside RichAnnotation objects to represent annotations.
    Since:
    1.5
    Author:
    Richard Holland
    See Also:
    RichAnnotation
    • Method Detail

      • getTerm

        ComparableTerm getTerm()
        Gets the term that defines this note.
        Returns:
        a ComparableTerm object that is the key to this note.
      • getValue

        java.lang.String getValue()
        Gets the value that defines this note.
        Returns:
        a String object that is the value to this note.
      • setValue

        void setValue​(java.lang.String value)
               throws ChangeVetoException
        Sets the value for this note, or null for no value.
        Parameters:
        value - the value to use.
        Throws:
        ChangeVetoException - if it doesn't like the value.
      • getRank

        int getRank()
        Gets the rank that defines this note.
        Returns:
        an int that is the rank to this note.
      • setRank

        void setRank​(int value)
              throws ChangeVetoException
        Sets the rank for this note.
        Parameters:
        value - the rank to use.
        Throws:
        ChangeVetoException - if it doesn't like the rank.