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.Color;
  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.JCheckBox;
  61 import javax.swing.JComboBox;
  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
  89 {
  90   protected JInternalFrame mainFrame = new JInternalFrame(
  91           getFTSFrameTitle());
  92
  93   protected JTabbedPane mainFramTabs = new JTabbedPane();
  94   protected IProgressIndicator progressIndicator;
  95
  96   protected JComboBox<FTSDataColumnI> cmb_searchTarget = new JComboBox<FTSDataColumnI>();
  97
  98   protected JButton btn_ok = new JButton();
  99
 100   protected JButton btn_back = new JButton();
 101
 102   protected JButton btn_cancel = new JButton();
 103
 104   protected JCheckBox btn_autosearch = new JCheckBox();
 105
 106   protected JvCacheableInputBox<String> txt_search;
 107
 108   protected SequenceFetcher seqFetcher;
 109
 110   protected Collection<FTSDataColumnI> wantedFields;
 111
 112   private String lastSearchTerm = "";
 113
 114   protected JButton btn_next_page = new JButton();
 115
 116   protected JButton btn_prev_page = new JButton();
 117
 118   protected StringBuilder errorWarning = new StringBuilder();
 119
 120   protected ImageIcon warningImage = new ImageIcon(
 121           getClass().getResource("/images/warning.gif"));
 122
 123   protected ImageIcon loadingImage = new ImageIcon(
 124           getClass().getResource("/images/loading.gif"));
 125
 126   protected ImageIcon balnkPlaceholderImage = new ImageIcon(
 127           getClass().getResource("/images/blank_16x16_placeholder.png"));
 128
 129   protected JLabel lbl_warning = new JLabel(warningImage);
 130
 131   protected JLabel lbl_loading = new JLabel(loadingImage);
 132
 133   protected JLabel lbl_blank = new JLabel(balnkPlaceholderImage);
 134
 135   private JTabbedPane tabbedPane = new JTabbedPane();
 136
 137   private JPanel pnl_actions = new JPanel();
 138
 139   private JPanel pnl_results = new JPanel(new CardLayout());
 140
 141   private JPanel pnl_inputs = new JPanel();
 142
 143   private BorderLayout mainLayout = new BorderLayout();
 144
 145   protected Object[] previousWantedFields;
 146
 147   protected int resultSetCount;
 148
 149   protected int totalResultSetCount;
 150
 151   protected int offSet;
 152
 153   protected int pageLimit;
 154
 155   protected HashSet<String> paginatorCart = new HashSet<String>();
 156
 157   private static final int MIN_WIDTH = 670;
 158
 159   private static final int MIN_HEIGHT = 300;
 160
 161   protected static final DecimalFormat totalNumberformatter = new DecimalFormat(
 162           "###,###");
 163
 164   private JTable tbl_summary = new JTable()
 165   {
 166     private boolean inLayout;
 167
 168     @Override
 169     public boolean getScrollableTracksViewportWidth()
 170     {
 171       return hasExcessWidth();
 172
 173     }
 174
 175     @Override
 176     public void doLayout()
 177     {
 178       if (hasExcessWidth())
 179       {
 180         autoResizeMode = AUTO_RESIZE_SUBSEQUENT_COLUMNS;
 181       }
 182       inLayout = true;
 183       super.doLayout();
 184       inLayout = false;
 185       autoResizeMode = AUTO_RESIZE_OFF;
 186     }
 187
 188     protected boolean hasExcessWidth()
 189     {
 190       return getPreferredSize().width < getParent().getWidth();
 191     }
 192
 193     @Override
 194     public void columnMarginChanged(ChangeEvent e)
 195     {
 196       if (isEditing())
 197       {
 198         removeEditor();
 199       }
 200       TableColumn resizingColumn = getTableHeader().getResizingColumn();
 201       // Need to do this here, before the parent's
 202       // layout manager calls getPreferredSize().
 203       if (resizingColumn != null && autoResizeMode == AUTO_RESIZE_OFF
 204               && !inLayout)
 205       {
 206         resizingColumn.setPreferredWidth(resizingColumn.getWidth());
 207         String colHeader = resizingColumn.getHeaderValue().toString();
 208         getTempUserPrefs().put(colHeader, resizingColumn.getWidth());
 209       }
 210       resizeAndRepaint();
 211     }
 212
 213     @Override
 214     public String getToolTipText(MouseEvent evt)
 215     {
 216       String toolTipText = null;
 217       java.awt.Point pnt = evt.getPoint();
 218       int rowIndex = rowAtPoint(pnt);
 219       int colIndex = columnAtPoint(pnt);
 220
 221       try
 222       {
 223         if (getValueAt(rowIndex, colIndex) == null)
 224         {
 225           return null;
 226         }
 227         toolTipText = getValueAt(rowIndex, colIndex).toString();
 228
 229       } catch (Exception e)
 230       {
 231         e.printStackTrace();
 232       }
 233       toolTipText = (toolTipText == null ? null
 234               : (toolTipText.length() > 500
 235                       ? JvSwingUtils.wrapTooltip(true,
 236                               toolTipText.subSequence(0, 500) + "...")
 237                       : JvSwingUtils.wrapTooltip(true, toolTipText)));
 238
 239       return toolTipText;
 240     }
 241   };
 242
 243   protected JScrollPane scrl_searchResult = new JScrollPane(tbl_summary);
 244
 245   public GFTSPanel()
 246   {
 247     this(null);
 248   }
 249
 250   public GFTSPanel(SequenceFetcher fetcher)
 251   {
 252     try
 253     {
 254       if (fetcher == null)
 255       {
 256         mainFramTabs = null;
 257       }
 258       jbInit();
 259       if (fetcher != null)
 260       {
 261         mainFramTabs.addTab("Retrieve IDs", fetcher);
 262         fetcher.setDatabaseChooserVisible(false);
 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("");
 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.setBackground(Color.white);
 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   protected 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   protected 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 }