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.ws.dbsources.PDBRestClient.PDBDocField;
  25
  26 import java.util.Collection;
  27 import java.util.Objects;
  28
  29 import javax.swing.table.DefaultTableModel;
  30
  31 import org.json.simple.JSONObject;
  32
  33 /**
  34  * Represents the response model produced by the PDBRestClient upon successful
  35  * execution of a given request
  36  *
  37  * @author tcnofoegbu
  38  *
  39  */
  40 public class PDBRestResponse
  41 {
  42   private int numberOfItemsFound;
  43
  44   private String responseTime;
  45
  46   private Collection<PDBResponseSummary> searchSummary;
  47
  48   public int getNumberOfItemsFound()
  49   {
  50     return numberOfItemsFound;
  51   }
  52
  53   public void setNumberOfItemsFound(int itemFound)
  54   {
  55     this.numberOfItemsFound = itemFound;
  56   }
  57
  58   public String getResponseTime()
  59   {
  60     return responseTime;
  61   }
  62
  63   public void setResponseTime(String responseTime)
  64   {
  65     this.responseTime = responseTime;
  66   }
  67
  68   public Collection<PDBResponseSummary> getSearchSummary()
  69   {
  70     return searchSummary;
  71   }
  72
  73   public void setSearchSummary(Collection<PDBResponseSummary> searchSummary)
  74   {
  75     this.searchSummary = searchSummary;
  76   }
  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("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 String[] summaryRowData;
 131
 132     private String associatedSequence;
 133
 134     public PDBResponseSummary(JSONObject pdbJsonDoc, PDBRestRequest request)
 135     {
 136       Collection<PDBDocField> diplayFields = request.getWantedFields();
 137       String associatedSeq = request.getAssociatedSequence();
 138       int colCounter = 0;
 139       summaryRowData = new String[(associatedSeq != null) ? diplayFields
 140               .size() + 1 : diplayFields.size()];
 141       if (associatedSeq != null)
 142       {
 143         this.associatedSequence = (associatedSeq.length() > 18) ? associatedSeq
 144                 .substring(0, 18) : associatedSeq;
 145         summaryRowData[0] = associatedSequence;
 146         colCounter = 1;
 147       }
 148
 149       for (PDBDocField field : diplayFields)
 150       {
 151         String fieldData = (pdbJsonDoc.get(field.getCode()) == null) ? ""
 152                 : pdbJsonDoc
 153                 .get(field.getCode()).toString();
 154         if (field.equals(PDBDocField.PDB_ID))
 155         {
 156           this.pdbId = fieldData;
 157           summaryRowData[colCounter++] = this.pdbId;
 158         }
 159         else
 160         {
 161           summaryRowData[colCounter++] = fieldData;
 162         }
 163       }
 164     }
 165
 166     public String getPdbId()
 167     {
 168       return pdbId;
 169     }
 170
 171     public void setPdbId(String pdbId)
 172     {
 173       this.pdbId = pdbId;
 174     }
 175
 176     public String[] getSummaryData()
 177     {
 178       return summaryRowData;
 179     }
 180
 181     public void setSummaryData(String[] summaryData)
 182     {
 183       this.summaryRowData = summaryData;
 184     }
 185
 186     /**
 187      * Returns a string representation of this object;
 188      */
 189     @Override
 190     public String toString()
 191     {
 192       StringBuilder summaryFieldValues = new StringBuilder();
 193       for (String summaryField : summaryRowData)
 194       {
 195         summaryFieldValues.append(summaryField).append("\t");
 196       }
 197       return summaryFieldValues.toString();
 198     }
 199
 200     /**
 201      * Returns hash code value for this object
 202      */
 203     @Override
 204     public int hashCode()
 205     {
 206       return Objects.hash(this.pdbId, this.toString());
 207     }
 208
 209     /**
 210      * Indicates whether some object is equal to this one
 211      */
 212     @Override
 213     public boolean equals(Object that)
 214     {
 215       if (!(that instanceof PDBResponseSummary))
 216       {
 217         return false;
 218       }
 219       PDBResponseSummary another = (PDBResponseSummary) that;
 220       return this.toString().equals(another.toString());
 221     }
 222
 223   }
 224
 225 }
 226