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