Merge branch 'features/JAL-845splitPaneMergeDevelop' into develop

[jalview.git] / src / jalview / structure / AtomSpec.java

diff --git a/src/jalview/structure/AtomSpec.java b/src/jalview/structure/AtomSpec.java
new file mode 100644 (file)
index 0000000..d3e8d42
--- /dev/null
+++ b/src/jalview/structure/AtomSpec.java
@@ -0,0 +1,64 @@
+package jalview.structure;
+
+/**
+ * Java bean representing an atom in a PDB (or similar) structure model.
+ * 
+ * @author gmcarstairs
+ *
+ */
+public class AtomSpec
+{
+  // TODO clarify do we want pdbFile here, or pdbId?
+  // compare highlightAtom in 2.8.2 for JalviewJmolBinding and
+  // javascript.MouseOverStructureListener
+  private String pdbFile;
+
+  private String chain;
+
+  private int pdbResNum;
+
+  private int atomIndex;
+
+  /**
+   * Constructor
+   * 
+   * @param pdbFile
+   * @param chain
+   * @param resNo
+   * @param atomNo
+   */
+  public AtomSpec(String pdbFile, String chain, int resNo, int atomNo)
+  {
+    this.pdbFile = pdbFile;
+    this.chain = chain;
+    this.pdbResNum = resNo;
+    this.atomIndex = atomNo;
+  }
+
+  public String getPdbFile()
+  {
+    return pdbFile;
+  }
+
+  public String getChain()
+  {
+    return chain;
+  }
+
+  public int getPdbResNum()
+  {
+    return pdbResNum;
+  }
+
+  public int getAtomIndex()
+  {
+    return atomIndex;
+  }
+
+  @Override
+  public String toString()
+  {
+    return "pdbFile: " + pdbFile + ", chain: " + chain + ", res: "
+            + pdbResNum + ", atom: " + atomIndex;
+  }
+}