Interface Annotation


public interface Annotation
A Annotation is a container for mutable information that is associated with a Datastore. * Annotations are used for attributes like image comments and display settings that may be changed after the Datastore has been frozen.
  • Method Details

    • getImageAnnotation

      PropertyMap getImageAnnotation(Coords coords)
      Return a PropertyMap of information stored by this Annotation related to the image at the specified coordinates.
      Parameters:
      coords - Coordinates of image to get data for.
      Returns:
      PropertyMap of data related to the image, or null if none exists.
    • getGeneralAnnotation

      PropertyMap getGeneralAnnotation()
      Return a PropertyMap of information stored by the Annotation that is not specific to any one image.
      Returns:
      PropertyMap of data related to the entire dataset, or null if none exists.
    • setImageAnnotation

      void setImageAnnotation(Coords coords, PropertyMap newData)
      Replace the data this Annotation has for the specified Image with the provided PropertyMap.
      Parameters:
      coords - Coordinates of image whose data is to be updated.
      newData - Updated PropertyMap of data to be stored in the Annotation that pertains to the image
    • setGeneralAnnotation

      void setGeneralAnnotation(PropertyMap newData)
      Replace the data this Annotation has for the Datastore as a whole with the provided PropertyMap.
      Parameters:
      newData - Updated PropertyMap of data to be stored in the Annotation that is not specific to any one Image.
    • getFilename

      @Deprecated String getFilename()
      Deprecated.
      this is an old name for getTag()
      Deprecated function returning tag (which doubles as filename) for this Annotation.
      Returns:
      the tag for this annotation
    • getTag

      String getTag()
      Return this annotation's tag.
      Returns:
      the tag for this annotation
    • getDatastore

      Datastore getDatastore()
      Return the datastore to which this annotation is associated.
      Returns:
      Datastore associated with this annotation.
    • save

      void save() throws IOException
      Commit the changes to this annotation to disk.
      Throws:
      IOException