JAL-1807 Bob's JalviewJS prototype first commit
[jalviewjs.git] / src / jalview / structure / AtomSpec.java
1 package jalview.structure;
2
3 /**
4  * Java bean representing an atom in a PDB (or similar) structure model or
5  * viewer
6  * 
7  * @author gmcarstairs
8  *
9  */
10 public class AtomSpec
11 {
12   // TODO clarify do we want pdbFile here, or pdbId?
13   // compare highlightAtom in 2.8.2 for JalviewJmolBinding and
14   // javascript.MouseOverStructureListener
15   private String pdbFile;
16
17   private String chain;
18
19   private int pdbResNum;
20
21   private int atomIndex;
22
23   /**
24    * Constructor
25    * 
26    * @param pdbFile
27    * @param chain
28    * @param resNo
29    * @param atomNo
30    */
31   public AtomSpec(String pdbFile, String chain, int resNo, int atomNo)
32   {
33     this.pdbFile = pdbFile;
34     this.chain = chain;
35     this.pdbResNum = resNo;
36     this.atomIndex = atomNo;
37   }
38
39   public String getPdbFile()
40   {
41     return pdbFile;
42   }
43
44   public String getChain()
45   {
46     return chain;
47   }
48
49   public int getPdbResNum()
50   {
51     return pdbResNum;
52   }
53
54   public int getAtomIndex()
55   {
56     return atomIndex;
57   }
58
59   @Override
60   public String toString()
61   {
62     return "pdbFile: " + pdbFile + ", chain: " + chain + ", res: "
63             + pdbResNum + ", atom: " + atomIndex;
64   }
65 }