|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Indicates that an object has an associated annotation.
Many BioJava objects will have associated unstructured data. This should be stored in an Annotation instance. However, the BioJava object itself will probably not want to extend the Annotation interface directly, but rather delegate off that functionality to an Annotation property. The Annotatable interface indicates that there is an Annoation porperty. It also provides an inner class called AnnotationForwarder. When implementing Annotatable, you should always create a protected or private field containing an instance of AnnotationForwarder, and register it as a ChangeListener with the associated Annotation delegate instance.
public class Foo extends AbstractChangeable implements Annotatable { private Annotation ann; // the associated annotation delegate protected ChangeListener annFor; // the event forwarder public Foo() { // make the ann delegate ann = new SimpleAnnotation(); annFor = new Annotatable.AnnotationForwarder( this, // this is the source of the new events getChangeSupport(Annotatable.ANNOTATION) // the type of the events ); // add the forwarder to our ann delegate ann.addChangeListener(annFor, Annotatable.ANNOTATION); } public Annotation getAnnotation() { return ann; } }
Nested Class Summary | |
static class |
Annotatable.AnnotationForwarder
A helper class so that you don't have to worry about forwarding events from the Annotation object to the Annotatable one. |
Field Summary | |
static ChangeType |
ANNOTATION
Signals that the associated Annotation has altered in some way. |
Method Summary | |
Annotation |
getAnnotation()
Should return the associated annotation object. |
Methods inherited from interface org.biojava.utils.Changeable |
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener |
Field Detail |
public static final ChangeType ANNOTATION
Method Detail |
public Annotation getAnnotation()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |