src/jalview/datamodel/PDBEntry.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.datamodel;
  22
  23 import java.util.Hashtable;
  24
  25 public class PDBEntry
  26 {
  27   private String file;
  28
  29   private String type;
  30
  31   private String id;
  32
  33   private String chainCode;
  34
  35   public enum Type
  36   {
  37     PDB, FILE
  38   }
  39
  40   Hashtable properties;
  41
  42   /*
  43    * (non-Javadoc)
  44    *
  45    * @see java.lang.Object#equals(java.lang.Object)
  46    */
  47   @Override
  48   public boolean equals(Object obj)
  49   {
  50     if (obj == null || !(obj instanceof PDBEntry))
  51     {
  52       return false;
  53     }
  54     if (obj == this)
  55     {
  56       return true;
  57     }
  58     PDBEntry o = (PDBEntry) obj;
  59     return (type == o.type || (type != null && o.type != null && o.type
  60             .equals(type)))
  61             && (id == o.id || (id != null && o.id != null && o.id
  62                     .equalsIgnoreCase(id)))
  63             && (chainCode == o.chainCode || (chainCode != null
  64                     && o.chainCode != null && o.chainCode
  65                       .equalsIgnoreCase(chainCode)))
  66             && (properties == o.properties || (properties != null
  67                     && o.properties != null && properties
  68                       .equals(o.properties)));
  69
  70   }
  71
  72   /**
  73    * Default constructor
  74    */
  75   public PDBEntry()
  76   {
  77   }
  78
  79   /**
  80    * Constructor given file path and PDB id.
  81    *
  82    * @param filePath
  83    */
  84   // public PDBEntry(String filePath, String pdbId)
  85   // {
  86   // this.file = filePath;
  87   // this.id = pdbId;
  88   // }
  89
  90   public PDBEntry(String pdbId, String chain, PDBEntry.Type type,
  91           String filePath)
  92   {
  93     this.id = pdbId;
  94     this.chainCode = chain;
  95     this.type = type == null ? null : type.toString();
  96     this.file = filePath;
  97   }
  98
  99   /**
 100    * Copy constructor.
 101    *
 102    * @param entry
 103    */
 104   public PDBEntry(PDBEntry entry)
 105   {
 106     file = entry.file;
 107     type = entry.type;
 108     id = entry.id;
 109     chainCode = entry.chainCode;
 110     if (entry.properties != null)
 111     {
 112       properties = (Hashtable) entry.properties.clone();
 113     }
 114   }
 115
 116   public void setFile(String file)
 117   {
 118     this.file = file;
 119   }
 120
 121   public String getFile()
 122   {
 123     return file;
 124   }
 125
 126   public void setType(String t)
 127   {
 128     this.type = t;
 129   }
 130
 131   public void setType(PDBEntry.Type type)
 132   {
 133     this.type = type == null ? null : type.toString();
 134   }
 135
 136   public String getType()
 137   {
 138     return type;
 139   }
 140
 141   public void setId(String id)
 142   {
 143     this.id = id;
 144   }
 145
 146   public String getId()
 147   {
 148     return id;
 149   }
 150
 151   public void setProperty(Hashtable property)
 152   {
 153     this.properties = property;
 154   }
 155
 156   public Hashtable getProperty()
 157   {
 158     return properties;
 159   }
 160
 161   public String getChainCode()
 162   {
 163     return chainCode;
 164   }
 165
 166   public void setChainCode(String chainCode)
 167   {
 168     this.chainCode = chainCode;
 169   }
 170
 171   public String toString()
 172   {
 173     return id;
 174   }
 175 }