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 and
  81    * request
  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     if (request.getAssociatedSequence() != null)
  97     {
  98       tableModel.addColumn("Sequence"); // Create sequence column header if
  99                                         // exists in the request
 100     }
 101     for (PDBDocField field : request.getWantedFields())
 102     {
 103       tableModel.addColumn(field.getName()); // Create sequence column header if
 104                                              // exists in the request
 105     }
 106
 107     for (PDBResponseSummary res : summariesList)
 108     {
 109       tableModel.addRow(res.getSummaryData()); // Populate table rows with
 110                                                // summary list
 111     }
 112     return tableModel;
 113   }
 114
 115   /**
 116    * Model for a unique response summary
 117    *
 118    * @author tcnofoegbu
 119    *
 120    */
 121   public class PDBResponseSummary
 122   {
 123     private String pdbId;
 124
 125     private String[] summaryRowData;
 126
 127     private String associatedSequence;
 128
 129     public PDBResponseSummary(JSONObject doc, PDBRestRequest request)
 130     {
 131       Collection<PDBDocField> diplayFields = request.getWantedFields();
 132       String associatedSeq = request.getAssociatedSequence();
 133       int colCounter = 0;
 134       summaryRowData = new String[(associatedSeq != null) ? diplayFields
 135               .size() + 1 : diplayFields.size()];
 136       if (associatedSeq != null)
 137       {
 138         this.associatedSequence = (associatedSeq.length() > 18) ? associatedSeq
 139                 .substring(0, 18) : associatedSeq;
 140         summaryRowData[0] = associatedSequence;
 141         colCounter = 1;
 142       }
 143
 144       for (PDBDocField field : diplayFields)
 145       {
 146         String fieldData = (doc.get(field.getCode()) == null) ? "" : doc
 147                 .get(field.getCode()).toString();
 148         if (field.equals(PDBDocField.PDB_ID)
 149                 && doc.get(PDBDocField.PDB_ID.getCode()) != null)
 150         {
 151           this.pdbId = fieldData;
 152           summaryRowData[colCounter++] = this.pdbId;
 153         }
 154         else
 155         {
 156           summaryRowData[colCounter++] = fieldData;
 157         }
 158       }
 159     }
 160
 161     public String getPdbId()
 162     {
 163       return pdbId;
 164     }
 165
 166     public void setPdbId(String pdbId)
 167     {
 168       this.pdbId = pdbId;
 169     }
 170
 171     public String[] getSummaryData()
 172     {
 173       return summaryRowData;
 174     }
 175
 176     public void setSummaryData(String[] summaryData)
 177     {
 178       this.summaryRowData = summaryData;
 179     }
 180
 181     @Override
 182     public String toString()
 183     {
 184       StringBuilder summaryFieldValues = new StringBuilder();
 185       for (String summaryField : summaryRowData)
 186       {
 187         summaryFieldValues.append(summaryField).append("\t");
 188       }
 189       return summaryFieldValues.toString();
 190     }
 191
 192     @Override
 193     public int hashCode()
 194     {
 195       return Objects.hash(this.pdbId, this.toString());
 196     }
 197
 198     @Override
 199     public boolean equals(Object that)
 200     {
 201       if (!(that instanceof PDBResponseSummary))
 202       {
 203         return false;
 204       }
 205       PDBResponseSummary another = (PDBResponseSummary) that;
 206       return this.toString().equals(another.toString());
 207     }
 208
 209   }
 210
 211 }
 212