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 jalview.fts.api.FTSDataColumnI;
  25 import jalview.fts.api.FTSRestClientI;
  26 import jalview.fts.core.FTSRestRequest;
  27 import jalview.fts.core.FTSRestResponse;
  28 import jalview.fts.core.GFTSPanel;
  29 import jalview.gui.Help;
  30 import jalview.gui.Help.HelpId;
  31 import jalview.gui.SequenceFetcher;
  32 import jalview.util.MessageManager;
  33
  34 import java.util.HashMap;
  35 import java.util.HashSet;
  36 import java.util.Map;
  37
  38 import javax.help.HelpSetException;
  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.format(Integer.valueOf(offSet + 1));
 129             String f2 = totalNumberformatter
 130                     .format(Integer.valueOf(offSet + resultSetCount));
 131             String f3 = totalNumberformatter
 132                     .format(Integer.valueOf(totalResultSetCount));
 133             updateSearchFrameTitle(defaultFTSFrameTitle + " - " + result
 134                     + " " + f1 + " to " + f2 + " of " + f3 + " " + " ("
 135                     + (endTime - startTime) + " milli secs)");
 136           }
 137           else
 138           {
 139             updateSearchFrameTitle(defaultFTSFrameTitle + " - "
 140                     + resultSetCount + " " + result + " ("
 141                     + (endTime - startTime) + " milli secs)");
 142           }
 143
 144           setSearchInProgress(false);
 145           refreshPaginatorState();
 146           updateSummaryTableSelections();
 147         }
 148         txt_search.updateCache();
 149       }
 150     }.start();
 151   }
 152
 153   public static String decodeSearchTerm(String enteredText,
 154           String targetField)
 155   {
 156     String foundSearchTerms = enteredText;
 157     StringBuilder foundSearchTermsBuilder = new StringBuilder();
 158     if (enteredText.contains(";"))
 159     {
 160       String[] searchTerms = enteredText.split(";");
 161       for (String searchTerm : searchTerms)
 162       {
 163         if (searchTerm.contains(":"))
 164         {
 165           foundSearchTermsBuilder.append(targetField).append(":")
 166                   .append(searchTerm.split(":")[0]).append(" OR ");
 167         }
 168         else
 169         {
 170           foundSearchTermsBuilder.append(targetField).append(":")
 171                   .append(searchTerm).append(" OR ");
 172         }
 173       }
 174       int endIndex = foundSearchTermsBuilder.lastIndexOf(" OR ");
 175       foundSearchTerms = foundSearchTermsBuilder.toString();
 176       if (foundSearchTerms.contains(" OR "))
 177       {
 178         foundSearchTerms = foundSearchTerms
 179                 .substring(targetField.length() + 1, endIndex);
 180       }
 181     }
 182     else if (enteredText.contains(":"))
 183     {
 184       foundSearchTerms = foundSearchTerms.split(":")[0];
 185     }
 186     return foundSearchTerms;
 187   }
 188
 189   @Override
 190   public void okAction()
 191   {
 192     // mainFrame.dispose();
 193     disableActionButtons();
 194     StringBuilder selectedIds = new StringBuilder();
 195     HashSet<String> selectedIdsSet = new HashSet<>();
 196     int primaryKeyColIndex = 0;
 197     try
 198     {
 199       primaryKeyColIndex = getFTSRestClient()
 200               .getPrimaryKeyColumIndex(wantedFields, false);
 201     } catch (Exception e)
 202     {
 203       e.printStackTrace();
 204     }
 205     int[] selectedRows = getResultTable().getSelectedRows();
 206     String searchTerm = getTypedText();
 207     for (int summaryRow : selectedRows)
 208     {
 209       String idStr = getResultTable()
 210               .getValueAt(summaryRow, primaryKeyColIndex).toString();
 211       selectedIdsSet.add(getPDBIdwithSpecifiedChain(idStr, searchTerm));
 212     }
 213
 214     for (String idStr : paginatorCart)
 215     {
 216       selectedIdsSet.add(getPDBIdwithSpecifiedChain(idStr, searchTerm));
 217     }
 218
 219     for (String selectedId : selectedIdsSet)
 220     {
 221       selectedIds.append(selectedId).append(";");
 222     }
 223
 224     String ids = selectedIds.toString();
 225     seqFetcher.fetch(ids, true);
 226     delayAndEnableActionButtons();
 227   }
 228
 229   public static String getPDBIdwithSpecifiedChain(String pdbId,
 230           String searchTerm)
 231   {
 232     String pdbIdWithChainCode = "";
 233     if (searchTerm.contains(";"))
 234     {
 235       String[] foundTerms = searchTerm.split(";");
 236       for (String foundTerm : foundTerms)
 237       {
 238         if (foundTerm.contains(pdbId))
 239         {
 240           pdbIdWithChainCode = foundTerm;
 241         }
 242       }
 243     }
 244     else if (searchTerm.contains(pdbId))
 245     {
 246       pdbIdWithChainCode = searchTerm;
 247     }
 248     else
 249     {
 250       pdbIdWithChainCode = pdbId;
 251     }
 252     return pdbIdWithChainCode;
 253   }
 254
 255   @Override
 256   public FTSRestClientI getFTSRestClient()
 257   {
 258     return PDBFTSRestClient.getInstance();
 259   }
 260
 261   @Override
 262   public String getFTSFrameTitle()
 263   {
 264     return defaultFTSFrameTitle;
 265   }
 266
 267   @Override
 268   public boolean isPaginationEnabled()
 269   {
 270     return true;
 271   }
 272
 273   @Override
 274   public Map<String, Integer> getTempUserPrefs()
 275   {
 276     return tempUserPrefs;
 277   }
 278
 279   @Override
 280   public String getCacheKey()
 281   {
 282     return PDB_FTS_CACHE_KEY;
 283   }
 284
 285   @Override
 286   public String getAutosearchPreference()
 287   {
 288     return PDB_AUTOSEARCH;
 289   }
 290
 291   @Override
 292   protected void showHelp()
 293   {
 294     try
 295     {
 296       Help.showHelpWindow(HelpId.PdbFts);
 297     } catch (HelpSetException e1)
 298     {
 299       e1.printStackTrace();
 300     }
 301  }
 302 }