JAL-1563 house keeping/updated API doc for new method added for FTS pagination
[jalview.git] / src / jalview / fts / service / uniprot / UniprotFTSPanel.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.uniprot;
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.SequenceFetcher;
30 import jalview.util.MessageManager;
31
32 import java.util.HashSet;
33
34 @SuppressWarnings("serial")
35 public class UniprotFTSPanel extends GFTSPanel
36 {
37
38   private static String defaultFTSFrameTitle = MessageManager
39           .getString("label.uniprot_sequence_fetcher");
40
41   private String ftsFrameTitle = defaultFTSFrameTitle;
42
43   private int resultSetCount;
44
45   private int offSet;
46
47   private static int pageLimit = UniProtFTSRestClient.getInstance()
48           .getDefaultResponsePageSize();
49
50   public UniprotFTSPanel(SequenceFetcher seqFetcher)
51   {
52     this.seqFetcher = seqFetcher;
53     this.progressIdicator = (seqFetcher == null) ? null : seqFetcher
54             .getProgressIndicator();
55   }
56
57   @Override
58   public void searchAction()
59   {
60     offSet = 0;
61     executeSearch();
62   }
63
64   public void executeSearch()
65   {
66     new Thread()
67   {
68       @Override
69       public void run()
70       {
71         ftsFrameTitle = defaultFTSFrameTitle;
72         reset();
73         if (getTypedText().length() > 0)
74         {
75           setSearchInProgress(true);
76           long startTime = System.currentTimeMillis();
77
78           String searchTarget = ((FTSDataColumnI) cmb_searchTarget
79                   .getSelectedItem()).getAltCode();
80
81           wantedFields = UniProtFTSRestClient.getInstance()
82                   .getAllDefaulDisplayedDataColumns();
83           String searchTerm = txt_search.getText();
84
85           FTSRestRequest request = new FTSRestRequest();
86           request.setFieldToSearchBy(searchTarget);
87           request.setSearchTerm(searchTerm);
88           request.setOffSet(offSet);
89           request.setWantedFields(wantedFields);
90           FTSRestClientI uniProtRestCleint = UniProtFTSRestClient
91                   .getInstance();
92           FTSRestResponse resultList;
93           try
94           {
95             resultList = uniProtRestCleint.executeRequest(request);
96           } catch (Exception e)
97           {
98             e.printStackTrace();
99             setErrorMessage(e.getMessage());
100             checkForErrors();
101             return;
102           }
103
104           if (resultList.getSearchSummary() != null
105                   && resultList.getSearchSummary().size() > 0)
106           {
107             getResultTable().setModel(
108                     FTSRestResponse.getTableModel(request,
109                             resultList.getSearchSummary()));
110             FTSRestResponse.configureTableColumn(getResultTable(),
111                     wantedFields);
112             getResultTable().setVisible(true);
113           }
114
115           long endTime = System.currentTimeMillis();
116           resultSetCount = resultList.getNumberOfItemsFound();
117           String result = (resultSetCount > 1) ? MessageManager
118                   .getString("label.results") : MessageManager
119                   .getString("label.result");
120           if (isPaginationEnabled() && resultSetCount > 1)
121           {
122             updateSearchFrameTitle(defaultFTSFrameTitle + " - " + result
123                     + " " + offSet + " to " + (offSet + resultSetCount)
124                     + " " + " (" + (endTime - startTime) + " milli secs)");
125           }
126           else
127           {
128             updateSearchFrameTitle(defaultFTSFrameTitle + " - "
129                     + resultSetCount + " " + result + " ("
130                     + (endTime - startTime) + " milli secs)");
131           }
132           setSearchInProgress(false);
133           refreshPaginatorState();
134         }
135       }
136     }.start();
137
138   }
139
140
141
142   public void refreshPaginatorState()
143   {
144     // System.out.println("resultSet count : " + resultSetCount);
145     // System.out.println("offSet : " + offSet);
146     // System.out.println("page limit : " + pageLimit);
147     setPrevPageButtonEnabled(false);
148     setNextPageButtonEnabled(false);
149     if (resultSetCount >= pageLimit)
150     {
151       setNextPageButtonEnabled(true);
152     }
153     if (offSet >= pageLimit)
154     {
155       setPrevPageButtonEnabled(true);
156     }
157   }
158
159   @Override
160   public void prevPageAction()
161   {
162     if (offSet >= pageLimit)
163     {
164       offSet = offSet - pageLimit;
165       executeSearch();
166     }else{
167       refreshPaginatorState();
168     }
169   }
170
171   @Override
172   public void nextPageAction()
173   {
174     offSet = offSet + pageLimit;
175     executeSearch();
176
177   }
178
179   @Override
180   public boolean isPaginationEnabled()
181   {
182     return true;
183   }
184
185   @Override
186   public void okAction()
187   {
188     disableActionButtons();
189     StringBuilder selectedIds = new StringBuilder();
190     HashSet<String> selectedIdsSet = new HashSet<String>();
191     int primaryKeyColIndex = 0;
192     try
193     {
194       primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
195               wantedFields, false);
196     } catch (Exception e)
197     {
198       e.printStackTrace();
199     }
200     int[] selectedRows = getResultTable().getSelectedRows();
201     for (int summaryRow : selectedRows)
202     {
203       String idStr = getResultTable().getValueAt(summaryRow,
204               primaryKeyColIndex).toString();
205       selectedIdsSet.add(idStr);
206     }
207
208     for (String selectedId : selectedIdsSet)
209     {
210       selectedIds.append(selectedId).append(";");
211     }
212
213     String ids = selectedIds.toString();
214     // System.out.println(">>>>>>>>>>>>>>>> selected Ids: " + ids);
215     seqFetcher.getTextArea().setText(ids);
216     Thread worker = new Thread(seqFetcher);
217     worker.start();
218     delayAndEnableActionButtons();
219   }
220
221   @Override
222   public FTSRestClientI getFTSRestClient()
223   {
224     return UniProtFTSRestClient.getInstance();
225   }
226
227   @Override
228   public String getFTSFrameTitle()
229   {
230     return ftsFrameTitle;
231   }
232
233 }