public interface

Observation

implements PropertyChange AnnotationObject
vars.annotation.Observation
Known Indirect Subclasses

Summary

Constants
String PROP_ASSOCIATIONS
String PROP_CONCEPT_NAME
String PROP_NOTES
String PROP_OBSERVATION_DATE
String PROP_OBSERVER
String PROP_VIDEO_FRAME
String PROP_X
String PROP_Y
Public Methods
abstract void addAssociation(Association association)
Add to the Association collection.
abstract Set<Association> getAssociations()
WARNING! Do not add or remove directly from this collection.
abstract String getConceptName()
abstract String getNotes()
abstract Date getObservationDate()
abstract String getObserver()
abstract VideoFrame getVideoFrame()
abstract Double getX()
abstract Double getY()
abstract boolean hasSample()
Indicates if this observation has a sample associated with it.
abstract void removeAssociation(Association association)
Remove from the Association collection.
abstract void setConceptName(String conceptName)

abstract void setNotes(String string)
abstract void setObservationDate(Date dtg)
The date the annotator annotated this observation.
abstract void setObserver(String observer)
abstract void setX(Double x)
abstract void setY(Double y)
[Expand]
Inherited Methods
From interface vars.PropertyChange
From interface vars.VARSObject

Constants

public static final String PROP_ASSOCIATIONS

Constant Value: "associations"

public static final String PROP_CONCEPT_NAME

Constant Value: "conceptName"

public static final String PROP_NOTES

Constant Value: "notes"

public static final String PROP_OBSERVATION_DATE

Constant Value: "observationDate"

public static final String PROP_OBSERVER

Constant Value: "observer"

public static final String PROP_VIDEO_FRAME

Constant Value: "videoFrame"

public static final String PROP_X

Constant Value: "x"

public static final String PROP_Y

Constant Value: "y"

Public Methods

public abstract void addAssociation (Association association)

Add to the Association collection.

Parameters
association The Association object to add.
Returns
  • The passed Association object if added, the matching Association object otherwise.
See Also

public abstract Set<Association> getAssociations ()

WARNING! Do not add or remove directly from this collection.

Returns
  • A synchronized collection

public abstract String getConceptName ()

Returns
  • The fromConcept of this observation.

public abstract String getNotes ()

public abstract Date getObservationDate ()

public abstract String getObserver ()

public abstract VideoFrame getVideoFrame ()

public abstract Double getX ()

Returns
  • The x location of the observation within the videoFrame in pixels

public abstract Double getY ()

Returns
  • The y location of the observation within the videoFrame in pixels

public abstract boolean hasSample ()

Indicates if this observation has a sample associated with it. It does this by looking at each association for the linkName starting with sampled.

Returns
  • true = a sample IS associated with this observation.

public abstract void removeAssociation (Association association)

Remove from the Association collection.

Parameters
association The Association object to remove.

public abstract void setConceptName (String conceptName)

public abstract void setNotes (String string)

Parameters
string NOTE: String longer than 200 characters will be truncated

public abstract void setObservationDate (Date dtg)

The date the annotator annotated this observation. Got it ;-)

public abstract void setObserver (String observer)

Parameters
observer A name representing the person (or software?) who made the observation

public abstract void setX (Double x)

Parameters
x The x location of the observation within the videoFrame in pixels

public abstract void setY (Double y)

Parameters
y The y location of the observation within the videoFrame in pixels