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     // TODO is FILE needed; if not is this needed or can we
  38     // use FileFormatI for PDB, MMCIF?
  39     PDB("pdb", "xml"), MMCIF("mmcif", "mmcif"), FILE("?", "?");
  40     String ext;
  41
  42     String format;
  43
  44     private Type(String fmt, String ex)
  45     {
  46       format = fmt;
  47       ext = ex;
  48     }
  49
  50     public String getFormat()
  51     {
  52       return format;
  53     }
  54     public String getExtension()
  55     {
  56       return ext;
  57     }
  58   }
  59
  60   Hashtable<String, String> properties;
  61
  62   /*
  63    * (non-Javadoc)
  64    *
  65    * @see java.lang.Object#equals(java.lang.Object)
  66    */
  67   @Override
  68   public boolean equals(Object obj)
  69   {
  70     if (obj == null || !(obj instanceof PDBEntry))
  71     {
  72       return false;
  73     }
  74     if (obj == this)
  75     {
  76       return true;
  77     }
  78     PDBEntry o = (PDBEntry) obj;
  79     return (type == o.type || (type != null && o.type != null && o.type
  80             .equals(type)))
  81             && (id == o.id || (id != null && o.id != null && o.id
  82                     .equalsIgnoreCase(id)))
  83             && (chainCode == o.chainCode || (chainCode != null
  84                     && o.chainCode != null && o.chainCode
  85                       .equalsIgnoreCase(chainCode)))
  86             && (properties == o.properties || (properties != null
  87                     && o.properties != null && properties
  88                       .equals(o.properties)));
  89
  90   }
  91
  92   /**
  93    * Default constructor
  94    */
  95   public PDBEntry()
  96   {
  97   }
  98
  99   /**
 100    * Constructor given file path and PDB id.
 101    *
 102    * @param filePath
 103    */
 104   // public PDBEntry(String filePath, String pdbId)
 105   // {
 106   // this.file = filePath;
 107   // this.id = pdbId;
 108   // }
 109
 110   public PDBEntry(String pdbId, String chain, PDBEntry.Type type,
 111           String filePath)
 112   {
 113     this.id = pdbId;
 114     this.chainCode = chain;
 115     this.type = type == null ? null : type.toString();
 116     this.file = filePath;
 117   }
 118
 119   /**
 120    * Copy constructor.
 121    *
 122    * @param entry
 123    */
 124   public PDBEntry(PDBEntry entry)
 125   {
 126     file = entry.file;
 127     type = entry.type;
 128     id = entry.id;
 129     chainCode = entry.chainCode;
 130     if (entry.properties != null)
 131     {
 132       properties = (Hashtable) entry.properties.clone();
 133     }
 134   }
 135
 136   public void setFile(String file)
 137   {
 138     this.file = file;
 139   }
 140
 141   public String getFile()
 142   {
 143     return file;
 144   }
 145
 146   public void setType(String t)
 147   {
 148     this.type = t;
 149   }
 150
 151   public void setType(PDBEntry.Type type)
 152   {
 153     this.type = type == null ? null : type.toString();
 154   }
 155
 156   public String getType()
 157   {
 158     return type;
 159   }
 160
 161   public void setId(String id)
 162   {
 163     this.id = id;
 164   }
 165
 166   public String getId()
 167   {
 168     return id;
 169   }
 170
 171   public void setProperty(Hashtable property)
 172   {
 173     this.properties = property;
 174   }
 175
 176   public Hashtable<String, String> getProperty()
 177   {
 178     return properties;
 179   }
 180
 181   public String getChainCode()
 182   {
 183     return chainCode;
 184   }
 185
 186   public void setChainCode(String chainCode)
 187   {
 188     this.chainCode = chainCode;
 189   }
 190
 191   @Override
 192   public String toString()
 193   {
 194     return id;
 195   }
 196 }