JAL-966 JAL-1854 removed redundant methods / modifiers from search
[jalview.git] / src / jalview / datamodel / SearchResultMatchI.java
index e886bed..732f1dc 100644 (file)
@@ -1,17 +1,30 @@
 package jalview.datamodel;
 
+/**
+ * An interface that describes one matched region of an alignment, as one
+ * contiguous portion of a single dataset sequence
+ */
 public interface SearchResultMatchI
 {
+  /**
+   * Returns the matched sequence
+   * 
+   * @return
+   */
+  SequenceI getSequence();
 
-  public abstract SequenceI getSequence();
-
-  public abstract int getStart();
-
-  public abstract int getEnd();
+  /**
+   * Returns the start position of the match in the sequence (base 1)
+   * 
+   * @return
+   */
+  int getStart();
 
   /**
-   * Returns the string of characters in the matched region.
+   * Returns the end position of the match in the sequence (base 1)
+   * 
+   * @return
    */
-  public abstract String getCharacters();
+  int getEnd();
 
 }
\ No newline at end of file