Merge branch 'develop' into feature/JAL-1713_overviewInProject

[jalview.git] / src / jalview / datamodel / ContactListProviderI.java

diff --git a/src/jalview/datamodel/ContactListProviderI.java b/src/jalview/datamodel/ContactListProviderI.java
new file mode 100644 (file)
index 0000000..f027e01
--- /dev/null
+++ b/src/jalview/datamodel/ContactListProviderI.java
@@ -0,0 +1,29 @@
+package jalview.datamodel;
+
+public interface ContactListProviderI
+{
+
+  /**
+   * 
+   * @return position index for this contact List (usually sequence position or
+   *         alignment column)
+   */
+  int getPosition();
+
+  /**
+   * dimension of list where getContactAt(column<getContactHeight()) may return
+   * a value
+   * 
+   * @return
+   */
+  int getContactHeight();
+
+  /**
+   * get a value representing contact at column for this site
+   * 
+   * @param column
+   * @return Double.NaN or a contact strength for this site
+   */
+  double getContactAt(int column);
+
+}