feature locations are retrieved by associated accession string and public debug repor...
[jalview.git] / src / jalview / datamodel / AlignmentI.java
index 96b1972..34a5ff2 100755 (executable)
@@ -178,11 +178,15 @@ public interface AlignmentI
   public void setAnnotationIndex(AlignmentAnnotation aa, int index);
 
   /**
-   * Deletes a specific AlignmentAnnotation from the alignment.
-   *
+   * Deletes a specific AlignmentAnnotation from the alignment,
+   * and removes its reference from any SequenceI object's annotation
+   * if and only if aa is contained within the alignment's annotation
+   * vector. Otherwise, it will do nothing.
+   * 
    * @param aa the annotation to delete
+   * @return true if annotation was deleted from this alignment.
    */
-  public void deleteAnnotation(AlignmentAnnotation aa);
+  public boolean deleteAnnotation(AlignmentAnnotation aa);
 
   /**
    * Get the annotation associated with this alignment
@@ -244,7 +248,23 @@ public interface AlignmentI
    */
   public CigarArray getCompactAlignment();
 
+  /**
+   * Set an arbitrary key value pair for an alignment.
+   * Note: both key and value objects should return a 
+   * meaningful, human readable response to .toString()
+   * @param key
+   * @param value
+   */
   public void setProperty(Object key, Object value);
-
+  /**
+   * Get a named property from the alignment. 
+   * @param key
+   * @return value of property
+   */
   public Object getProperty(Object key);
+  /**
+   * Get the property hashtable.
+   * @return hashtable of alignment properties (or null if none are defined)
+   */
+  public Hashtable getProperties();
 }