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