src/jalview/structure/AtomSpec.java

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