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