JAL-1563 Fixed Uniprot FTS result-set count error, added blank image placeholder...
[jalview.git] / src / jalview / fts / core / GFTSPanel.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.core;
23
24 import jalview.fts.api.FTSDataColumnI;
25 import jalview.fts.api.GFTSPanelI;
26 import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
27 import jalview.gui.Desktop;
28 import jalview.gui.IProgressIndicator;
29 import jalview.gui.JvSwingUtils;
30 import jalview.gui.SequenceFetcher;
31 import jalview.util.MessageManager;
32
33 import java.awt.BorderLayout;
34 import java.awt.CardLayout;
35 import java.awt.Dimension;
36 import java.awt.event.ActionEvent;
37 import java.awt.event.ActionListener;
38 import java.awt.event.FocusEvent;
39 import java.awt.event.FocusListener;
40 import java.awt.event.KeyAdapter;
41 import java.awt.event.KeyEvent;
42 import java.awt.event.MouseAdapter;
43 import java.awt.event.MouseEvent;
44 import java.util.ArrayList;
45 import java.util.Arrays;
46 import java.util.Collection;
47 import java.util.Collections;
48 import java.util.Comparator;
49 import java.util.List;
50
51 import javax.swing.ImageIcon;
52 import javax.swing.JButton;
53 import javax.swing.JComboBox;
54 import javax.swing.JFrame;
55 import javax.swing.JInternalFrame;
56 import javax.swing.JLabel;
57 import javax.swing.JPanel;
58 import javax.swing.JScrollPane;
59 import javax.swing.JTabbedPane;
60 import javax.swing.JTable;
61 import javax.swing.JTextField;
62 import javax.swing.Timer;
63 import javax.swing.event.ChangeEvent;
64 import javax.swing.event.ChangeListener;
65 import javax.swing.event.DocumentEvent;
66 import javax.swing.event.DocumentListener;
67 import javax.swing.table.DefaultTableModel;
68 import javax.swing.table.TableColumn;
69
70 /**
71  * This class provides the swing GUI layout for FTS Panel and implements most of
72  * the contracts defined in GFSPanelI
73  * 
74  * @author tcnofoegbu
75  *
76  */
77
78 @SuppressWarnings("serial")
79 public abstract class GFTSPanel extends JPanel implements GFTSPanelI
80 {
81   protected JInternalFrame mainFrame = new JInternalFrame(
82           getFTSFrameTitle());
83
84   protected IProgressIndicator progressIdicator;
85
86   protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
87
88   protected JButton btn_ok = new JButton();
89
90   protected JButton btn_back = new JButton();
91
92   protected JButton btn_cancel = new JButton();
93
94   protected JTextField txt_search = new JTextField(30);
95
96   protected SequenceFetcher seqFetcher;
97
98   protected Collection<FTSDataColumnI> wantedFields;
99
100   private String lastSearchTerm = "";
101
102   protected JButton btn_next_page = new JButton();
103
104   protected JButton btn_prev_page = new JButton();
105
106   private JTable tbl_summary = new JTable()
107   {
108     private boolean inLayout;
109
110     @Override
111     public boolean getScrollableTracksViewportWidth()
112     {
113       return hasExcessWidth();
114
115     }
116
117     @Override
118     public void doLayout()
119     {
120       if (hasExcessWidth())
121       {
122         autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
123       }
124       inLayout = true;
125       super.doLayout();
126       inLayout = false;
127       autoResizeMode = AUTO_RESIZE_OFF;
128     }
129
130     protected boolean hasExcessWidth()
131     {
132       return getPreferredSize().width < getParent().getWidth();
133     }
134
135     @Override
136     public void columnMarginChanged(ChangeEvent e)
137     {
138       if (isEditing())
139       {
140         removeEditor();
141       }
142       TableColumn resizingColumn = getTableHeader().getResizingColumn();
143       // Need to do this here, before the parent's
144       // layout manager calls getPreferredSize().
145       if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
146               && !inLayout)
147       {
148         resizingColumn.setPreferredWidth(resizingColumn.getWidth());
149       }
150       resizeAndRepaint();
151     }
152
153     @Override
154     public String getToolTipText(MouseEvent evt)
155     {
156       String toolTipText = null;
157       java.awt.Point pnt = evt.getPoint();
158       int rowIndex = rowAtPoint(pnt);
159       int colIndex = columnAtPoint(pnt);
160
161       try
162       {
163         if (getValueAt(rowIndex, colIndex) == null)
164         {
165           return null;
166         }
167         toolTipText = getValueAt(rowIndex, colIndex).toString();
168
169       } catch (Exception e)
170       {
171         e.printStackTrace();
172       }
173       toolTipText = (toolTipText == null ? null
174               : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
175                       true, toolTipText.subSequence(0, 500) + "...")
176                       : JvSwingUtils.wrapTooltip(true, toolTipText)));
177
178       return toolTipText;
179     }
180   };
181
182   protected StringBuilder errorWarning = new StringBuilder();
183
184   protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
185
186   protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
187           "/images/warning.gif"));
188
189   protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
190           "/images/loading.gif"));
191
192   protected ImageIcon balnkPlaceholderImage = new ImageIcon(getClass()
193           .getResource("/images/blank_16x16_placeholder.png"));
194
195   protected JLabel lbl_warning = new JLabel(warningImage);
196
197   protected JLabel lbl_loading = new JLabel(loadingImage);
198
199   protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
200
201   private JTabbedPane tabbedPane = new JTabbedPane();
202
203   private JPanel pnl_actions = new JPanel();
204
205   private JPanel pnl_results = new JPanel(new CardLayout());
206
207   private JPanel pnl_inputs = new JPanel();
208
209   private BorderLayout mainLayout = new BorderLayout();
210
211   protected Object[] previousWantedFields;
212
213   public GFTSPanel()
214   {
215     try
216     {
217       jbInit();
218       mainFrame.invalidate();
219       mainFrame.pack();
220     } catch (Exception e)
221     {
222       e.printStackTrace();
223     }
224   }
225
226   /**
227    * Initializes the GUI default properties
228    * 
229    * @throws Exception
230    */
231   private void jbInit() throws Exception
232   {
233     lbl_warning.setVisible(false);
234     lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
235     lbl_loading.setVisible(false);
236     lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
237     lbl_blank.setVisible(true);
238     lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
239
240     tbl_summary.setAutoCreateRowSorter(true);
241     tbl_summary.getTableHeader().setReorderingAllowed(false);
242     tbl_summary.addMouseListener(new MouseAdapter()
243     {
244       @Override
245       public void mouseClicked(MouseEvent e)
246       {
247         validateSelection();
248       }
249
250       @Override
251       public void mouseReleased(MouseEvent e)
252       {
253         validateSelection();
254       }
255     });
256     tbl_summary.addKeyListener(new KeyAdapter()
257     {
258       @Override
259       public void keyPressed(KeyEvent evt)
260       {
261         validateSelection();
262         switch (evt.getKeyCode())
263         {
264         case KeyEvent.VK_ESCAPE: // escape key
265           btn_back_ActionPerformed();
266           break;
267         case KeyEvent.VK_ENTER: // enter key
268           if (btn_ok.isEnabled())
269           {
270             okAction();
271           }
272           evt.consume();
273           break;
274         case KeyEvent.VK_TAB: // tab key
275           if (evt.isShiftDown())
276           {
277             tabbedPane.requestFocus();
278           }
279           else
280           {
281             btn_back.requestFocus();
282           }
283           evt.consume();
284           break;
285         default:
286           return;
287         }
288       }
289     });
290
291     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
292     btn_back.setText(MessageManager.getString("action.back"));
293     btn_back.addActionListener(new java.awt.event.ActionListener()
294     {
295       @Override
296       public void actionPerformed(ActionEvent e)
297       {
298         btn_back_ActionPerformed();
299       }
300     });
301     btn_back.addKeyListener(new KeyAdapter()
302     {
303       @Override
304       public void keyPressed(KeyEvent evt)
305       {
306         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
307         {
308           btn_back_ActionPerformed();
309         }
310       }
311     });
312
313     btn_ok.setEnabled(false);
314     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
315     btn_ok.setText(MessageManager.getString("action.ok"));
316     btn_ok.addActionListener(new java.awt.event.ActionListener()
317     {
318       @Override
319       public void actionPerformed(ActionEvent e)
320       {
321         okAction();
322       }
323     });
324     btn_ok.addKeyListener(new KeyAdapter()
325     {
326       @Override
327       public void keyPressed(KeyEvent evt)
328       {
329         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
330         {
331           okAction();
332         }
333       }
334     });
335
336     btn_next_page.setEnabled(false);
337     btn_next_page.setToolTipText(MessageManager
338             .getString("label.next_page_tooltop"));
339     btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
340     btn_next_page.setText(MessageManager.getString("action.next_page"));
341     btn_next_page.addActionListener(new java.awt.event.ActionListener()
342     {
343       @Override
344       public void actionPerformed(ActionEvent e)
345       {
346         nextPageAction();
347       }
348     });
349     btn_next_page.addKeyListener(new KeyAdapter()
350     {
351       @Override
352       public void keyPressed(KeyEvent evt)
353       {
354         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
355         {
356           nextPageAction();
357         }
358       }
359     });
360
361     btn_prev_page.setEnabled(false);
362     btn_prev_page.setToolTipText(MessageManager
363             .getString("label.prev_page_tooltop"));
364     btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
365     btn_prev_page.setText(MessageManager.getString("action.prev_page"));
366     btn_prev_page.addActionListener(new java.awt.event.ActionListener()
367     {
368       @Override
369       public void actionPerformed(ActionEvent e)
370       {
371         prevPageAction();
372       }
373     });
374     btn_prev_page.addKeyListener(new KeyAdapter()
375     {
376       @Override
377       public void keyPressed(KeyEvent evt)
378       {
379         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
380         {
381           prevPageAction();
382         }
383       }
384     });
385
386     if (isPaginationEnabled())
387     {
388       btn_prev_page.setVisible(true);
389       btn_next_page.setVisible(true);
390     }
391     else
392     {
393       btn_prev_page.setVisible(false);
394       btn_next_page.setVisible(false);
395     }
396
397     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
398     btn_cancel.setText(MessageManager.getString("action.cancel"));
399     btn_cancel.addActionListener(new java.awt.event.ActionListener()
400     {
401       @Override
402       public void actionPerformed(ActionEvent e)
403       {
404         btn_cancel_ActionPerformed();
405       }
406     });
407     btn_cancel.addKeyListener(new KeyAdapter()
408     {
409       @Override
410       public void keyPressed(KeyEvent evt)
411       {
412         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
413         {
414           btn_cancel_ActionPerformed();
415         }
416       }
417     });
418     scrl_searchResult.setPreferredSize(new Dimension(800, 400));
419
420     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
421     cmb_searchTarget.addActionListener(new ActionListener()
422     {
423       @Override
424       public void actionPerformed(ActionEvent e)
425       {
426         String tooltipText;
427         if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
428                 .toString()))
429         {
430           tooltipText = MessageManager.getString("label.search_all");
431         }
432         else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
433                 .getSelectedItem().toString()))
434         {
435           tooltipText = MessageManager
436                   .getString("label.separate_multiple_accession_ids");
437         }
438         else
439         {
440           tooltipText = MessageManager.formatMessage(
441                   "label.separate_multiple_query_values",
442                   new Object[] { getCmbSearchTarget().getSelectedItem()
443                           .toString() });
444         }
445         txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
446                 tooltipText));
447         searchAction();
448       }
449     });
450
451     populateCmbSearchTargetOptions();
452
453     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
454
455     txt_search.addKeyListener(new KeyAdapter()
456     {
457       @Override
458       public void keyPressed(KeyEvent e)
459       {
460         if (e.getKeyCode() == KeyEvent.VK_ENTER)
461         {
462           if (txt_search.getText() == null
463                   || txt_search.getText().isEmpty())
464           {
465             return;
466           }
467           String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
468                   .getName();
469           if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
470                   .getSelectedItem().toString()))
471           {
472             transferToSequenceFetcher(txt_search.getText());
473           }
474         }
475       }
476     });
477
478     final DeferredTextInputListener listener = new DeferredTextInputListener(
479             1500,
480             new ActionListener()
481             {
482               @Override
483               public void actionPerformed(ActionEvent e)
484               {
485                 if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
486                 {
487                   searchAction();
488                   lastSearchTerm = getTypedText();
489                 }
490               }
491             }, false);
492     txt_search.getDocument().addDocumentListener(listener);
493     txt_search.addFocusListener(new FocusListener()
494     {
495       @Override
496       public void focusGained(FocusEvent e)
497       {
498         listener.start();
499       }
500
501       @Override
502       public void focusLost(FocusEvent e)
503       {
504 //        listener.stop();
505       }
506     });
507
508     final String searchTabTitle = MessageManager
509             .getString("label.search_result");
510     final String configureCols = MessageManager
511             .getString("label.configure_displayed_columns");
512     ChangeListener changeListener = new ChangeListener()
513     {
514       @Override
515       public void stateChanged(ChangeEvent changeEvent)
516       {
517         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
518                 .getSource();
519         int index = sourceTabbedPane.getSelectedIndex();
520
521         btn_back.setVisible(true);
522         btn_cancel.setVisible(true);
523         btn_ok.setVisible(true);
524         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
525         {
526           btn_back.setVisible(false);
527           btn_cancel.setVisible(false);
528           btn_ok.setVisible(false);
529           btn_back.setEnabled(false);
530           btn_cancel.setEnabled(false);
531           btn_ok.setEnabled(false);
532           previousWantedFields = getFTSRestClient()
533                   .getAllDefaulDisplayedDataColumns()
534                   .toArray(new Object[0]);
535         }
536         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
537         {
538           btn_back.setEnabled(true);
539           btn_cancel.setEnabled(true);
540           if (wantedFieldsUpdated())
541           {
542             searchAction();
543           }
544           else
545           {
546             validateSelection();
547           }
548         }
549       }
550     };
551     tabbedPane.addChangeListener(changeListener);
552     tabbedPane.setPreferredSize(new Dimension(800, 400));
553     tabbedPane.add(searchTabTitle, scrl_searchResult);
554     tabbedPane.add(configureCols, new FTSDataColumnPreferences(
555             PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
556
557     pnl_actions.add(btn_back);
558     pnl_actions.add(btn_ok);
559     pnl_actions.add(btn_cancel);
560
561     pnl_results.add(tabbedPane);
562     pnl_inputs.add(cmb_searchTarget);
563     pnl_inputs.add(txt_search);
564     pnl_inputs.add(lbl_loading);
565     pnl_inputs.add(lbl_warning);
566     pnl_inputs.add(lbl_blank);
567     pnl_inputs.add(btn_prev_page);
568     pnl_inputs.add(btn_next_page);
569
570     this.setLayout(mainLayout);
571     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
572     this.add(pnl_results, java.awt.BorderLayout.CENTER);
573     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
574     mainFrame.setVisible(true);
575     mainFrame.setContentPane(this);
576     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
577     Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), 900, 500);
578   }
579
580   public class DeferredTextInputListener implements DocumentListener
581   {
582     private final Timer swingTimer;
583
584     public DeferredTextInputListener(int timeOut, ActionListener listener,
585             boolean repeats)
586     {
587       swingTimer = new Timer(timeOut, listener);
588       swingTimer.setRepeats(repeats);
589     }
590
591     public void start()
592     {
593       swingTimer.start();
594     }
595
596     public void stop()
597     {
598       swingTimer.stop();
599     }
600
601     @Override
602     public void insertUpdate(DocumentEvent e)
603     {
604       swingTimer.restart();
605     }
606
607     @Override
608     public void removeUpdate(DocumentEvent e)
609     {
610       swingTimer.restart();
611     }
612
613     @Override
614     public void changedUpdate(DocumentEvent e)
615     {
616       swingTimer.restart();
617     }
618
619   }
620
621   public boolean wantedFieldsUpdated()
622   {
623     if (previousWantedFields == null)
624     {
625       return true;
626     }
627
628     return Arrays.equals(getFTSRestClient()
629             .getAllDefaulDisplayedDataColumns()
630             .toArray(new Object[0]), previousWantedFields) ? false
631             : true;
632
633   }
634
635   public void validateSelection()
636   {
637     if (tbl_summary.getSelectedRows().length > 0)
638     {
639       btn_ok.setEnabled(true);
640     }
641     else
642     {
643       btn_ok.setEnabled(false);
644     }
645   }
646
647   public JComboBox<FTSDataColumnI> getCmbSearchTarget()
648   {
649     return cmb_searchTarget;
650   }
651
652   public JTextField getTxtSearch()
653   {
654     return txt_search;
655   }
656
657   public JInternalFrame getMainFrame()
658   {
659     return mainFrame;
660   }
661
662   protected void delayAndEnableActionButtons()
663   {
664     new Thread()
665     {
666       @Override
667       public void run()
668       {
669         try
670         {
671           Thread.sleep(1500);
672         } catch (InterruptedException e)
673         {
674           e.printStackTrace();
675         }
676         btn_ok.setEnabled(true);
677         btn_back.setEnabled(true);
678         btn_cancel.setEnabled(true);
679       }
680     }.start();
681   }
682
683   protected void checkForErrors()
684   {
685     lbl_warning.setVisible(false);
686     lbl_blank.setVisible(true);
687     if (errorWarning.length() > 0)
688     {
689       lbl_loading.setVisible(false);
690       lbl_blank.setVisible(false);
691       lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
692               errorWarning.toString()));
693       lbl_warning.setVisible(true);
694     }
695   }
696
697   protected void btn_back_ActionPerformed()
698   {
699     mainFrame.dispose();
700     new SequenceFetcher(progressIdicator);
701   }
702
703   protected void disableActionButtons()
704   {
705     btn_ok.setEnabled(false);
706     btn_back.setEnabled(false);
707     btn_cancel.setEnabled(false);
708   }
709
710   protected void btn_cancel_ActionPerformed()
711   {
712     mainFrame.dispose();
713   }
714
715   /**
716    * Populates search target combo-box options
717    */
718   public void populateCmbSearchTargetOptions()
719   {
720     List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
721     try
722     {
723       Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
724               .getSearchableDataColumns();
725       searchableTargets.addAll(foundFTSTargets);
726     } catch (Exception e)
727     {
728       e.printStackTrace();
729     }
730
731     Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
732     {
733       @Override
734       public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
735       {
736         return o1.getName().compareTo(o2.getName());
737       }
738     });
739
740     for (FTSDataColumnI searchTarget : searchableTargets)
741     {
742       cmb_searchTarget.addItem(searchTarget);
743     }
744   }
745
746
747   public void transferToSequenceFetcher(String ids)
748   {
749     // mainFrame.dispose();
750     seqFetcher.getTextArea().setText(ids);
751     Thread worker = new Thread(seqFetcher);
752     worker.start();
753   }
754
755   @Override
756   public String getTypedText()
757   {
758     return txt_search.getText().trim();
759   }
760
761   @Override
762   public JTable getResultTable()
763   {
764     return tbl_summary;
765   }
766
767   public void reset()
768   {
769     lbl_loading.setVisible(false);
770     errorWarning.setLength(0);
771     lbl_warning.setVisible(false);
772     lbl_blank.setVisible(true);
773     btn_ok.setEnabled(false);
774     mainFrame.setTitle(getFTSFrameTitle());
775     referesh();
776     tbl_summary.setModel(new DefaultTableModel());
777     tbl_summary.setVisible(false);
778   }
779
780   @Override
781   public void setPrevPageButtonEnabled(boolean isEnabled)
782   {
783     btn_prev_page.setEnabled(isEnabled);
784   }
785
786   @Override
787   public void setNextPageButtonEnabled(boolean isEnabled)
788   {
789     btn_next_page.setEnabled(isEnabled);
790   }
791
792   @Override
793   public void setErrorMessage(String message)
794   {
795     errorWarning.append(message);
796   }
797
798   @Override
799   public void updateSearchFrameTitle(String title)
800   {
801     mainFrame.setTitle(title);
802   }
803
804   @Override
805   public void setSearchInProgress(Boolean isSearchInProgress)
806   {
807     lbl_blank.setVisible(!isSearchInProgress);
808     lbl_loading.setVisible(isSearchInProgress);
809   }
810   public void referesh()
811   {
812     mainFrame.setTitle(getFTSFrameTitle());
813   }
814
815 }