Package org.biojavax
Class SimpleNote
java.lang.Object
org.biojava.utils.AbstractChangeable
org.biojavax.SimpleNote
- All Implemented Interfaces:
Comparable
,Changeable
,Note
Simple implementation of Note.
- Since:
- 1.5
- Author:
- Richard Holland, George Waldon - limited firing
-
Field Summary
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
SimpleNote
(ComparableTerm term, String value, int rank) Creates a new instance of SimpleNote with a given term, value and rank. -
Method Summary
Modifier and TypeMethodDescriptionint
Notes are compared first by rank, then by the term.boolean
Notes are equal if they have the same rank and term.int
getRank()
Gets the rank that defines this note.getTerm()
Gets the term that defines this note.getValue()
Gets the value that defines this note.int
hashCode()
void
setRank
(int rank) 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.toString()
Form: "(#rank) term: value"Methods inherited from class org.biojava.utils.AbstractChangeable
addChangeListener, addChangeListener, generateChangeSupport, getChangeSupport, hasListeners, hasListeners, isUnchanging, removeChangeListener, removeChangeListener
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.biojava.utils.Changeable
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener
-
Constructor Details
-
SimpleNote
Creates a new instance of SimpleNote with a given term, value and rank.- Parameters:
term
- the term of the note. Cannot be null.value
- the (optional) value to give it.rank
- the rank to give it.
-
SimpleNote
protected SimpleNote()
-
-
Method Details
-
getTerm
Gets the term that defines this note. -
setTerm
Sets the term for this note. It cannot be null.- Specified by:
setTerm
in interfaceNote
- Parameters:
term
- the term to use.- Throws:
ChangeVetoException
- if it doesn't like the term.
-
getValue
Gets the value that defines this note. -
setValue
Sets the value for this note, or null for no value.- Specified by:
setValue
in interfaceNote
- Parameters:
value
- the value to use.- Throws:
ChangeVetoException
- if it doesn't like the value.
-
getRank
Gets the rank that defines this note. -
setRank
Sets the rank for this note.- Specified by:
setRank
in interfaceNote
- Parameters:
rank
- the rank to use.- Throws:
ChangeVetoException
- if it doesn't like the rank.
-
compareTo
Notes are compared first by rank, then by the term.- Specified by:
compareTo
in interfaceComparable
-
equals
Notes are equal if they have the same rank and term. -
hashCode
-
toString
Form: "(#rank) term: value"
-