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(MessageManager.getString("label.retrieve_ids"),
 261                 fetcher);
 262         fetcher.setDatabaseChooserVisible(false);
 263         fetcher.embedWithFTSPanel(this);
 264       }
 265       mainFrame.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
 266       final JPanel ftsPanel = this;
 267       mainFrame.addFocusListener(new FocusAdapter()
 268       {
 269         @Override
 270         public void focusGained(FocusEvent e)
 271         {
 272           // TODO: make selected tab gain focus in correct widget
 273           if (mainFramTabs != null
 274                   && mainFramTabs.getSelectedComponent() == ftsPanel)
 275           {
 276             txt_search.requestFocusInWindow();
 277           }
 278         }
 279       });
 280       mainFrame.invalidate();
 281       mainFrame.pack();
 282     } catch (Exception e)
 283     {
 284       e.printStackTrace();
 285     }
 286   }
 287
 288   /**
 289    * Initializes the GUI default properties
 290    *
 291    * @throws Exception
 292    */
 293   private void jbInit() throws Exception
 294   {
 295
 296     txt_search = new JvCacheableInputBox<String>(getCacheKey());
 297     populateCmbSearchTargetOptions();
 298     Integer width = getTempUserPrefs().get("FTSPanel.width") == null ? 800
 299             : getTempUserPrefs().get("FTSPanel.width");
 300     Integer height = getTempUserPrefs().get("FTSPanel.height") == null ? 400
 301             : getTempUserPrefs().get("FTSPanel.height");
 302     lbl_warning.setVisible(false);
 303     lbl_warning.setFont(new java.awt.Font("Verdana", 0, 12));
 304     lbl_loading.setVisible(false);
 305     lbl_loading.setFont(new java.awt.Font("Verdana", 0, 12));
 306     lbl_blank.setVisible(true);
 307     lbl_blank.setFont(new java.awt.Font("Verdana", 0, 12));
 308
 309     tbl_summary.setAutoCreateRowSorter(true);
 310     tbl_summary.getTableHeader().setReorderingAllowed(false);
 311     tbl_summary.addMouseListener(new MouseAdapter()
 312     {
 313       @Override
 314       public void mouseClicked(MouseEvent e)
 315       {
 316         validateSelection();
 317       }
 318
 319       @Override
 320       public void mouseReleased(MouseEvent e)
 321       {
 322         validateSelection();
 323       }
 324     });
 325     tbl_summary.addKeyListener(new KeyAdapter()
 326     {
 327       @Override
 328       public void keyPressed(KeyEvent evt)
 329       {
 330         validateSelection();
 331         switch (evt.getKeyCode())
 332         {
 333         case KeyEvent.VK_ESCAPE: // escape key
 334           btn_back_ActionPerformed();
 335           break;
 336         case KeyEvent.VK_ENTER: // enter key
 337           if (btn_ok.isEnabled())
 338           {
 339             okAction();
 340           }
 341           evt.consume();
 342           break;
 343         case KeyEvent.VK_TAB: // tab key
 344           if (evt.isShiftDown())
 345           {
 346             tabbedPane.requestFocus();
 347           }
 348           else
 349           {
 350             btn_back.requestFocus();
 351           }
 352           evt.consume();
 353           break;
 354         default:
 355           return;
 356         }
 357       }
 358     });
 359
 360     btn_autosearch.setText(MessageManager.getString("option.autosearch"));
 361     btn_autosearch.setToolTipText(
 362             MessageManager.getString("option.enable_disable_autosearch"));
 363     btn_back.setFont(new java.awt.Font("Verdana", 0, 12));
 364     btn_back.setText(MessageManager.getString("action.back"));
 365     btn_back.addActionListener(new java.awt.event.ActionListener()
 366     {
 367       @Override
 368       public void actionPerformed(ActionEvent e)
 369       {
 370         btn_back_ActionPerformed();
 371       }
 372     });
 373     btn_back.addKeyListener(new KeyAdapter()
 374     {
 375       @Override
 376       public void keyPressed(KeyEvent evt)
 377       {
 378         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 379         {
 380           btn_back_ActionPerformed();
 381         }
 382       }
 383     });
 384
 385     btn_ok.setEnabled(false);
 386     btn_ok.setFont(new java.awt.Font("Verdana", 0, 12));
 387     btn_ok.setText(MessageManager.getString("action.ok"));
 388     btn_ok.addActionListener(new java.awt.event.ActionListener()
 389     {
 390       @Override
 391       public void actionPerformed(ActionEvent e)
 392       {
 393         okAction();
 394       }
 395     });
 396     btn_ok.addKeyListener(new KeyAdapter()
 397     {
 398       @Override
 399       public void keyPressed(KeyEvent evt)
 400       {
 401         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 402         {
 403           okAction();
 404         }
 405       }
 406     });
 407     btn_next_page.setEnabled(false);
 408     btn_next_page.setToolTipText(
 409             MessageManager.getString("label.next_page_tooltip"));
 410     btn_next_page.setFont(new java.awt.Font("Verdana", 0, 12));
 411     btn_next_page.setText(MessageManager.getString("action.next_page"));
 412     btn_next_page.addActionListener(new java.awt.event.ActionListener()
 413     {
 414       @Override
 415       public void actionPerformed(ActionEvent e)
 416       {
 417         nextPageAction();
 418       }
 419     });
 420     btn_next_page.addKeyListener(new KeyAdapter()
 421     {
 422       @Override
 423       public void keyPressed(KeyEvent evt)
 424       {
 425         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 426         {
 427           nextPageAction();
 428         }
 429       }
 430     });
 431
 432     btn_prev_page.setEnabled(false);
 433     btn_prev_page.setToolTipText(
 434             MessageManager.getString("label.prev_page_tooltip"));
 435     btn_prev_page.setFont(new java.awt.Font("Verdana", 0, 12));
 436     btn_prev_page.setText(MessageManager.getString("action.prev_page"));
 437     btn_prev_page.addActionListener(new java.awt.event.ActionListener()
 438     {
 439       @Override
 440       public void actionPerformed(ActionEvent e)
 441       {
 442         prevPageAction();
 443       }
 444     });
 445     btn_prev_page.addKeyListener(new KeyAdapter()
 446     {
 447       @Override
 448       public void keyPressed(KeyEvent evt)
 449       {
 450         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 451         {
 452           prevPageAction();
 453         }
 454       }
 455     });
 456
 457     if (isPaginationEnabled())
 458     {
 459       btn_prev_page.setVisible(true);
 460       btn_next_page.setVisible(true);
 461     }
 462     else
 463     {
 464       btn_prev_page.setVisible(false);
 465       btn_next_page.setVisible(false);
 466     }
 467
 468     btn_cancel.setFont(new java.awt.Font("Verdana", 0, 12));
 469     btn_cancel.setText(MessageManager.getString("action.cancel"));
 470     btn_cancel.addActionListener(new java.awt.event.ActionListener()
 471     {
 472       @Override
 473       public void actionPerformed(ActionEvent e)
 474       {
 475         btn_cancel_ActionPerformed();
 476       }
 477     });
 478     btn_cancel.addKeyListener(new KeyAdapter()
 479     {
 480       @Override
 481       public void keyPressed(KeyEvent evt)
 482       {
 483         if (evt.getKeyCode() == KeyEvent.VK_ENTER)
 484         {
 485           btn_cancel_ActionPerformed();
 486         }
 487       }
 488     });
 489     scrl_searchResult.setPreferredSize(new Dimension(width, height));
 490
 491     cmb_searchTarget.setFont(new java.awt.Font("Verdana", 0, 12));
 492     cmb_searchTarget.addItemListener(new ItemListener()
 493     {
 494       @Override
 495       public void itemStateChanged(ItemEvent e)
 496       {
 497         if (e.getStateChange() == ItemEvent.SELECTED)
 498         {
 499           String tooltipText;
 500           if ("all".equalsIgnoreCase(
 501                   getCmbSearchTarget().getSelectedItem().toString()))
 502           {
 503             tooltipText = MessageManager.getString("label.search_all");
 504           }
 505           else if ("pdb id".equalsIgnoreCase(
 506                   getCmbSearchTarget().getSelectedItem().toString()))
 507           {
 508             tooltipText = MessageManager
 509                     .getString("label.separate_multiple_accession_ids");
 510           }
 511           else
 512           {
 513             tooltipText = MessageManager.formatMessage(
 514                     "label.separate_multiple_query_values", new Object[]
 515                     { getCmbSearchTarget().getSelectedItem().toString() });
 516           }
 517           txt_search.setToolTipText(
 518                   JvSwingUtils.wrapTooltip(true, tooltipText));
 519           searchAction(true);
 520         }
 521       }
 522     });
 523
 524     txt_search.setFont(new java.awt.Font("Verdana", 0, 12));
 525
 526     txt_search.getEditor().getEditorComponent()
 527             .addKeyListener(new KeyAdapter()
 528             {
 529               @Override
 530               public void keyPressed(KeyEvent e)
 531               {
 532                 if (e.getKeyCode() == KeyEvent.VK_ENTER)
 533                 {
 534                   if (getTypedText() == null || getTypedText().isEmpty())
 535                   {
 536                     return;
 537                   }
 538                   String primaryKeyName = getFTSRestClient()
 539                           .getPrimaryKeyColumn().getName();
 540                   if (primaryKeyName.equalsIgnoreCase(getCmbSearchTarget()
 541                           .getSelectedItem().toString()))
 542                   {
 543                     // TODO: nicer to show the list in the result set before
 544                     // viewing in Jalview perhaps ?
 545                     transferToSequenceFetcher(getTypedText());
 546                   }
 547                   else
 548                   {
 549                     performSearchAction();
 550                   }
 551                 }
 552               }
 553             });
 554     final DeferredTextInputListener listener = new DeferredTextInputListener(
 555             1500, new ActionListener()
 556             {
 557               @Override
 558               public void actionPerformed(ActionEvent e)
 559               {
 560                 if (btn_autosearch.isSelected()
 561                         || txt_search.wasEnterPressed())
 562                 {
 563                   performSearchAction();
 564                 }
 565               }
 566             }, false);
 567     ((JTextComponent) txt_search.getEditor().getEditorComponent())
 568             .getDocument().addDocumentListener(listener);
 569
 570     txt_search.addFocusListener(new FocusListener()
 571     {
 572       @Override
 573       public void focusGained(FocusEvent e)
 574       {
 575         listener.start();
 576       }
 577
 578       @Override
 579       public void focusLost(FocusEvent e)
 580       {
 581         // listener.stop();
 582       }
 583     });
 584
 585     txt_search.addActionListener(new ActionListener()
 586     {
 587
 588       @Override
 589       public void actionPerformed(ActionEvent e)
 590       {
 591         performSearchAction();
 592       }
 593     });
 594     final String searchTabTitle = MessageManager
 595             .getString("label.search_result");
 596     final String configureCols = MessageManager
 597             .getString("label.configure_displayed_columns");
 598     ChangeListener changeListener = new ChangeListener()
 599     {
 600       @Override
 601       public void stateChanged(ChangeEvent changeEvent)
 602       {
 603         JTabbedPane sourceTabbedPane = (JTabbedPane) changeEvent
 604                 .getSource();
 605         int index = sourceTabbedPane.getSelectedIndex();
 606
 607         btn_back.setVisible(true);
 608         btn_cancel.setVisible(true);
 609         btn_ok.setVisible(true);
 610         if (sourceTabbedPane.getTitleAt(index).equals(configureCols))
 611         {
 612           btn_back.setVisible(false);
 613           btn_cancel.setVisible(false);
 614           btn_ok.setVisible(false);
 615           btn_back.setEnabled(false);
 616           btn_cancel.setEnabled(false);
 617           btn_ok.setEnabled(false);
 618           btn_next_page.setEnabled(false);
 619           btn_prev_page.setEnabled(false);
 620           txt_search.setEnabled(false);
 621           cmb_searchTarget.setEnabled(false);
 622           previousWantedFields = getFTSRestClient()
 623                   .getAllDefaultDisplayedFTSDataColumns()
 624                   .toArray(new Object[0]);
 625         }
 626         if (sourceTabbedPane.getTitleAt(index).equals(searchTabTitle))
 627         {
 628           btn_back.setEnabled(true);
 629           btn_cancel.setEnabled(true);
 630           refreshPaginatorState();
 631           txt_search.setEnabled(true);
 632           cmb_searchTarget.setEnabled(true);
 633           if (wantedFieldsUpdated())
 634           {
 635             searchAction(true);
 636             paginatorCart.clear();
 637           }
 638           else
 639           {
 640             validateSelection();
 641           }
 642         }
 643       }
 644     };
 645     tabbedPane.addChangeListener(changeListener);
 646     tabbedPane.setPreferredSize(new Dimension(width, height));
 647     tabbedPane.add(searchTabTitle, scrl_searchResult);
 648     tabbedPane.add(configureCols, new FTSDataColumnPreferences(
 649             PreferenceSource.SEARCH_SUMMARY, getFTSRestClient()));
 650
 651     pnl_actions.add(btn_back);
 652     pnl_actions.add(btn_ok);
 653     pnl_actions.add(btn_cancel);
 654
 655     pnl_results.add(tabbedPane);
 656     pnl_inputs.add(cmb_searchTarget);
 657     pnl_inputs.add(txt_search);
 658     pnl_inputs.add(btn_autosearch);
 659     pnl_inputs.add(lbl_loading);
 660     pnl_inputs.add(lbl_warning);
 661     pnl_inputs.add(lbl_blank);
 662     pnl_inputs.add(btn_prev_page);
 663     pnl_inputs.add(btn_next_page);
 664
 665     this.setLayout(mainLayout);
 666     this.add(pnl_inputs, java.awt.BorderLayout.NORTH);
 667     this.add(pnl_results, java.awt.BorderLayout.CENTER);
 668     this.add(pnl_actions, java.awt.BorderLayout.SOUTH);
 669     mainFrame.setVisible(true);
 670     if (mainFramTabs != null)
 671     {
 672       mainFramTabs.setOpaque(true);
 673       mainFramTabs.insertTab("Free Text Search", null, this, "", 0);
 674       mainFrame.setContentPane(mainFramTabs);
 675       mainFramTabs.setVisible(true);
 676     }
 677     else
 678     {
 679       mainFrame.setContentPane(this);
 680     }
 681     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 682     mainFrame.addInternalFrameListener(
 683             new javax.swing.event.InternalFrameAdapter()
 684             {
 685               @Override
 686               public void internalFrameClosing(InternalFrameEvent e)
 687               {
 688                 closeAction();
 689               }
 690             });
 691     mainFrame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
 692     Integer x = getTempUserPrefs().get("FTSPanel.x");
 693     Integer y = getTempUserPrefs().get("FTSPanel.y");
 694     if (x != null && y != null)
 695     {
 696       mainFrame.setLocation(x, y);
 697     }
 698     Desktop.addInternalFrame(mainFrame, getFTSFrameTitle(), width, height);
 699   }
 700
 701   protected void closeAction()
 702   {
 703     getTempUserPrefs().put("FTSPanel.width", this.getWidth());
 704     getTempUserPrefs().put("FTSPanel.height", pnl_results.getHeight());
 705     getTempUserPrefs().put("FTSPanel.x", mainFrame.getX());
 706     getTempUserPrefs().put("FTSPanel.y", mainFrame.getY());
 707     mainFrame.dispose();
 708     txt_search.persistCache();
 709   }
 710
 711   public class DeferredTextInputListener implements DocumentListener
 712   {
 713     private final Timer swingTimer;
 714
 715     public DeferredTextInputListener(int timeOut, ActionListener listener,
 716             boolean repeats)
 717     {
 718       swingTimer = new Timer(timeOut, listener);
 719       swingTimer.setRepeats(repeats);
 720     }
 721
 722     public void start()
 723     {
 724       swingTimer.start();
 725     }
 726
 727     public void stop()
 728     {
 729       swingTimer.stop();
 730     }
 731
 732     @Override
 733     public void insertUpdate(DocumentEvent e)
 734     {
 735       swingTimer.restart();
 736     }
 737
 738     @Override
 739     public void removeUpdate(DocumentEvent e)
 740     {
 741       swingTimer.restart();
 742     }
 743
 744     @Override
 745     public void changedUpdate(DocumentEvent e)
 746     {
 747       swingTimer.restart();
 748     }
 749
 750   }
 751
 752   void performSearchAction()
 753   {
 754     String typed = getTypedText();
 755     if (typed != null && typed.length() > 0
 756             && !typed.equalsIgnoreCase(lastSearchTerm))
 757     {
 758       searchAction(true);
 759       paginatorCart.clear();
 760       lastSearchTerm = typed;
 761     }
 762   }
 763
 764   public boolean wantedFieldsUpdated()
 765   {
 766     if (previousWantedFields == null)
 767     {
 768       return false;
 769     }
 770
 771     return Arrays.equals(getFTSRestClient()
 772             .getAllDefaultDisplayedFTSDataColumns().toArray(new Object[0]),
 773             previousWantedFields) ? false : true;
 774
 775   }
 776
 777   public void validateSelection()
 778   {
 779     if (tbl_summary.getSelectedRows().length > 0
 780             || !paginatorCart.isEmpty())
 781     {
 782       btn_ok.setEnabled(true);
 783     }
 784     else
 785     {
 786       btn_ok.setEnabled(false);
 787     }
 788   }
 789
 790   public JComboBox<FTSDataColumnI> getCmbSearchTarget()
 791   {
 792     return cmb_searchTarget;
 793   }
 794
 795   public JComboBox<String> getTxtSearch()
 796   {
 797     return txt_search;
 798   }
 799
 800   public JInternalFrame getMainFrame()
 801   {
 802     return mainFrame;
 803   }
 804
 805   protected void delayAndEnableActionButtons()
 806   {
 807     new Thread()
 808     {
 809       @Override
 810       public void run()
 811       {
 812         try
 813         {
 814           Thread.sleep(1500);
 815         } catch (InterruptedException e)
 816         {
 817           e.printStackTrace();
 818         }
 819         btn_ok.setEnabled(true);
 820         btn_back.setEnabled(true);
 821         btn_cancel.setEnabled(true);
 822       }
 823     }.start();
 824   }
 825
 826   protected void checkForErrors()
 827   {
 828     lbl_warning.setVisible(false);
 829     lbl_blank.setVisible(true);
 830     if (errorWarning.length() > 0)
 831     {
 832       lbl_loading.setVisible(false);
 833       lbl_blank.setVisible(false);
 834       lbl_warning.setToolTipText(
 835               JvSwingUtils.wrapTooltip(true, errorWarning.toString()));
 836       lbl_warning.setVisible(true);
 837     }
 838   }
 839
 840   public void btn_back_ActionPerformed()
 841   {
 842     closeAction();
 843     new SequenceFetcher(progressIndicator);
 844   }
 845
 846   protected void disableActionButtons()
 847   {
 848     btn_ok.setEnabled(false);
 849     btn_back.setEnabled(false);
 850     btn_cancel.setEnabled(false);
 851   }
 852
 853   public void btn_cancel_ActionPerformed()
 854   {
 855     closeAction();
 856   }
 857
 858   /**
 859    * Populates search target combo-box options
 860    */
 861   public void populateCmbSearchTargetOptions()
 862   {
 863     List<FTSDataColumnI> searchableTargets = new ArrayList<FTSDataColumnI>();
 864     try
 865     {
 866       Collection<FTSDataColumnI> foundFTSTargets = getFTSRestClient()
 867               .getSearchableDataColumns();
 868       searchableTargets.addAll(foundFTSTargets);
 869     } catch (Exception e)
 870     {
 871       e.printStackTrace();
 872     }
 873
 874     Collections.sort(searchableTargets, new Comparator<FTSDataColumnI>()
 875     {
 876       @Override
 877       public int compare(FTSDataColumnI o1, FTSDataColumnI o2)
 878       {
 879         return o1.getName().compareTo(o2.getName());
 880       }
 881     });
 882
 883     for (FTSDataColumnI searchTarget : searchableTargets)
 884     {
 885       cmb_searchTarget.addItem(searchTarget);
 886     }
 887   }
 888
 889   public void transferToSequenceFetcher(String ids)
 890   {
 891     seqFetcher.getTextArea().setText(ids);
 892     Thread worker = new Thread(seqFetcher);
 893     worker.start();
 894   }
 895
 896   @Override
 897   public String getTypedText()
 898   {
 899     return txt_search.getUserInput();
 900   }
 901
 902   @Override
 903   public JTable getResultTable()
 904   {
 905     return tbl_summary;
 906   }
 907
 908   public void reset()
 909   {
 910     lbl_loading.setVisible(false);
 911     errorWarning.setLength(0);
 912     lbl_warning.setVisible(false);
 913     lbl_blank.setVisible(true);
 914     btn_ok.setEnabled(false);
 915     mainFrame.setTitle(getFTSFrameTitle());
 916     referesh();
 917     tbl_summary.setModel(new DefaultTableModel());
 918     tbl_summary.setVisible(false);
 919   }
 920
 921   @Override
 922   public void setPrevPageButtonEnabled(boolean isEnabled)
 923   {
 924     btn_prev_page.setEnabled(isEnabled);
 925   }
 926
 927   @Override
 928   public void setNextPageButtonEnabled(boolean isEnabled)
 929   {
 930     btn_next_page.setEnabled(isEnabled);
 931   }
 932
 933   @Override
 934   public void setErrorMessage(String message)
 935   {
 936     errorWarning.append(message);
 937   }
 938
 939   @Override
 940   public void updateSearchFrameTitle(String title)
 941   {
 942     mainFrame.setTitle(title);
 943   }
 944
 945   @Override
 946   public void setSearchInProgress(Boolean isSearchInProgress)
 947   {
 948     lbl_blank.setVisible(!isSearchInProgress);
 949     lbl_loading.setVisible(isSearchInProgress);
 950     txt_search.setEditable(!isSearchInProgress);
 951   }
 952
 953   @Override
 954   public void prevPageAction()
 955   {
 956     updatePaginatorCart();
 957     if (offSet >= pageLimit)
 958     {
 959       offSet = offSet - pageLimit;
 960       searchAction(false);
 961     }
 962     else
 963     {
 964       refreshPaginatorState();
 965     }
 966   }
 967
 968   @Override
 969   public void nextPageAction()
 970   {
 971     updatePaginatorCart();
 972     offSet = offSet + pageLimit;
 973     searchAction(false);
 974   }
 975
 976   public void updatePaginatorCart()
 977   {
 978     int primaryKeyColIndex = 0;
 979     JTable resultTable = getResultTable();
 980     int totalRows = resultTable.getRowCount();
 981     try
 982     {
 983       primaryKeyColIndex = getFTSRestClient()
 984               .getPrimaryKeyColumIndex(wantedFields, false);
 985     } catch (Exception e)
 986     {
 987       e.printStackTrace();
 988     }
 989
 990     for (int row = 0; row < totalRows; row++)
 991     {
 992       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
 993       if (paginatorCart.contains(id))
 994       {
 995         paginatorCart.remove(id);
 996       }
 997     }
 998     int[] selectedRows = resultTable.getSelectedRows();
 999     for (int summaryRow : selectedRows)
1000     {
1001       String idStr = resultTable.getValueAt(summaryRow, primaryKeyColIndex)
1002               .toString();
1003       paginatorCart.add(idStr);
1004     }
1005   }
1006
1007   public void updateSummaryTableSelections()
1008   {
1009     JTable resultTable = getResultTable();
1010     if (paginatorCart.isEmpty())
1011     {
1012       return;
1013     }
1014     int primaryKeyColIndex = 0;
1015     try
1016     {
1017       primaryKeyColIndex = getFTSRestClient()
1018               .getPrimaryKeyColumIndex(wantedFields, false);
1019     } catch (Exception e)
1020     {
1021       e.printStackTrace();
1022     }
1023     int totalRows = resultTable.getRowCount();
1024     for (int row = 0; row < totalRows; row++)
1025     {
1026       String id = (String) resultTable.getValueAt(row, primaryKeyColIndex);
1027       if (paginatorCart.contains(id))
1028       {
1029         resultTable.addRowSelectionInterval(row, row);
1030       }
1031     }
1032     validateSelection();
1033   }
1034
1035   public void refreshPaginatorState()
1036   {
1037     setPrevPageButtonEnabled(false);
1038     setNextPageButtonEnabled(false);
1039     if (resultSetCount == 0 && pageLimit == 0)
1040     {
1041       return;
1042     }
1043     if (resultSetCount >= pageLimit)
1044     {
1045       setNextPageButtonEnabled(true);
1046     }
1047     if (offSet >= pageLimit)
1048     {
1049       setPrevPageButtonEnabled(true);
1050     }
1051   }
1052
1053   public void referesh()
1054   {
1055     mainFrame.setTitle(getFTSFrameTitle());
1056   }
1057
1058 }