JAL-1834 removed quotes around truncated strings with ellipsis
[jalview.git] / 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   Hashtable properties;
40
41   /*
42    * (non-Javadoc)
43    * 
44    * @see java.lang.Object#equals(java.lang.Object)
45    */
46   @Override
47   public boolean equals(Object obj)
48   {
49     if (obj == null || !(obj instanceof PDBEntry))
50     {
51       return false;
52     }
53     if (obj == this)
54     {
55       return true;
56     }
57     PDBEntry o = (PDBEntry) obj;
58     return
59     (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   public void setType(PDBEntry.Type type)
131   {
132     this.type = type == null ? null : type.toString();
133   }
134
135   public String getType()
136   {
137     return type;
138   }
139
140   public void setId(String id)
141   {
142     this.id = id;
143   }
144
145   public String getId()
146   {
147     return id;
148   }
149
150   public void setProperty(Hashtable property)
151   {
152     this.properties = property;
153   }
154
155   public Hashtable getProperty()
156   {
157     return properties;
158   }
159
160   public String getChainCode()
161   {
162     return chainCode;
163   }
164
165   public void setChainCode(String chainCode)
166   {
167     this.chainCode = chainCode;
168   }
169
170   public String toString()
171   {
172     return id;
173   }
174 }