Merge develop to Release_2_8_3_Branch
[jalview.git] / src / jalview / gui / PDBSearchPanel.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.gui;
23
24 import jalview.jbgui.GPDBSearchPanel;
25 import jalview.jbgui.PDBDocFieldPreferences;
26 import jalview.util.MessageManager;
27 import jalview.ws.dbsources.PDBRestClient;
28 import jalview.ws.dbsources.PDBRestClient.PDBDocField;
29 import jalview.ws.uimodel.PDBRestRequest;
30 import jalview.ws.uimodel.PDBRestResponse;
31
32 import java.util.ArrayList;
33 import java.util.Collection;
34 import java.util.Collections;
35 import java.util.Comparator;
36 import java.util.List;
37
38 import javax.swing.table.DefaultTableModel;
39
40 @SuppressWarnings("serial")
41 public class PDBSearchPanel extends GPDBSearchPanel
42 {
43   private SequenceFetcher seqFetcher;
44
45   private IProgressIndicator progressIdicator;
46
47   private Collection<PDBDocField> wantedFields;
48
49   public PDBSearchPanel(SequenceFetcher seqFetcher)
50   {
51     this.seqFetcher = seqFetcher;
52     this.progressIdicator = (seqFetcher == null) ? null : seqFetcher
53             .getProgressIndicator();
54   }
55
56
57   /**
58    * Action performed when an input is detected on txt_search field.
59    */
60   @Override
61   public void txt_search_ActionPerformed()
62   {
63     boolean allowEmptySequence = false;
64     mainFrame.setTitle(MessageManager
65             .getString("label.pdb_sequence_getcher"));
66     tbl_summary.setModel(new DefaultTableModel());
67     if (txt_search.getText().trim().length() > 0)
68     {
69       long startTime = System.currentTimeMillis();
70
71       String searchTarget = ((PDBDocField) cmb_searchTarget
72               .getSelectedItem()).getCode();
73
74       wantedFields = PDBDocFieldPreferences
75               .getSearchSummaryFields();
76
77       PDBRestRequest request = new PDBRestRequest();
78       request.setAllowEmptySeq(allowEmptySequence);
79       request.setResponseSize(100);
80       request.setFieldToSearchBy(searchTarget + ":");
81       request.setSearchTerm(txt_search.getText());
82       request.setWantedFields(wantedFields);
83
84       PDBRestClient pdbRestCleint = new PDBRestClient();
85       PDBRestResponse resultList = pdbRestCleint.executeRequest(request);
86       if (resultList.getSearchSummary() != null)
87       {
88         tbl_summary.setModel(PDBRestResponse.getTableModel(request,
89                 resultList.getSearchSummary()));
90       }
91
92       long endTime = System.currentTimeMillis();
93       int resultSetCount = resultList.getNumberOfItemsFound();
94       String result = (resultSetCount > 1) ? MessageManager
95               .getString("label.results") : MessageManager
96               .getString("label.result");
97       mainFrame.setTitle(frameTitle + " - " + resultSetCount + " " + result
98               + " (" + (endTime - startTime) + " milli secs)");
99     }
100   }
101
102   @Override
103   public void btn_ok_ActionPerformed()
104   {
105     loadSelectedPDBSequencesToAlignment();
106   }
107
108   @Override
109   public void btn_back_ActionPerformed()
110   {
111     mainFrame.dispose();
112     new SequenceFetcher(progressIdicator);
113   }
114
115   @Override
116   public void btn_cancel_ActionPerformed()
117   {
118     mainFrame.dispose();
119   }
120
121   /**
122    * Add the discovered/selected sequences to a target alignment window
123    */
124   public void loadSelectedPDBSequencesToAlignment()
125   {
126     mainFrame.dispose();
127     StringBuilder selectedIds = new StringBuilder();
128     int pdbIdCol = PDBRestClient.getPDBIdColumIndex(wantedFields, false);
129     int[] selectedRows = tbl_summary.getSelectedRows();
130     for (int summaryRow : selectedRows)
131     {
132       String pdbIdStr = tbl_summary.getValueAt(summaryRow, pdbIdCol)
133               .toString();
134       selectedIds.append(";").append(pdbIdStr);
135     }
136
137     String ids = selectedIds.deleteCharAt(0).toString();
138     seqFetcher.textArea.setText(ids);
139     Thread worker = new Thread(seqFetcher);
140     worker.start();
141   }
142
143   /**
144    * Populates search target combo-box options
145    */
146   public void populateCmbSearchTargetOptions()
147   {
148     List<PDBDocField> searchableTargets = new ArrayList<PDBDocField>();
149     searchableTargets.add(PDBDocField.PDB_ID);
150     searchableTargets.add(PDBDocField.PFAM_ACCESSION);
151     searchableTargets.add(PDBDocField.MOLECULE_TYPE);
152     searchableTargets.add(PDBDocField.MOLECULE_NAME);
153     searchableTargets.add(PDBDocField.UNIPROT_ACCESSION);
154     searchableTargets.add(PDBDocField.GENE_NAME);
155     searchableTargets.add(PDBDocField.GENUS);
156     searchableTargets.add(PDBDocField.ALL);
157
158     Collections.sort(searchableTargets, new Comparator<PDBDocField>()
159     {
160       @Override
161       public int compare(PDBDocField o1, PDBDocField o2)
162       {
163         return o1.getName().compareTo(o2.getName());
164       }
165     });
166
167     for (PDBDocField searchTarget : searchableTargets)
168     {
169       cmb_searchTarget.addItem(searchTarget);
170     }
171   }
172
173 }