JAL-1479 bugfix after decoupling SIFTS preference settings
[jalview.git] / src / jalview / ws / uimodel / PDBRestResponse.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
3  * Copyright (C) 2014 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
22 package jalview.ws.uimodel;
23
24 import jalview.datamodel.SequenceI;
25 import jalview.ws.dbsources.PDBRestClient.PDBDocField;
26
27 import java.util.Collection;
28 import java.util.Objects;
29
30 import javax.swing.table.DefaultTableModel;
31
32 import org.json.simple.JSONObject;
33
34 /**
35  * Represents the response model produced by the PDBRestClient upon successful
36  * execution of a given request
37  * 
38  * @author tcnofoegbu
39  *
40  */
41 public class PDBRestResponse
42 {
43   private int numberOfItemsFound;
44
45   private String responseTime;
46
47   private Collection<PDBResponseSummary> searchSummary;
48
49   public int getNumberOfItemsFound()
50   {
51     return numberOfItemsFound;
52   }
53
54   public void setNumberOfItemsFound(int itemFound)
55   {
56     this.numberOfItemsFound = itemFound;
57   }
58
59   public String getResponseTime()
60   {
61     return responseTime;
62   }
63
64   public void setResponseTime(String responseTime)
65   {
66     this.responseTime = responseTime;
67   }
68
69   public Collection<PDBResponseSummary> getSearchSummary()
70   {
71     return searchSummary;
72   }
73
74   public void setSearchSummary(Collection<PDBResponseSummary> searchSummary)
75   {
76     this.searchSummary = searchSummary;
77   }
78
79   /**
80    * Convenience method to obtain a Table model for a given summary List based
81    * on the request parameters
82    * 
83    * @param request
84    *          the PDBRestRequest object which holds useful information for
85    *          creating a table model
86    * @param summariesList
87    *          the summary list which contains the data for populating the
88    *          table's rows
89    * @return the table model which was dynamically generated
90    */
91   public static DefaultTableModel getTableModel(PDBRestRequest request,
92           Collection<PDBResponseSummary> summariesList)
93   {
94     DefaultTableModel tableModel = new DefaultTableModel()
95     {
96       @Override
97       public boolean isCellEditable(int row, int column)
98       {
99         return false;
100       }
101     };
102     if (request.getAssociatedSequence() != null)
103     {
104       tableModel.addColumn("Ref Sequence"); // Create sequence column header if
105       // exists in the request
106     }
107     for (PDBDocField field : request.getWantedFields())
108     {
109       tableModel.addColumn(field.getName()); // Create sequence column header if
110                                              // exists in the request
111     }
112
113     for (PDBResponseSummary res : summariesList)
114     {
115       tableModel.addRow(res.getSummaryData()); // Populate table rows with
116                                                // summary list
117     }
118
119     return tableModel;
120   }
121
122   /**
123    * Model for a unique response summary
124    * 
125    */
126   public class PDBResponseSummary
127   {
128     private String pdbId;
129
130     private Object[] summaryRowData;
131
132     private SequenceI associatedSequence;
133
134     public PDBResponseSummary(JSONObject pdbJsonDoc, PDBRestRequest request)
135     {
136       Collection<PDBDocField> diplayFields = request.getWantedFields();
137       SequenceI associatedSeq = request.getAssociatedSequence();
138       int colCounter = 0;
139       summaryRowData = new Object[(associatedSeq != null) ? diplayFields
140               .size() + 1 : diplayFields.size()];
141       if (associatedSeq != null)
142       {
143         this.associatedSequence = associatedSeq;
144         summaryRowData[0] = associatedSequence;
145         colCounter = 1;
146       }
147
148       for (PDBDocField field : diplayFields)
149       {
150         String fieldData = (pdbJsonDoc.get(field.getCode()) == null) ? ""
151                 : pdbJsonDoc.get(field.getCode()).toString();
152         if (field.equals(PDBDocField.PDB_ID))
153         {
154           this.pdbId = fieldData;
155           summaryRowData[colCounter++] = this.pdbId;
156         }
157         else
158         {
159           summaryRowData[colCounter++] = fieldData;
160         }
161       }
162     }
163
164     public String getPdbId()
165     {
166       return pdbId;
167     }
168
169     public void setPdbId(String pdbId)
170     {
171       this.pdbId = pdbId;
172     }
173
174     public Object[] getSummaryData()
175     {
176       return summaryRowData;
177     }
178
179     public void setSummaryData(String[] summaryData)
180     {
181       this.summaryRowData = summaryData;
182     }
183
184     /**
185      * Returns a string representation of this object;
186      */
187     @Override
188     public String toString()
189     {
190       StringBuilder summaryFieldValues = new StringBuilder();
191       for (Object summaryField : summaryRowData)
192       {
193         summaryFieldValues.append(summaryField.toString()).append("\t");
194       }
195       return summaryFieldValues.toString();
196     }
197
198     /**
199      * Returns hash code value for this object
200      */
201     @Override
202     public int hashCode()
203     {
204       return Objects.hash(this.pdbId, this.toString());
205     }
206
207     /**
208      * Indicates whether some object is equal to this one
209      */
210     @Override
211     public boolean equals(Object that)
212     {
213       if (!(that instanceof PDBResponseSummary))
214       {
215         return false;
216       }
217       PDBResponseSummary another = (PDBResponseSummary) that;
218       return this.toString().equals(another.toString());
219     }
220
221   }
222
223 }