Package org.biojavax
Interface Note
- All Superinterfaces:
Changeable
,Comparable
- All Known Implementing Classes:
SimpleNote
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ChangeType
static final ChangeType
static final ChangeType
-
Method Summary
Modifier and TypeMethodDescriptionint
getRank()
Gets the rank that defines this note.getTerm()
Gets the term that defines this note.getValue()
Gets the value that defines this note.void
setRank
(int value) Sets the rank for this note.void
setTerm
(ComparableTerm term) Sets the term for this note.void
Sets the value for this note, or null for no value.Methods inherited from interface org.biojava.utils.Changeable
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener
Methods inherited from interface java.lang.Comparable
compareTo
-
Field Details
-
TERM
-
RANK
-
VALUE
-
-
Method Details
-
getTerm
Gets the term that defines this note.- Returns:
- a ComparableTerm object that is the key to this note.
-
setTerm
Sets the term for this note. It cannot be null.- Parameters:
term
- the term to use.- Throws:
ChangeVetoException
- if it doesn't like the term.
-
getValue
Gets the value that defines this note.- Returns:
- a String object that is the value to this note.
-
setValue
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
Sets the rank for this note.- Parameters:
value
- the rank to use.- Throws:
ChangeVetoException
- if it doesn't like the rank.
-