JAL-1648 Implemented in-memory caching for FTS (Uniprot & PDB) and Finder
[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.io.cache.AppCache;
32 import jalview.io.cache.Cacheable;
33 import jalview.util.MessageManager;
34
35 import java.awt.BorderLayout;
36 import java.awt.CardLayout;
37 import java.awt.Dimension;
38 import java.awt.event.ActionEvent;
39 import java.awt.event.ActionListener;
40 import java.awt.event.FocusAdapter;
41 import java.awt.event.FocusEvent;
42 import java.awt.event.FocusListener;
43 import java.awt.event.ItemEvent;
44 import java.awt.event.ItemListener;
45 import java.awt.event.KeyAdapter;
46 import java.awt.event.KeyEvent;
47 import java.awt.event.MouseAdapter;
48 import java.awt.event.MouseEvent;
49 import java.text.DecimalFormat;
50 import java.util.ArrayList;
51 import java.util.Arrays;
52 import java.util.Collection;
53 import java.util.Collections;
54 import java.util.Comparator;
55 import java.util.HashSet;
56 import java.util.List;
57
58 import javax.swing.ImageIcon;
59 import javax.swing.JButton;
60 import javax.swing.JComboBox;
61 import javax.swing.JComponent;
62 import javax.swing.JFrame;
63 import javax.swing.JInternalFrame;
64 import javax.swing.JLabel;
65 import javax.swing.JPanel;
66 import javax.swing.JScrollPane;
67 import javax.swing.JTabbedPane;
68 import javax.swing.JTable;
69 import javax.swing.Timer;
70 import javax.swing.event.ChangeEvent;
71 import javax.swing.event.ChangeListener;
72 import javax.swing.event.DocumentEvent;
73 import javax.swing.event.DocumentListener;
74 import javax.swing.event.InternalFrameEvent;
75 import javax.swing.table.DefaultTableModel;
76 import javax.swing.table.TableColumn;
77 import javax.swing.text.JTextComponent;
78
79 /**
80  * This class provides the swing GUI layout for FTS Panel and implements most of
81  * the contracts defined in GFSPanelI
82  * 
83  * @author tcnofoegbu
84  *
85  */
86
87 @SuppressWarnings("serial")
88 public abstract class GFTSPanel extends JPanel implements GFTSPanelI, Cacheable
89 {
90   protected JInternalFrame mainFrame = new JInternalFrame(
91           getFTSFrameTitle());
92
93   protected IProgressIndicator progressIndicator;
94
95   protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
96
97   protected JButton btn_ok = new JButton();
98
99   protected JButton btn_back = new JButton();
100
101   protected JButton btn_cancel = new JButton();
102
103   protected JComboBox<String> txt_search;
104
105   protected SequenceFetcher seqFetcher;
106
107   protected Collection<FTSDataColumnI> wantedFields;
108
109   private String lastSearchTerm = "";
110
111   protected JButton btn_next_page = new JButton();
112
113   protected JButton btn_prev_page = new JButton();
114
115   protected StringBuilder errorWarning = new StringBuilder();
116
117   protected ImageIcon warningImage = new ImageIcon(getClass().getResource(
118           "/images/warning.gif"));
119
120   protected ImageIcon loadingImage = new ImageIcon(getClass().getResource(
121           "/images/loading.gif"));
122
123   protected ImageIcon balnkPlaceholderImage = new ImageIcon(getClass()
124           .getResource("/images/blank_16x16_placeholder.png"));
125
126   protected JLabel lbl_warning = new JLabel(warningImage);
127
128   protected JLabel lbl_loading = new JLabel(loadingImage);
129
130   protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
131
132   private JTabbedPane tabbedPane = new JTabbedPane();
133
134   private JPanel pnl_actions = new JPanel();
135
136   private JPanel pnl_results = new JPanel(new CardLayout());
137
138   private JPanel pnl_inputs = new JPanel();
139
140   private BorderLayout mainLayout = new BorderLayout();
141
142   protected Object[] previousWantedFields;
143
144   protected int resultSetCount;
145
146   protected int totalResultSetCount;
147
148   protected int offSet;
149
150   protected int pageLimit;
151
152   protected HashSet<String> paginatorCart = new HashSet<String>();
153
154   protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
155           "###,###");
156
157   private JTable tbl_summary = new JTable()
158   {
159     private boolean inLayout;
160
161     @Override
162     public boolean getScrollableTracksViewportWidth()
163     {
164       return hasExcessWidth();
165
166     }
167
168     @Override
169     public void doLayout()
170     {
171       if (hasExcessWidth())
172       {
173         autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
174       }
175       inLayout = true;
176       super.doLayout();
177       inLayout = false;
178       autoResizeMode = AUTO_RESIZE_OFF;
179     }
180
181     protected boolean hasExcessWidth()
182     {
183       return getPreferredSize().width < getParent().getWidth();
184     }
185
186     @Override
187     public void columnMarginChanged(ChangeEvent e)
188     {
189       if (isEditing())
190       {
191         removeEditor();
192       }
193       TableColumn resizingColumn = getTableHeader().getResizingColumn();
194       // Need to do this here, before the parent's
195       // layout manager calls getPreferredSize().
196       if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
197               && !inLayout)
198       {
199         resizingColumn.setPreferredWidth(resizingColumn.getWidth());
200         String colHeader = resizingColumn.getHeaderValue().toString();
201         getTempUserPrefs().put(colHeader, resizingColumn.getWidth());
202       }
203       resizeAndRepaint();
204     }
205
206     @Override
207     public String getToolTipText(MouseEvent evt)
208     {
209       String toolTipText = null;
210       java.awt.Point pnt = evt.getPoint();
211       int rowIndex = rowAtPoint(pnt);
212       int colIndex = columnAtPoint(pnt);
213
214       try
215       {
216         if (getValueAt(rowIndex, colIndex) == null)
217         {
218           return null;
219         }
220         toolTipText = getValueAt(rowIndex, colIndex).toString();
221
222       } catch (Exception e)
223       {
224         e.printStackTrace();
225       }
226       toolTipText = (toolTipText == null ? null
227               : (toolTipText.length() > 500 ? JvSwingUtils.wrapTooltip(
228                       true, toolTipText.subSequence(0, 500) + "...")
229                       : JvSwingUtils.wrapTooltip(true, toolTipText)));
230
231       return toolTipText;
232     }
233   };
234
235   protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
236
237   public GFTSPanel()
238   {
239     try
240     {
241       jbInit();
242       mainFrame.addFocusListener(new FocusAdapter()
243       {
244         @Override
245         public void focusGained(FocusEvent e)
246         {
247           txt_search.requestFocusInWindow();
248         }
249       });
250       mainFrame.invalidate();
251       mainFrame.pack();
252     } catch (Exception e)
253     {
254       e.printStackTrace();
255     }
256   }
257
258   /**
259    * Initializes the GUI default properties
260    * 
261    * @throws Exception
262    */
263   private void jbInit() throws Exception
264   {
265
266     txt_search = new JComboBox<String>();
267     txt_search.setEditable(true);
268     txt_search
269             .setPrototypeDisplayValue("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
270     populateCmbSearchTargetOptions();
271     Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
272             : getTempUserPrefs().get("FTSPanel.width");
273     Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
274             : getTempUserPrefs().get("FTSPanel.height");
275     lbl_warning.setVisible(false);
276     lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
277     lbl_loading.setVisible(false);
278     lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
279     lbl_blank.setVisible(true);
280     lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
281
282     tbl_summary.setAutoCreateRowSorter(true);
283     tbl_summary.getTableHeader().setReorderingAllowed(false);
284     tbl_summary.addMouseListener(new MouseAdapter()
285     {
286       @Override
287       public void mouseClicked(MouseEvent e)
288       {
289         validateSelection();
290       }
291
292       @Override
293       public void mouseReleased(MouseEvent e)
294       {
295         validateSelection();
296       }
297     });
298     tbl_summary.addKeyListener(new KeyAdapter()
299     {
300       @Override
301       public void keyPressed(KeyEvent evt)
302       {
303         validateSelection();
304         switch (evt.getKeyCode())
305         {
306         case KeyEvent.VK_ESCAPE: // escape key
307           btn_back_ActionPerformed();
308           break;
309         case KeyEvent.VK_ENTER: // enter key
310           if (btn_ok.isEnabled())
311           {
312             okAction();
313           }
314           evt.consume();
315           break;
316         case KeyEvent.VK_TAB: // tab key
317           if (evt.isShiftDown())
318           {
319             tabbedPane.requestFocus();
320           }
321           else
322           {
323             btn_back.requestFocus();
324           }
325           evt.consume();
326           break;
327         default:
328           return;
329         }
330       }
331     });
332
333     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
334     btn_back.setText(MessageManager.getString("action.back"));
335     btn_back.addActionListener(new java.awt.event.ActionListener()
336     {
337       @Override
338       public void actionPerformed(ActionEvent e)
339       {
340         btn_back_ActionPerformed();
341       }
342     });
343     btn_back.addKeyListener(new KeyAdapter()
344     {
345       @Override
346       public void keyPressed(KeyEvent evt)
347       {
348         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
349         {
350           btn_back_ActionPerformed();
351         }
352       }
353     });
354
355     btn_ok.setEnabled(false);
356     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
357     btn_ok.setText(MessageManager.getString("action.ok"));
358     btn_ok.addActionListener(new java.awt.event.ActionListener()
359     {
360       @Override
361       public void actionPerformed(ActionEvent e)
362       {
363         okAction();
364       }
365     });
366     btn_ok.addKeyListener(new KeyAdapter()
367     {
368       @Override
369       public void keyPressed(KeyEvent evt)
370       {
371         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
372         {
373           okAction();
374         }
375       }
376     });
377     btn_next_page.setEnabled(false);
378     btn_next_page.setToolTipText(MessageManager
379             .getString("label.next_page_tooltip"));
380     btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
381     btn_next_page.setText(MessageManager.getString("action.next_page"));
382     btn_next_page.addActionListener(new java.awt.event.ActionListener()
383     {
384       @Override
385       public void actionPerformed(ActionEvent e)
386       {
387         nextPageAction();
388       }
389     });
390     btn_next_page.addKeyListener(new KeyAdapter()
391     {
392       @Override
393       public void keyPressed(KeyEvent evt)
394       {
395         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
396         {
397           nextPageAction();
398         }
399       }
400     });
401
402     btn_prev_page.setEnabled(false);
403     btn_prev_page.setToolTipText(MessageManager
404             .getString("label.prev_page_tooltip"));
405     btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
406     btn_prev_page.setText(MessageManager.getString("action.prev_page"));
407     btn_prev_page.addActionListener(new java.awt.event.ActionListener()
408     {
409       @Override
410       public void actionPerformed(ActionEvent e)
411       {
412         prevPageAction();
413       }
414     });
415     btn_prev_page.addKeyListener(new KeyAdapter()
416     {
417       @Override
418       public void keyPressed(KeyEvent evt)
419       {
420         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
421         {
422           prevPageAction();
423         }
424       }
425     });
426
427     if (isPaginationEnabled())
428     {
429       btn_prev_page.setVisible(true);
430       btn_next_page.setVisible(true);
431     }
432     else
433     {
434       btn_prev_page.setVisible(false);
435       btn_next_page.setVisible(false);
436     }
437
438     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
439     btn_cancel.setText(MessageManager.getString("action.cancel"));
440     btn_cancel.addActionListener(new java.awt.event.ActionListener()
441     {
442       @Override
443       public void actionPerformed(ActionEvent e)
444       {
445         btn_cancel_ActionPerformed();
446       }
447     });
448     btn_cancel.addKeyListener(new KeyAdapter()
449     {
450       @Override
451       public void keyPressed(KeyEvent evt)
452       {
453         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
454         {
455           btn_cancel_ActionPerformed();
456         }
457       }
458     });
459     scrl_searchResult.setPreferredSize(new Dimension(width, height));
460
461     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
462     cmb_searchTarget.addItemListener(new ItemListener()
463     {
464       @Override
465       public void itemStateChanged(ItemEvent e)
466       {
467         if (e.getStateChange() == ItemEvent.SELECTED)
468         {
469           String tooltipText;
470           if ("all".equalsIgnoreCase(getCmbSearchTarget().getSelectedItem()
471                   .toString()))
472           {
473             tooltipText = MessageManager.getString("label.search_all");
474           }
475           else if ("pdb id".equalsIgnoreCase(getCmbSearchTarget()
476                   .getSelectedItem().toString()))
477           {
478             tooltipText = MessageManager
479                     .getString("label.separate_multiple_accession_ids");
480           }
481           else
482           {
483             tooltipText = MessageManager.formatMessage(
484                     "label.separate_multiple_query_values",
485                     new Object[] { getCmbSearchTarget().getSelectedItem()
486                             .toString() });
487           }
488           txt_search.setToolTipText(JvSwingUtils.wrapTooltip(true,
489                   tooltipText));
490           searchAction(true);
491         }
492       }
493     });
494  
495
496
497     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
498
499     txt_search.getEditor().getEditorComponent()
500             .addKeyListener(new KeyAdapter()
501     {
502       @Override
503       public void keyPressed(KeyEvent e)
504       {
505         if (e.getKeyCode() == KeyEvent.VK_ENTER)
506         {
507           if (getTypedText() == null || getTypedText().isEmpty())
508           {
509             return;
510           }
511           String primaryKeyName = getFTSRestClient().getPrimaryKeyColumn()
512                   .getName();
513           if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
514                   .getSelectedItem().toString()))
515           {
516             transferToSequenceFetcher(getTypedText());
517           }
518         }
519       }
520     });
521
522     final DeferredTextInputListener listener = new DeferredTextInputListener(
523             1500, new ActionListener()
524             {
525               @Override
526               public void actionPerformed(ActionEvent e)
527               {
528                 if (!getTypedText().equalsIgnoreCase(lastSearchTerm))
529                 {
530                   searchAction(true);
531                   paginatorCart.clear();
532                   lastSearchTerm = getTypedText();
533                 }
534               }
535             }, false);
536     ((JTextComponent) txt_search.getEditor().getEditorComponent())
537             .getDocument().addDocumentListener(listener);
538
539     txt_search.addFocusListener(new FocusListener()
540     {
541       @Override
542       public void focusGained(FocusEvent e)
543       {
544         listener.start();
545       }
546
547       @Override
548       public void focusLost(FocusEvent e)
549       {
550         // listener.stop();
551       }
552     });
553
554     final String searchTabTitle = MessageManager
555             .getString("label.search_result");
556     final String configureCols = MessageManager
557             .getString("label.configure_displayed_columns");
558     ChangeListener changeListener = new ChangeListener()
559     {
560       @Override
561       public void stateChanged(ChangeEvent changeEvent)
562       {
563         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
564                 .getSource();
565         int index = sourceTabbedPane.getSelectedIndex();
566
567         btn_back.setVisible(true);
568         btn_cancel.setVisible(true);
569         btn_ok.setVisible(true);
570         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
571         {
572           btn_back.setVisible(false);
573           btn_cancel.setVisible(false);
574           btn_ok.setVisible(false);
575           btn_back.setEnabled(false);
576           btn_cancel.setEnabled(false);
577           btn_ok.setEnabled(false);
578           btn_next_page.setEnabled(false);
579           btn_prev_page.setEnabled(false);
580           txt_search.setEnabled(false);
581           cmb_searchTarget.setEnabled(false);
582           previousWantedFields = getFTSRestClient()
583                   .getAllDefaultDisplayedFTSDataColumns().toArray(
584                           new Object[0]);
585         }
586         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
587         {
588           btn_back.setEnabled(true);
589           btn_cancel.setEnabled(true);
590           refreshPaginatorState();
591           txt_search.setEnabled(true);
592           cmb_searchTarget.setEnabled(true);
593           if (wantedFieldsUpdated())
594           {
595             searchAction(true);
596             paginatorCart.clear();
597           }
598           else
599           {
600             validateSelection();
601           }
602         }
603       }
604     };
605     tabbedPane.addChangeListener(changeListener);
606     tabbedPane.setPreferredSize(new Dimension(width, height));
607     tabbedPane.add(searchTabTitle, scrl_searchResult);
608     tabbedPane.add(configureCols, new FTSDataColumnPreferences(
609             PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
610
611     pnl_actions.add(btn_back);
612     pnl_actions.add(btn_ok);
613     pnl_actions.add(btn_cancel);
614
615     pnl_results.add(tabbedPane);
616     pnl_inputs.add(cmb_searchTarget);
617     pnl_inputs.add(txt_search);
618     pnl_inputs.add(lbl_loading);
619     pnl_inputs.add(lbl_warning);
620     pnl_inputs.add(lbl_blank);
621     pnl_inputs.add(btn_prev_page);
622     pnl_inputs.add(btn_next_page);
623
624     this.setLayout(mainLayout);
625     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
626     this.add(pnl_results, java.awt.BorderLayout.CENTER);
627     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
628     mainFrame.setVisible(true);
629     mainFrame.setContentPane(this);
630     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
631     mainFrame
632             .addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
633             {
634               @Override
635               public void internalFrameClosing(InternalFrameEvent e)
636               {
637                 closeAction();
638               }
639             });
640     mainFrame.setVisible(true);
641     mainFrame.setContentPane(this);
642     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
643     Integer x = getTempUserPrefs().get("FTSPanel.x");
644     Integer y = getTempUserPrefs().get("FTSPanel.y");
645     if (x != null && y != null)
646     {
647       mainFrame.setLocation(x, y);
648     }
649     Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
650   }
651
652   protected void closeAction()
653   {
654     getTempUserPrefs().put("FTSPanel.width", this.getWidth());
655     getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
656     getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
657     getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
658     mainFrame.dispose();
659   }
660
661   public class DeferredTextInputListener implements DocumentListener
662   {
663     private final Timer swingTimer;
664
665     public DeferredTextInputListener(int timeOut, ActionListener listener,
666             boolean repeats)
667     {
668       swingTimer = new Timer(timeOut, listener);
669       swingTimer.setRepeats(repeats);
670     }
671
672     public void start()
673     {
674       swingTimer.start();
675     }
676
677     public void stop()
678     {
679       swingTimer.stop();
680     }
681
682     @Override
683     public void insertUpdate(DocumentEvent e)
684     {
685       swingTimer.restart();
686     }
687
688     @Override
689     public void removeUpdate(DocumentEvent e)
690     {
691       swingTimer.restart();
692     }
693
694     @Override
695     public void changedUpdate(DocumentEvent e)
696     {
697       swingTimer.restart();
698     }
699
700   }
701
702   public boolean wantedFieldsUpdated()
703   {
704     if (previousWantedFields == null)
705     {
706       return false;
707     }
708
709     return Arrays.equals(getFTSRestClient()
710             .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
711             previousWantedFields) ? false : true;
712
713   }
714
715   public void validateSelection()
716   {
717     if (tbl_summary.getSelectedRows().length > 0
718             || !paginatorCart.isEmpty())
719     {
720       btn_ok.setEnabled(true);
721     }
722     else
723     {
724       btn_ok.setEnabled(false);
725     }
726   }
727
728   public JComboBox<FTSDataColumnI> getCmbSearchTarget()
729   {
730     return cmb_searchTarget;
731   }
732
733   public JComboBox<String> getTxtSearch()
734   {
735     return txt_search;
736   }
737
738   public JInternalFrame getMainFrame()
739   {
740     return mainFrame;
741   }
742
743   protected void delayAndEnableActionButtons()
744   {
745     new Thread()
746     {
747       @Override
748       public void run()
749       {
750         try
751         {
752           Thread.sleep(1500);
753         } catch (InterruptedException e)
754         {
755           e.printStackTrace();
756         }
757         btn_ok.setEnabled(true);
758         btn_back.setEnabled(true);
759         btn_cancel.setEnabled(true);
760       }
761     }.start();
762   }
763
764   protected void checkForErrors()
765   {
766     lbl_warning.setVisible(false);
767     lbl_blank.setVisible(true);
768     if (errorWarning.length() > 0)
769     {
770       lbl_loading.setVisible(false);
771       lbl_blank.setVisible(false);
772       lbl_warning.setToolTipText(JvSwingUtils.wrapTooltip(true,
773               errorWarning.toString()));
774       lbl_warning.setVisible(true);
775     }
776   }
777
778   protected void btn_back_ActionPerformed()
779   {
780     closeAction();
781     new SequenceFetcher(progressIndicator);
782   }
783
784   protected void disableActionButtons()
785   {
786     btn_ok.setEnabled(false);
787     btn_back.setEnabled(false);
788     btn_cancel.setEnabled(false);
789   }
790
791   protected void btn_cancel_ActionPerformed()
792   {
793     closeAction();
794   }
795
796   /**
797    * Populates search target combo-box options
798    */
799   public void populateCmbSearchTargetOptions()
800   {
801     List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
802     try
803     {
804       Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
805               .getSearchableDataColumns();
806       searchableTargets.addAll(foundFTSTargets);
807     } catch (Exception e)
808     {
809       e.printStackTrace();
810     }
811
812     Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
813     {
814       @Override
815       public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
816       {
817         return o1.getName().compareTo(o2.getName());
818       }
819     });
820
821     for (FTSDataColumnI searchTarget : searchableTargets)
822     {
823       cmb_searchTarget.addItem(searchTarget);
824     }
825   }
826
827   public void transferToSequenceFetcher(String ids)
828   {
829     seqFetcher.getTextArea().setText(ids);
830     Thread worker = new Thread(seqFetcher);
831     worker.start();
832   }
833
834   @Override
835   public String getTypedText()
836   {
837     return txt_search.getEditor().getItem() == null ? "" : txt_search
838             .getEditor().getItem().toString().trim();
839   }
840
841   @Override
842   public JTable getResultTable()
843   {
844     return tbl_summary;
845   }
846
847   public void reset()
848   {
849     lbl_loading.setVisible(false);
850     errorWarning.setLength(0);
851     lbl_warning.setVisible(false);
852     lbl_blank.setVisible(true);
853     btn_ok.setEnabled(false);
854     mainFrame.setTitle(getFTSFrameTitle());
855     referesh();
856     tbl_summary.setModel(new DefaultTableModel());
857     tbl_summary.setVisible(false);
858   }
859
860   @Override
861   public void setPrevPageButtonEnabled(boolean isEnabled)
862   {
863     btn_prev_page.setEnabled(isEnabled);
864   }
865
866   @Override
867   public void setNextPageButtonEnabled(boolean isEnabled)
868   {
869     btn_next_page.setEnabled(isEnabled);
870   }
871
872   @Override
873   public void setErrorMessage(String message)
874   {
875     errorWarning.append(message);
876   }
877
878   @Override
879   public void updateSearchFrameTitle(String title)
880   {
881     mainFrame.setTitle(title);
882   }
883
884   @Override
885   public void setSearchInProgress(Boolean isSearchInProgress)
886   {
887     lbl_blank.setVisible(!isSearchInProgress);
888     lbl_loading.setVisible(isSearchInProgress);
889   }
890
891   @Override
892   public void prevPageAction()
893   {
894     updatePaginatorCart();
895     if (offSet >= pageLimit)
896     {
897       offSet = offSet - pageLimit;
898       searchAction(false);
899     }
900     else
901     {
902       refreshPaginatorState();
903     }
904   }
905
906   @Override
907   public void nextPageAction()
908   {
909     updatePaginatorCart();
910     offSet = offSet + pageLimit;
911     searchAction(false);
912   }
913
914   public void updatePaginatorCart()
915   {
916     int primaryKeyColIndex = 0;
917     JTable resultTable = getResultTable();
918     int totalRows = resultTable.getRowCount();
919     try
920     {
921       primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
922               wantedFields, false);
923     } catch (Exception e)
924     {
925       e.printStackTrace();
926     }
927
928     for (int row = 0; row < totalRows; row++)
929     {
930       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
931       if (paginatorCart.contains(id))
932       {
933         paginatorCart.remove(id);
934       }
935     }
936     int[] selectedRows = resultTable.getSelectedRows();
937     for (int summaryRow : selectedRows)
938     {
939       String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
940               .toString();
941       paginatorCart.add(idStr);
942     }
943   }
944
945   public void updateSummaryTableSelections()
946   {
947     JTable resultTable = getResultTable();
948     if (paginatorCart.isEmpty())
949     {
950       return;
951     }
952     int primaryKeyColIndex = 0;
953     try
954     {
955       primaryKeyColIndex = getFTSRestClient().getPrimaryKeyColumIndex(
956               wantedFields, false);
957     } catch (Exception e)
958     {
959       e.printStackTrace();
960     }
961     int totalRows = resultTable.getRowCount();
962     for (int row = 0; row < totalRows; row++)
963     {
964       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
965       if (paginatorCart.contains(id))
966       {
967         resultTable.addRowSelectionInterval(row, row);
968       }
969     }
970     validateSelection();
971   }
972
973   public void refreshPaginatorState()
974   {
975     setPrevPageButtonEnabled(false);
976     setNextPageButtonEnabled(false);
977     if (resultSetCount == 0 && pageLimit == 0)
978     {
979       return;
980     }
981     if (resultSetCount >= pageLimit)
982     {
983       setNextPageButtonEnabled(true);
984     }
985     if (offSet >= pageLimit)
986     {
987       setPrevPageButtonEnabled(true);
988     }
989   }
990
991   public void referesh()
992   {
993     mainFrame.setTitle(getFTSFrameTitle());
994   }
995
996
997   protected void fireCache()
998   {
999     AppCache.getInstance().updateCache(this);
1000   }
1001
1002   @Override
1003   public void init()
1004   {
1005     // reset();
1006   }
1007
1008   @Override
1009   public JComponent getNextFocusableElement()
1010   {
1011     return mainFrame;
1012   }
1013
1014   @Override
1015   public String getCacheKey()
1016   {
1017     return getCacheKey();
1018   }
1019
1020   @Override
1021   public JComboBox<String> getCacheComboBox()
1022   {
1023     return txt_search;
1024   }
1025
1026
1027 }