src/jalview/fts/service/pdb/PDBFTSPanel.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
  22 package jalview.fts.service.pdb;
  23
  24 import java.util.HashMap;
  25 import java.util.HashSet;
  26 import java.util.Map;
  27
  28 import javax.help.HelpSetException;
  29
  30 import jalview.fts.api.FTSDataColumnI;
  31 import jalview.fts.api.FTSRestClientI;
  32 import jalview.fts.core.FTSRestRequest;
  33 import jalview.fts.core.FTSRestResponse;
  34 import jalview.fts.core.GFTSPanel;
  35 import jalview.gui.Help;
  36 import jalview.gui.Help.HelpId;
  37 import jalview.gui.SequenceFetcher;
  38 import jalview.util.MessageManager;
  39
  40 @SuppressWarnings("serial")
  41 public class PDBFTSPanel extends GFTSPanel
  42 {
  43   private static String defaultFTSFrameTitle = MessageManager
  44           .getString("label.pdb_sequence_fetcher");
  45
  46   private static Map<String, Integer> tempUserPrefs = new HashMap<>();
  47
  48   private static final String PDB_FTS_CACHE_KEY = "CACHE.PDB_FTS";
  49
  50   private static final String PDB_AUTOSEARCH = "FTS.PDB.AUTOSEARCH";
  51
  52   public PDBFTSPanel(SequenceFetcher fetcher)
  53   {
  54     super(fetcher);
  55     pageLimit = PDBFTSRestClient.getInstance().getDefaultResponsePageSize();
  56     this.seqFetcher = fetcher;
  57     this.progressIndicator = (fetcher == null) ? null
  58             : fetcher.getProgressIndicator();
  59   }
  60
  61   @Override
  62   public void searchAction(boolean isFreshSearch)
  63   {
  64     mainFrame.requestFocusInWindow();
  65     if (isFreshSearch)
  66     {
  67       offSet = 0;
  68     }
  69     new Thread()
  70     {
  71       @Override
  72       public void run()
  73       {
  74         reset();
  75         boolean allowEmptySequence = false;
  76         if (getTypedText().length() > 0)
  77         {
  78           setSearchInProgress(true);
  79           long startTime = System.currentTimeMillis();
  80
  81           String searchTarget = ((FTSDataColumnI) cmb_searchTarget
  82                   .getSelectedItem()).getCode();
  83           wantedFields = PDBFTSRestClient.getInstance()
  84                   .getAllDefaultDisplayedFTSDataColumns();
  85           String searchTerm = decodeSearchTerm(getTypedText(),
  86                   searchTarget);
  87
  88           FTSRestRequest request = new FTSRestRequest();
  89           request.setAllowEmptySeq(allowEmptySequence);
  90           request.setResponseSize(100);
  91           request.setFieldToSearchBy("(" + searchTarget + ":");
  92           request.setSearchTerm(searchTerm + ")");
  93           request.setOffSet(offSet);
  94           request.setWantedFields(wantedFields);
  95           FTSRestClientI pdbRestClient = PDBFTSRestClient.getInstance();
  96           FTSRestResponse resultList;
  97           try
  98           {
  99             resultList = pdbRestClient.executeRequest(request);
 100           } catch (Exception e)
 101           {
 102             setErrorMessage(e.getMessage());
 103             checkForErrors();
 104             setSearchInProgress(false);
 105             return;
 106           }
 107
 108           if (resultList.getSearchSummary() != null
 109                   && resultList.getSearchSummary().size() > 0)
 110           {
 111             getResultTable().setModel(FTSRestResponse.getTableModel(request,
 112                     resultList.getSearchSummary()));
 113             FTSRestResponse.configureTableColumn(getResultTable(),
 114                     wantedFields, tempUserPrefs);
 115             getResultTable().setVisible(true);
 116           }
 117
 118           long endTime = System.currentTimeMillis();
 119           totalResultSetCount = resultList.getNumberOfItemsFound();
 120           resultSetCount = resultList.getSearchSummary() == null ? 0
 121                   : resultList.getSearchSummary().size();
 122           String result = (resultSetCount > 0)
 123                   ? MessageManager.getString("label.results")
 124                   : MessageManager.getString("label.result");
 125
 126           if (isPaginationEnabled() && resultSetCount > 0)
 127           {
 128             String f1 = totalNumberformatter
 129                     .format(Integer.valueOf(offSet + 1));
 130             String f2 = totalNumberformatter
 131                     .format(Integer.valueOf(offSet + resultSetCount));
 132             String f3 = totalNumberformatter
 133                     .format(Integer.valueOf(totalResultSetCount));
 134             updateSearchFrameTitle(defaultFTSFrameTitle + " - " + result
 135                     + " " + f1 + " to " + f2 + " of " + f3 + " " + " ("
 136                     + (endTime - startTime) + " milli secs)");
 137           }
 138           else
 139           {
 140             updateSearchFrameTitle(defaultFTSFrameTitle + " - "
 141                     + resultSetCount + " " + result + " ("
 142                     + (endTime - startTime) + " milli secs)");
 143           }
 144
 145           setSearchInProgress(false);
 146           refreshPaginatorState();
 147           updateSummaryTableSelections();
 148         }
 149         txt_search.updateCache();
 150       }
 151     }.start();
 152   }
 153
 154   public static String decodeSearchTerm(String enteredText,
 155           String targetField)
 156   {
 157     String foundSearchTerms = enteredText;
 158     StringBuilder foundSearchTermsBuilder = new StringBuilder();
 159     if (enteredText.contains(";"))
 160     {
 161       String[] searchTerms = enteredText.split(";");
 162       for (String searchTerm : searchTerms)
 163       {
 164         if (searchTerm.contains(":"))
 165         {
 166           foundSearchTermsBuilder.append(targetField).append(":")
 167                   .append(searchTerm.split(":")[0]).append(" OR ");
 168         }
 169         else
 170         {
 171           foundSearchTermsBuilder.append(targetField).append(":")
 172                   .append(searchTerm).append(" OR ");
 173         }
 174       }
 175       int endIndex = foundSearchTermsBuilder.lastIndexOf(" OR ");
 176       foundSearchTerms = foundSearchTermsBuilder.toString();
 177       if (foundSearchTerms.contains(" OR "))
 178       {
 179         foundSearchTerms = foundSearchTerms
 180                 .substring(targetField.length() + 1, endIndex);
 181       }
 182     }
 183     else if (enteredText.contains(":"))
 184     {
 185       foundSearchTerms = foundSearchTerms.split(":")[0];
 186     }
 187     return foundSearchTerms;
 188   }
 189
 190   @Override
 191   public void okAction()
 192   {
 193     // mainFrame.dispose();
 194     disableActionButtons();
 195     StringBuilder selectedIds = new StringBuilder();
 196     HashSet<String> selectedIdsSet = new HashSet<>();
 197     int primaryKeyColIndex = 0;
 198     try
 199     {
 200       primaryKeyColIndex = getFTSRestClient()
 201               .getPrimaryKeyColumIndex(wantedFields, false);
 202     } catch (Exception e)
 203     {
 204       e.printStackTrace();
 205     }
 206     int[] selectedRows = getResultTable().getSelectedRows();
 207     String searchTerm = getTypedText();
 208     for (int summaryRow : selectedRows)
 209     {
 210       String idStr = getResultTable()
 211               .getValueAt(summaryRow, primaryKeyColIndex).toString();
 212       selectedIdsSet.add(getPDBIdwithSpecifiedChain(idStr, searchTerm));
 213     }
 214
 215     for (String idStr : paginatorCart)
 216     {
 217       selectedIdsSet.add(getPDBIdwithSpecifiedChain(idStr, searchTerm));
 218     }
 219
 220     for (String selectedId : selectedIdsSet)
 221     {
 222       selectedIds.append(selectedId).append(";");
 223     }
 224
 225     String ids = selectedIds.toString();
 226     seqFetcher.setQuery(ids);
 227     Thread worker = new Thread(seqFetcher);
 228     worker.start();
 229     delayAndEnableActionButtons();
 230   }
 231
 232   public static String getPDBIdwithSpecifiedChain(String pdbId,
 233           String searchTerm)
 234   {
 235     String pdbIdWithChainCode = "";
 236     if (searchTerm.contains(";"))
 237     {
 238       String[] foundTerms = searchTerm.split(";");
 239       for (String foundTerm : foundTerms)
 240       {
 241         if (foundTerm.contains(pdbId))
 242         {
 243           pdbIdWithChainCode = foundTerm;
 244         }
 245       }
 246     }
 247     else if (searchTerm.contains(pdbId))
 248     {
 249       pdbIdWithChainCode = searchTerm;
 250     }
 251     else
 252     {
 253       pdbIdWithChainCode = pdbId;
 254     }
 255     return pdbIdWithChainCode;
 256   }
 257
 258   @Override
 259   public FTSRestClientI getFTSRestClient()
 260   {
 261     return PDBFTSRestClient.getInstance();
 262   }
 263
 264   @Override
 265   public String getFTSFrameTitle()
 266   {
 267     return defaultFTSFrameTitle;
 268   }
 269
 270   @Override
 271   public boolean isPaginationEnabled()
 272   {
 273     return true;
 274   }
 275
 276   @Override
 277   public Map<String, Integer> getTempUserPrefs()
 278   {
 279     return tempUserPrefs;
 280   }
 281
 282   @Override
 283   public String getCacheKey()
 284   {
 285     return PDB_FTS_CACHE_KEY;
 286   }
 287
 288   @Override
 289   public String getAutosearchPreference()
 290   {
 291     return PDB_AUTOSEARCH;
 292   }
 293
 294   @Override
 295   protected void showHelp()
 296   {
 297     try
 298     {
 299       Help.showHelpWindow(HelpId.PdbFts);
 300     } catch (HelpSetException e1)
 301     {
 302       e1.printStackTrace();
 303     }
 304   }
 305
 306   public String getDbName()
 307   {
 308     return "PDB";
 309   }
 310 }