JAL-2668 fix broken factory method for colour scheme
[jalview.git] / src / jalview / gui / PCAPanel.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 package jalview.gui;
22
23 import jalview.analysis.scoremodels.ScoreModels;
24 import jalview.analysis.scoremodels.SimilarityParams;
25 import jalview.api.analysis.ScoreModelI;
26 import jalview.api.analysis.SimilarityParamsI;
27 import jalview.datamodel.Alignment;
28 import jalview.datamodel.AlignmentI;
29 import jalview.datamodel.AlignmentView;
30 import jalview.datamodel.HiddenColumns;
31 import jalview.datamodel.SequenceI;
32 import jalview.jbgui.GPCAPanel;
33 import jalview.util.MessageManager;
34 import jalview.viewmodel.AlignmentViewport;
35 import jalview.viewmodel.PCAModel;
36
37 import java.awt.BorderLayout;
38 import java.awt.Color;
39 import java.awt.Dimension;
40 import java.awt.Graphics;
41 import java.awt.event.ActionEvent;
42 import java.awt.event.ActionListener;
43 import java.awt.print.PageFormat;
44 import java.awt.print.Printable;
45 import java.awt.print.PrinterException;
46 import java.awt.print.PrinterJob;
47
48 import javax.swing.ButtonGroup;
49 import javax.swing.JCheckBoxMenuItem;
50 import javax.swing.JColorChooser;
51 import javax.swing.JMenuItem;
52 import javax.swing.JRadioButtonMenuItem;
53 import javax.swing.event.InternalFrameAdapter;
54 import javax.swing.event.InternalFrameEvent;
55
56 /**
57  * DOCUMENT ME!
58  * 
59  * @author $author$
60  * @version $Revision$
61  */
62 public class PCAPanel extends GPCAPanel
63         implements Runnable, IProgressIndicator
64 {
65
66   private IProgressIndicator progressBar;
67
68   RotatableCanvas rc;
69
70   AlignmentPanel ap;
71
72   AlignmentViewport av;
73
74   PCAModel pcaModel;
75
76   private static final int MIN_WIDTH = 470;
77
78   private static final int MIN_HEIGHT = 250;
79
80   int top = 0;
81
82   private boolean working;
83
84   /**
85    * Creates a new PCAPanel object using default score model and parameters
86    * 
87    * @param alignPanel
88    */
89   public PCAPanel(AlignmentPanel alignPanel)
90   {
91     this(alignPanel,
92             ScoreModels.getInstance()
93                     .getDefaultModel(
94                             !alignPanel.av.getAlignment().isNucleotide())
95                     .getName(),
96             SimilarityParams.SeqSpace);
97   }
98
99   /**
100    * Constructor given sequence data, a similarity (or distance) score model
101    * name, and score calculation parameters
102    * 
103    * @param alignPanel
104    * @param modelName
105    * @param params
106    */
107   public PCAPanel(AlignmentPanel alignPanel, String modelName,
108           SimilarityParamsI params)
109   {
110     super();
111     this.av = alignPanel.av;
112     this.ap = alignPanel;
113     boolean nucleotide = av.getAlignment().isNucleotide();
114
115     progressBar = new ProgressBar(statusPanel, statusBar);
116
117     addInternalFrameListener(new InternalFrameAdapter()
118     {
119       @Override
120       public void internalFrameClosed(InternalFrameEvent e)
121       {
122         close_actionPerformed();
123       }
124     });
125
126     boolean selected = av.getSelectionGroup() != null
127             && av.getSelectionGroup().getSize() > 0;
128     AlignmentView seqstrings = av.getAlignmentView(selected);
129     SequenceI[] seqs;
130     if (!selected)
131     {
132       seqs = av.getAlignment().getSequencesArray();
133     }
134     else
135     {
136       seqs = av.getSelectionGroup().getSequencesInOrder(av.getAlignment());
137     }
138
139     ScoreModelI scoreModel = ScoreModels.getInstance()
140             .getScoreModel(modelName, ap);
141     pcaModel = new PCAModel(seqstrings, seqs, nucleotide, scoreModel,
142             params);
143     PaintRefresher.Register(this, av.getSequenceSetId());
144
145     rc = new RotatableCanvas(alignPanel);
146     this.getContentPane().add(rc, BorderLayout.CENTER);
147     Thread worker = new Thread(this);
148     worker.start();
149   }
150
151   /**
152    * Ensure references to potentially very large objects (the PCA matrices) are
153    * nulled when the frame is closed
154    */
155   protected void close_actionPerformed()
156   {
157     pcaModel = null;
158   }
159
160   /**
161    * Repopulate the options and actions under the score model menu when it is
162    * selected. Options will depend on whether 'nucleotide' or 'peptide'
163    * modelling is selected (and also possibly on whether any additional score
164    * models have been added).
165    */
166   @Override
167   protected void scoreModel_menuSelected()
168   {
169     scoreModelMenu.removeAll();
170     for (final ScoreModelI sm : ScoreModels.getInstance().getModels())
171     {
172       final String name = sm.getName();
173       JCheckBoxMenuItem jm = new JCheckBoxMenuItem(name);
174
175       /*
176        * if the score model doesn't provide a description, try to look one
177        * up in the text bundle, falling back on its name
178        */
179       String tooltip = sm.getDescription();
180       if (tooltip == null)
181       {
182         tooltip = MessageManager.getStringOrReturn("label.score_model_",
183                 name);
184       }
185       jm.setToolTipText(tooltip);
186       jm.setSelected(pcaModel.getScoreModelName().equals(name));
187       if ((pcaModel.isNucleotide() && sm.isDNA())
188               || (!pcaModel.isNucleotide() && sm.isProtein()))
189       {
190         jm.addActionListener(new ActionListener()
191         {
192           @Override
193           public void actionPerformed(ActionEvent e)
194           {
195             if (!pcaModel.getScoreModelName().equals(name))
196             {
197               ScoreModelI sm2 = ScoreModels.getInstance()
198                       .getScoreModel(name, ap);
199               pcaModel.setScoreModel(sm2);
200               Thread worker = new Thread(PCAPanel.this);
201               worker.start();
202             }
203           }
204         });
205         scoreModelMenu.add(jm);
206       }
207     }
208   }
209
210   @Override
211   public void bgcolour_actionPerformed(ActionEvent e)
212   {
213     Color col = JColorChooser.showDialog(this,
214             MessageManager.getString("label.select_background_colour"),
215             rc.bgColour);
216
217     if (col != null)
218     {
219       rc.bgColour = col;
220     }
221     rc.repaint();
222   }
223
224   /**
225    * DOCUMENT ME!
226    */
227   @Override
228   public void run()
229   {
230     long progId = System.currentTimeMillis();
231     IProgressIndicator progress = this;
232     String message = MessageManager.getString("label.pca_recalculating");
233     if (getParent() == null)
234     {
235       progress = ap.alignFrame;
236       message = MessageManager.getString("label.pca_calculating");
237     }
238     progress.setProgressBar(message, progId);
239     working = true;
240     try
241     {
242       calcSettings.setEnabled(false);
243       pcaModel.run();
244       // ////////////////
245       xCombobox.setSelectedIndex(0);
246       yCombobox.setSelectedIndex(1);
247       zCombobox.setSelectedIndex(2);
248
249       pcaModel.updateRc(rc);
250       // rc.invalidate();
251       nuclSetting.setSelected(pcaModel.isNucleotide());
252       protSetting.setSelected(!pcaModel.isNucleotide());
253       top = pcaModel.getTop();
254
255     } catch (OutOfMemoryError er)
256     {
257       new OOMWarning("calculating PCA", er);
258       working = false;
259       return;
260     } finally
261     {
262       progress.setProgressBar("", progId);
263     }
264     calcSettings.setEnabled(true);
265     repaint();
266     if (getParent() == null)
267     {
268       addKeyListener(rc);
269       Desktop.addInternalFrame(this, MessageManager
270               .getString("label.principal_component_analysis"), 475, 450);
271       this.setMinimumSize(new Dimension(MIN_WIDTH, MIN_HEIGHT));
272     }
273     working = false;
274   }
275
276   @Override
277   protected void nuclSetting_actionPerfomed(ActionEvent arg0)
278   {
279     if (!pcaModel.isNucleotide())
280     {
281       pcaModel.setNucleotide(true);
282       pcaModel.setScoreModel(
283               ScoreModels.getInstance().getDefaultModel(false));
284       Thread worker = new Thread(this);
285       worker.start();
286     }
287
288   }
289
290   @Override
291   protected void protSetting_actionPerfomed(ActionEvent arg0)
292   {
293
294     if (pcaModel.isNucleotide())
295     {
296       pcaModel.setNucleotide(false);
297       pcaModel.setScoreModel(
298               ScoreModels.getInstance().getDefaultModel(true));
299       Thread worker = new Thread(this);
300       worker.start();
301     }
302   }
303
304   /**
305    * DOCUMENT ME!
306    */
307   void doDimensionChange()
308   {
309     if (top == 0)
310     {
311       return;
312     }
313
314     int dim1 = top - xCombobox.getSelectedIndex();
315     int dim2 = top - yCombobox.getSelectedIndex();
316     int dim3 = top - zCombobox.getSelectedIndex();
317     pcaModel.updateRcView(dim1, dim2, dim3);
318     rc.img = null;
319     rc.rotmat.setIdentity();
320     rc.initAxes();
321     rc.paint(rc.getGraphics());
322   }
323
324   /**
325    * DOCUMENT ME!
326    * 
327    * @param e
328    *          DOCUMENT ME!
329    */
330   @Override
331   protected void xCombobox_actionPerformed(ActionEvent e)
332   {
333     doDimensionChange();
334   }
335
336   /**
337    * DOCUMENT ME!
338    * 
339    * @param e
340    *          DOCUMENT ME!
341    */
342   @Override
343   protected void yCombobox_actionPerformed(ActionEvent e)
344   {
345     doDimensionChange();
346   }
347
348   /**
349    * DOCUMENT ME!
350    * 
351    * @param e
352    *          DOCUMENT ME!
353    */
354   @Override
355   protected void zCombobox_actionPerformed(ActionEvent e)
356   {
357     doDimensionChange();
358   }
359
360   @Override
361   public void outputValues_actionPerformed(ActionEvent e)
362   {
363     CutAndPasteTransfer cap = new CutAndPasteTransfer();
364     try
365     {
366       cap.setText(pcaModel.getDetails());
367       Desktop.addInternalFrame(cap,
368               MessageManager.getString("label.pca_details"), 500, 500);
369     } catch (OutOfMemoryError oom)
370     {
371       new OOMWarning("opening PCA details", oom);
372       cap.dispose();
373     }
374   }
375
376   @Override
377   public void showLabels_actionPerformed(ActionEvent e)
378   {
379     rc.showLabels(showLabels.getState());
380   }
381
382   @Override
383   public void print_actionPerformed(ActionEvent e)
384   {
385     PCAPrinter printer = new PCAPrinter();
386     printer.start();
387   }
388
389   @Override
390   public void originalSeqData_actionPerformed(ActionEvent e)
391   {
392     // this was cut'n'pasted from the equivalent TreePanel method - we should
393     // make this an abstract function of all jalview analysis windows
394     if (pcaModel.getSeqtrings() == null)
395     {
396       jalview.bin.Cache.log.info(
397               "Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
398       return;
399     }
400     // decide if av alignment is sufficiently different to original data to
401     // warrant a new window to be created
402     // create new alignmnt window with hidden regions (unhiding hidden regions
403     // yields unaligned seqs)
404     // or create a selection box around columns in alignment view
405     // test Alignment(SeqCigar[])
406     char gc = '-';
407     try
408     {
409       // we try to get the associated view's gap character
410       // but this may fail if the view was closed...
411       gc = av.getGapCharacter();
412     } catch (Exception ex)
413     {
414     }
415     ;
416     Object[] alAndColsel = pcaModel.getSeqtrings()
417             .getAlignmentAndHiddenColumns(gc);
418
419     if (alAndColsel != null && alAndColsel[0] != null)
420     {
421       // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
422
423       AlignmentI al = new Alignment((SequenceI[]) alAndColsel[0]);
424       AlignmentI dataset = (av != null && av.getAlignment() != null)
425               ? av.getAlignment().getDataset()
426               : null;
427       if (dataset != null)
428       {
429         al.setDataset(dataset);
430       }
431
432       if (true)
433       {
434         // make a new frame!
435         AlignFrame af = new AlignFrame(al, (HiddenColumns) alAndColsel[1],
436                 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
437
438         // >>>This is a fix for the moment, until a better solution is
439         // found!!<<<
440         // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
441
442         // af.addSortByOrderMenuItem(ServiceName + " Ordering",
443         // msaorder);
444
445         Desktop.addInternalFrame(af, MessageManager.formatMessage(
446                 "label.original_data_for_params", new String[]
447                 { this.title }), AlignFrame.DEFAULT_WIDTH,
448                 AlignFrame.DEFAULT_HEIGHT);
449       }
450     }
451     /*
452      * CutAndPasteTransfer cap = new CutAndPasteTransfer(); for (int i = 0; i <
453      * seqs.length; i++) { cap.appendText(new jalview.util.Format("%-" + 15 +
454      * "s").form( seqs[i].getName())); cap.appendText(" " + seqstrings[i] +
455      * "\n"); }
456      * 
457      * Desktop.addInternalFrame(cap, "Original Data", 400, 400);
458      */
459   }
460
461   class PCAPrinter extends Thread implements Printable
462   {
463     @Override
464     public void run()
465     {
466       PrinterJob printJob = PrinterJob.getPrinterJob();
467       PageFormat pf = printJob.pageDialog(printJob.defaultPage());
468
469       printJob.setPrintable(this, pf);
470
471       if (printJob.printDialog())
472       {
473         try
474         {
475           printJob.print();
476         } catch (Exception PrintException)
477         {
478           PrintException.printStackTrace();
479         }
480       }
481     }
482
483     @Override
484     public int print(Graphics pg, PageFormat pf, int pi)
485             throws PrinterException
486     {
487       pg.translate((int) pf.getImageableX(), (int) pf.getImageableY());
488
489       rc.drawBackground(pg, rc.bgColour);
490       rc.drawScene(pg);
491       if (rc.drawAxes == true)
492       {
493         rc.drawAxes(pg);
494       }
495
496       if (pi == 0)
497       {
498         return Printable.PAGE_EXISTS;
499       }
500       else
501       {
502         return Printable.NO_SUCH_PAGE;
503       }
504     }
505   }
506
507   /**
508    * DOCUMENT ME!
509    * 
510    * @param e
511    *          DOCUMENT ME!
512    */
513   @Override
514   public void eps_actionPerformed(ActionEvent e)
515   {
516     makePCAImage(jalview.util.ImageMaker.TYPE.EPS);
517   }
518
519   /**
520    * DOCUMENT ME!
521    * 
522    * @param e
523    *          DOCUMENT ME!
524    */
525   @Override
526   public void png_actionPerformed(ActionEvent e)
527   {
528     makePCAImage(jalview.util.ImageMaker.TYPE.PNG);
529   }
530
531   void makePCAImage(jalview.util.ImageMaker.TYPE type)
532   {
533     int width = rc.getWidth();
534     int height = rc.getHeight();
535
536     jalview.util.ImageMaker im;
537
538     if (type == jalview.util.ImageMaker.TYPE.PNG)
539     {
540       im = new jalview.util.ImageMaker(this,
541               jalview.util.ImageMaker.TYPE.PNG, "Make PNG image from PCA",
542               width, height, null, null, null, 0, false);
543     }
544     else if (type == jalview.util.ImageMaker.TYPE.EPS)
545     {
546       im = new jalview.util.ImageMaker(this,
547               jalview.util.ImageMaker.TYPE.EPS, "Make EPS file from PCA",
548               width, height, null, this.getTitle(), null, 0, false);
549     }
550     else
551     {
552       im = new jalview.util.ImageMaker(this,
553               jalview.util.ImageMaker.TYPE.SVG, "Make SVG file from PCA",
554               width, height, null, this.getTitle(), null, 0, false);
555
556     }
557
558     if (im.getGraphics() != null)
559     {
560       rc.drawBackground(im.getGraphics(), Color.black);
561       rc.drawScene(im.getGraphics());
562       if (rc.drawAxes == true)
563       {
564         rc.drawAxes(im.getGraphics());
565       }
566       im.writeImage();
567     }
568   }
569
570   @Override
571   public void viewMenu_menuSelected()
572   {
573     buildAssociatedViewMenu();
574   }
575
576   void buildAssociatedViewMenu()
577   {
578     AlignmentPanel[] aps = PaintRefresher
579             .getAssociatedPanels(av.getSequenceSetId());
580     if (aps.length == 1 && rc.av == aps[0].av)
581     {
582       associateViewsMenu.setVisible(false);
583       return;
584     }
585
586     associateViewsMenu.setVisible(true);
587
588     if ((viewMenu
589             .getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
590     {
591       viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
592     }
593
594     associateViewsMenu.removeAll();
595
596     JRadioButtonMenuItem item;
597     ButtonGroup buttonGroup = new ButtonGroup();
598     int i, iSize = aps.length;
599     final PCAPanel thisPCAPanel = this;
600     for (i = 0; i < iSize; i++)
601     {
602       final AlignmentPanel ap = aps[i];
603       item = new JRadioButtonMenuItem(ap.av.viewName, ap.av == rc.av);
604       buttonGroup.add(item);
605       item.addActionListener(new ActionListener()
606       {
607         @Override
608         public void actionPerformed(ActionEvent evt)
609         {
610           rc.applyToAllViews = false;
611           rc.av = ap.av;
612           rc.ap = ap;
613           PaintRefresher.Register(thisPCAPanel, ap.av.getSequenceSetId());
614         }
615       });
616
617       associateViewsMenu.add(item);
618     }
619
620     final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem(
621             "All Views");
622
623     buttonGroup.add(itemf);
624
625     itemf.setSelected(rc.applyToAllViews);
626     itemf.addActionListener(new ActionListener()
627     {
628       @Override
629       public void actionPerformed(ActionEvent evt)
630       {
631         rc.applyToAllViews = itemf.isSelected();
632       }
633     });
634     associateViewsMenu.add(itemf);
635
636   }
637
638   /*
639    * (non-Javadoc)
640    * 
641    * @see
642    * jalview.jbgui.GPCAPanel#outputPoints_actionPerformed(java.awt.event.ActionEvent
643    * )
644    */
645   @Override
646   protected void outputPoints_actionPerformed(ActionEvent e)
647   {
648     CutAndPasteTransfer cap = new CutAndPasteTransfer();
649     try
650     {
651       cap.setText(pcaModel.getPointsasCsv(false,
652               xCombobox.getSelectedIndex(), yCombobox.getSelectedIndex(),
653               zCombobox.getSelectedIndex()));
654       Desktop.addInternalFrame(cap, MessageManager
655               .formatMessage("label.points_for_params", new String[]
656               { this.getTitle() }), 500, 500);
657     } catch (OutOfMemoryError oom)
658     {
659       new OOMWarning("exporting PCA points", oom);
660       cap.dispose();
661     }
662   }
663
664   /*
665    * (non-Javadoc)
666    * 
667    * @see
668    * jalview.jbgui.GPCAPanel#outputProjPoints_actionPerformed(java.awt.event
669    * .ActionEvent)
670    */
671   @Override
672   protected void outputProjPoints_actionPerformed(ActionEvent e)
673   {
674     CutAndPasteTransfer cap = new CutAndPasteTransfer();
675     try
676     {
677       cap.setText(pcaModel.getPointsasCsv(true,
678               xCombobox.getSelectedIndex(), yCombobox.getSelectedIndex(),
679               zCombobox.getSelectedIndex()));
680       Desktop.addInternalFrame(cap, MessageManager.formatMessage(
681               "label.transformed_points_for_params", new String[]
682               { this.getTitle() }), 500, 500);
683     } catch (OutOfMemoryError oom)
684     {
685       new OOMWarning("exporting transformed PCA points", oom);
686       cap.dispose();
687     }
688   }
689
690   /*
691    * (non-Javadoc)
692    * 
693    * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
694    */
695   @Override
696   public void setProgressBar(String message, long id)
697   {
698     progressBar.setProgressBar(message, id);
699     // if (progressBars == null)
700     // {
701     // progressBars = new Hashtable();
702     // progressBarHandlers = new Hashtable();
703     // }
704     //
705     // JPanel progressPanel;
706     // Long lId = new Long(id);
707     // GridLayout layout = (GridLayout) statusPanel.getLayout();
708     // if (progressBars.get(lId) != null)
709     // {
710     // progressPanel = (JPanel) progressBars.get(new Long(id));
711     // statusPanel.remove(progressPanel);
712     // progressBars.remove(lId);
713     // progressPanel = null;
714     // if (message != null)
715     // {
716     // statusBar.setText(message);
717     // }
718     // if (progressBarHandlers.contains(lId))
719     // {
720     // progressBarHandlers.remove(lId);
721     // }
722     // layout.setRows(layout.getRows() - 1);
723     // }
724     // else
725     // {
726     // progressPanel = new JPanel(new BorderLayout(10, 5));
727     //
728     // JProgressBar progressBar = new JProgressBar();
729     // progressBar.setIndeterminate(true);
730     //
731     // progressPanel.add(new JLabel(message), BorderLayout.WEST);
732     // progressPanel.add(progressBar, BorderLayout.CENTER);
733     //
734     // layout.setRows(layout.getRows() + 1);
735     // statusPanel.add(progressPanel);
736     //
737     // progressBars.put(lId, progressPanel);
738     // }
739     // // update GUI
740     // // setMenusForViewport();
741     // validate();
742   }
743
744   @Override
745   public void registerHandler(final long id,
746           final IProgressIndicatorHandler handler)
747   {
748     progressBar.registerHandler(id, handler);
749     // if (progressBarHandlers == null || !progressBars.contains(new Long(id)))
750     // {
751     // throw new
752     // Error(MessageManager.getString("error.call_setprogressbar_before_registering_handler"));
753     // }
754     // progressBarHandlers.put(new Long(id), handler);
755     // final JPanel progressPanel = (JPanel) progressBars.get(new Long(id));
756     // if (handler.canCancel())
757     // {
758     // JButton cancel = new JButton(
759     // MessageManager.getString("action.cancel"));
760     // final IProgressIndicator us = this;
761     // cancel.addActionListener(new ActionListener()
762     // {
763     //
764     // @Override
765     // public void actionPerformed(ActionEvent e)
766     // {
767     // handler.cancelActivity(id);
768     // us.setProgressBar(MessageManager.formatMessage("label.cancelled_params",
769     // new String[]{((JLabel) progressPanel.getComponent(0)).getText()}), id);
770     // }
771     // });
772     // progressPanel.add(cancel, BorderLayout.EAST);
773     // }
774   }
775
776   /**
777    * 
778    * @return true if any progress bars are still active
779    */
780   @Override
781   public boolean operationInProgress()
782   {
783     return progressBar.operationInProgress();
784   }
785
786   @Override
787   protected void resetButton_actionPerformed(ActionEvent e)
788   {
789     int t = top;
790     top = 0; // ugly - prevents dimensionChanged events from being processed
791     xCombobox.setSelectedIndex(0);
792     yCombobox.setSelectedIndex(1);
793     top = t;
794     zCombobox.setSelectedIndex(2);
795   }
796
797   /**
798    * Answers true if PCA calculation is in progress, else false
799    * 
800    * @return
801    */
802   public boolean isWorking()
803   {
804     return working;
805   }
806 }