Package org.biojavax
Interface RichAnnotatable
-
- All Superinterfaces:
Annotatable
,Changeable
- All Known Subinterfaces:
BioEntry
,CrossRef
,RichFeature
,RichLocation
,RichSequence
- All Known Implementing Classes:
CompoundRichLocation
,EmptyRichLocation
,MultiSourceCompoundRichLocation
,SimpleBioEntry
,SimpleCrossRef
,SimpleRichFeature
,SimpleRichLocation
,SimpleRichSequence
,ThinRichSequence
public interface RichAnnotatable extends Annotatable
Annotatable objects that can have rich annotations.- Since:
- 1.5
- Author:
- Richard Holland, George Waldon
- See Also:
RichAnnotation
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.biojava.bio.Annotatable
Annotatable.AnnotationForwarder
-
-
Field Summary
-
Fields inherited from interface org.biojava.bio.Annotatable
ANNOTATION
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Set<Note>
getNoteSet()
Returns the set of notes associated with this object.RichAnnotation
getRichAnnotation()
Return the associated annotation object.void
setNoteSet(Set<Note> notes)
Clears the notes associated with this object and replaces them with the contents of this set.-
Methods inherited from interface org.biojava.bio.Annotatable
getAnnotation
-
Methods inherited from interface org.biojava.utils.Changeable
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener
-
-
-
-
Method Detail
-
getRichAnnotation
RichAnnotation getRichAnnotation()
Return the associated annotation object.- Returns:
- a RichAnnotation object, never null
-
getNoteSet
Set<Note> getNoteSet()
Returns the set of notes associated with this object. Would normally delegate call to internal RichAnnotation instance.- Returns:
- set a set of Note objects.
- See Also:
Note
-
setNoteSet
void setNoteSet(Set<Note> notes) throws ChangeVetoException
Clears the notes associated with this object and replaces them with the contents of this set. Would normally delegate call to internal RichAnnotation instance.- Parameters:
notes
- the set of Note objects to replace the existing ones with.- Throws:
ChangeVetoException
- if the set is null or contains any objects that are not Note objects.- See Also:
Note
-
-