JAL-1863 allow RNA secondary structure rows exported by Jalview to be imported again
[jalview.git] / src / jalview / gui / WsJobParameters.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 java.awt.BorderLayout;
24 import java.awt.Component;
25 import java.awt.Dimension;
26 import java.awt.FlowLayout;
27 import java.awt.Font;
28 import java.awt.GridBagConstraints;
29 import java.awt.GridBagLayout;
30 import java.awt.GridLayout;
31 import java.awt.Rectangle;
32 import java.awt.event.ActionEvent;
33 import java.awt.event.ActionListener;
34 import java.awt.event.HierarchyBoundsListener;
35 import java.awt.event.HierarchyEvent;
36 import java.awt.event.ItemEvent;
37 import java.awt.event.ItemListener;
38 import java.awt.event.WindowEvent;
39 import java.awt.event.WindowListener;
40 import java.net.URL;
41 import java.util.Hashtable;
42 import java.util.Iterator;
43 import java.util.List;
44 import java.util.Vector;
45
46 import javax.swing.JButton;
47 import javax.swing.JComboBox;
48 import javax.swing.JDialog;
49 import javax.swing.JFrame;
50 import javax.swing.JLabel;
51 import javax.swing.JOptionPane;
52 import javax.swing.JPanel;
53 import javax.swing.JScrollPane;
54 import javax.swing.JSplitPane;
55 import javax.swing.JTextArea;
56 import javax.swing.border.TitledBorder;
57 import javax.swing.event.DocumentEvent;
58 import javax.swing.event.DocumentListener;
59
60 import net.miginfocom.swing.MigLayout;
61
62 import compbio.metadata.Argument;
63 import compbio.metadata.Option;
64 import compbio.metadata.Parameter;
65 import compbio.metadata.Preset;
66 import compbio.metadata.PresetManager;
67 import compbio.metadata.RunnerConfig;
68
69 import jalview.gui.OptsAndParamsPage.OptionBox;
70 import jalview.gui.OptsAndParamsPage.ParamBox;
71 import jalview.util.MessageManager;
72 import jalview.ws.jws2.JabaParamStore;
73 import jalview.ws.jws2.JabaPreset;
74 import jalview.ws.jws2.Jws2Discoverer;
75 import jalview.ws.jws2.jabaws2.Jws2Instance;
76 import jalview.ws.params.ArgumentI;
77 import jalview.ws.params.OptionI;
78 import jalview.ws.params.ParamDatastoreI;
79 import jalview.ws.params.ParameterI;
80 import jalview.ws.params.WsParamSetI;
81
82 /**
83  * job parameter editing/browsing dialog box. User can browse existing settings
84  * (user + presets + Defaults), and any changes to parameters creates a modified
85  * user parameter set. LOGIC: If the parameter set is modified, and its name is
86  * a valid, non-existant user parameter set, then a save button is shown. If the
87  * parameter set is modified and its name is a valid, extant user parameter set,
88  * then an update button is shown. If user parameter set's name is edited, and
89  * old name exists as a writable user parameter set, then rename button is
90  * shown. If current parameter set is associated with a user defined parameter
91  * set, then : if set is modifed, a 'revert' button is shown. if set is not
92  * modified, a 'delete' button is shown.
93  * 
94  * @author JimP
95  * 
96  */
97 public class WsJobParameters extends JPanel implements ItemListener,
98         ActionListener, DocumentListener, OptsParametersContainerI
99 {
100   URL linkImageURL = getClass().getResource("/images/link.gif");
101
102   private static final String SVC_DEF = "Defaults"; // this is the null
103                                                     // parameter set as shown to
104                                                     // user
105
106   /**
107    * manager for options and parameters.
108    */
109   OptsAndParamsPage opanp = new OptsAndParamsPage(this);
110
111   /**
112    * panel containing job options
113    */
114   JPanel jobOptions = new JPanel();
115
116   /**
117    * panel containing job parameters
118    */
119   JPanel paramList = new JPanel();
120
121   JPanel SetNamePanel = new JPanel();
122
123   JPanel setDetails = new JPanel();
124
125   JSplitPane settingsPanel = new JSplitPane();
126
127   JPanel jobPanel = new JPanel();
128
129   JScrollPane jobOptionsPane = new JScrollPane();
130
131   JButton createpref = new JButton();
132
133   JButton deletepref = new JButton();
134
135   JButton revertpref = new JButton();
136
137   JButton updatepref = new JButton();
138
139   JButton startjob = new JButton();
140
141   JButton canceljob = new JButton();
142
143   JComboBox setName = new JComboBox();
144
145   JTextArea setDescr = new JTextArea();
146
147   JScrollPane paramPane = new JScrollPane();
148
149   // ScrollablePanel optsAndparams = new ScrollablePanel();
150   JPanel optsAndparams = new JPanel();
151
152   RunnerConfig serviceOptions;
153
154   ParamDatastoreI paramStore;
155
156   private int MAX_OPTWIDTH = 200;
157
158   WsJobParameters(Jws2Instance service)
159   {
160     this(service, null);
161   }
162
163   public WsJobParameters(Jws2Instance service, WsParamSetI preset)
164   {
165     this(null, service, preset, null);
166   }
167
168   /**
169    * 
170    * @param desktop
171    *          - if null, create new JFrame outside of desktop
172    * @param service
173    * @param preset
174    */
175   public WsJobParameters(JFrame parent, Jws2Instance service,
176           WsParamSetI preset, List<Argument> jobArgset)
177   {
178     this(parent, null, service, preset, jobArgset);
179   }
180
181   /**
182    * 
183    * @param parent
184    * @param paramStorei
185    * @param service
186    * @param preset
187    * @param jobArgset
188    */
189   public WsJobParameters(JFrame parent, ParamDatastoreI paramStorei,
190           Jws2Instance service, WsParamSetI preset, List<Argument> jobArgset)
191   {
192     super();
193     jbInit();
194     this.paramStore = paramStorei;
195     if (paramStore == null)
196     {
197       paramStore = service.getParamStore();
198     }
199     this.service = service;
200     // argSetModified(false);
201     // populate parameter table
202     initForService(service, preset, jobArgset);
203     // display in new JFrame attached to parent.
204     validate();
205   }
206
207   int response = -1;
208
209   JDialog frame = null;
210
211   /**
212    * shows a modal dialog containing the parameters.
213    * 
214    * @return
215    */
216   public boolean showRunDialog()
217   {
218
219     frame = new JDialog(Desktop.instance, true);
220
221     frame.setTitle(MessageManager.formatMessage("label.edit_params_for",
222             new String[]
223             { service.getActionText() }));
224     Rectangle deskr = Desktop.instance.getBounds();
225     Dimension pref = this.getPreferredSize();
226     frame.setBounds(new Rectangle(
227             (int) (deskr.getCenterX() - pref.width / 2), (int) (deskr
228                     .getCenterY() - pref.height / 2), pref.width,
229             pref.height));
230     frame.setContentPane(this);
231
232     // should perhaps recover defaults from user prefs.
233
234     frame.validate();
235     javax.swing.SwingUtilities.invokeLater(new Runnable()
236     {
237       public void run()
238       {
239         // jobPanel.setDividerLocation(0.25);
240
241       }
242     });
243     frame.setVisible(true);
244
245     if (response > 0)
246     {
247       return true;
248     }
249     return false;
250   }
251
252   private void jbInit()
253   {
254     this.addHierarchyBoundsListener(new HierarchyBoundsListener()
255     {
256
257       @Override
258       public void ancestorResized(HierarchyEvent arg0)
259       {
260         refreshParamLayout();
261       }
262
263       @Override
264       public void ancestorMoved(HierarchyEvent arg0)
265       {
266         // TODO Auto-generated method stub
267
268       }
269     });
270     updatepref = JvSwingUtils.makeButton(
271             MessageManager.getString("action.update"),
272             MessageManager.getString("label.update_user_parameter_set"),
273             new ActionListener()
274             {
275
276               public void actionPerformed(ActionEvent e)
277               {
278                 update_actionPerformed(e);
279               }
280             });
281     deletepref = JvSwingUtils.makeButton(
282             MessageManager.getString("action.delete"),
283             MessageManager.getString("label.delete_user_parameter_set"),
284             new ActionListener()
285             {
286
287               public void actionPerformed(ActionEvent e)
288               {
289                 delete_actionPerformed(e);
290               }
291             });
292     createpref = JvSwingUtils.makeButton(
293             MessageManager.getString("action.create"),
294             MessageManager.getString("label.create_user_parameter_set"),
295             new ActionListener()
296             {
297
298               public void actionPerformed(ActionEvent e)
299               {
300                 create_actionPerformed(e);
301               }
302             });
303     revertpref = JvSwingUtils.makeButton(MessageManager
304             .getString("action.revert"), MessageManager
305             .getString("label.revert_changes_user_parameter_set"),
306             new ActionListener()
307             {
308
309               public void actionPerformed(ActionEvent e)
310               {
311                 revert_actionPerformed(e);
312               }
313             });
314     startjob = JvSwingUtils.makeButton(
315             MessageManager.getString("action.start_job"),
316             MessageManager.getString("label.start_job_current_settings"),
317             new ActionListener()
318             {
319               public void actionPerformed(ActionEvent e)
320               {
321                 startjob_actionPerformed(e);
322               }
323             });
324     canceljob = JvSwingUtils.makeButton(
325             MessageManager.getString("action.cancel_job"),
326             MessageManager.getString("label.cancel_job_close_dialog"),
327             new ActionListener()
328             {
329               public void actionPerformed(ActionEvent e)
330               {
331                 canceljob_actionPerformed(e);
332               }
333             });
334
335     setDetails.setBorder(new TitledBorder(MessageManager
336             .getString("label.details")));
337     setDetails.setLayout(new BorderLayout());
338     setDescr.setColumns(40);
339     setDescr.setWrapStyleWord(true);
340     setDescr.setLineWrap(true);
341     setDescr.setBackground(getBackground());
342     setDescr.setEditable(true);
343     setDescr.getDocument().addDocumentListener(this);
344     setDescr.setToolTipText(MessageManager
345             .getString("label.edit_notes_parameter_set"));
346     JScrollPane setDescrView = new JScrollPane();
347     setDescrView.getViewport().setView(setDescr);
348     setName.setEditable(true);
349     setName.addItemListener(this);
350     setName.getEditor().addActionListener(this);
351     JPanel setNameInfo = new JPanel(new FlowLayout(FlowLayout.LEFT));
352     GridBagLayout gbl = new GridBagLayout();
353     SetNamePanel.setLayout(gbl);
354
355     JLabel setNameLabel = new JLabel(
356             MessageManager.getString("label.current_parameter_set_name"));
357     setNameLabel.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
358
359     setNameInfo.add(setNameLabel);
360     setNameInfo.add(setName);
361
362     // initial button visibility
363     updatepref.setVisible(false);
364     deletepref.setVisible(false);
365     revertpref.setVisible(false);
366     createpref.setVisible(false);
367     JPanel setsavebuts = new JPanel();
368     setsavebuts.setLayout(new FlowLayout(FlowLayout.LEFT)); // GridLayout(1,2));
369     ((FlowLayout) setsavebuts.getLayout()).setHgap(10);
370     ((FlowLayout) setsavebuts.getLayout()).setVgap(0);
371     JPanel spacer = new JPanel();
372     spacer.setPreferredSize(new Dimension(2, 30));
373     setsavebuts.add(spacer);
374     setsavebuts.add(deletepref);
375     setsavebuts.add(revertpref);
376     setsavebuts.add(createpref);
377     setsavebuts.add(updatepref);
378     // setsavebuts.setSize(new Dimension(150, 30));
379     JPanel buttonArea = new JPanel(new GridLayout(1, 1));
380     buttonArea.add(setsavebuts);
381     SetNamePanel.add(setNameInfo);
382     GridBagConstraints gbc = new GridBagConstraints();
383     gbc.gridheight = 2;
384     gbl.setConstraints(setNameInfo, gbc);
385     SetNamePanel.add(buttonArea);
386     gbc = new GridBagConstraints();
387     gbc.gridx = 0;
388     gbc.gridy = 2;
389     gbc.gridheight = 1;
390     gbl.setConstraints(buttonArea, gbc);
391     setDetails.add(setDescrView, BorderLayout.CENTER);
392
393     // paramPane.setPreferredSize(new Dimension(360, 400));
394     // paramPane.setPreferredSize(null);
395     jobOptions.setBorder(new TitledBorder(MessageManager
396             .getString("label.options")));
397     jobOptions.setOpaque(true);
398     paramList.setBorder(new TitledBorder(MessageManager
399             .getString("label.parameters")));
400     paramList.setOpaque(true);
401     JPanel bjo = new JPanel(new BorderLayout()), bjp = new JPanel(
402             new BorderLayout());
403     bjo.add(jobOptions, BorderLayout.CENTER);
404     bjp.add(paramList, BorderLayout.CENTER);
405     bjp.setOpaque(true);
406     bjo.setOpaque(true);
407     // optsAndparams.setScrollableWidth(ScrollableSizeHint.FIT);
408     // optsAndparams.setScrollableHeight(ScrollableSizeHint.NONE);
409     // optsAndparams.setLayout(new BorderLayout());
410     optsAndparams.setLayout(new BorderLayout());
411     optsAndparams.add(jobOptions, BorderLayout.NORTH);
412     optsAndparams.add(paramList, BorderLayout.CENTER);
413     JPanel jp = new JPanel(new BorderLayout());
414     jp.add(optsAndparams, BorderLayout.CENTER);
415     paramPane.getViewport().setView(jp);
416     paramPane.setBorder(null);
417     setLayout(new BorderLayout());
418     jobPanel.setPreferredSize(null);
419     jobPanel.setLayout(new BorderLayout());
420     jobPanel.add(setDetails, BorderLayout.NORTH);
421     jobPanel.add(paramPane, BorderLayout.CENTER);
422     // jobPanel.setOrientation(JSplitPane.VERTICAL_SPLIT);
423
424     add(SetNamePanel, BorderLayout.NORTH);
425     add(jobPanel, BorderLayout.CENTER);
426
427     JPanel dialogpanel = new JPanel();
428     dialogpanel.add(startjob);
429     dialogpanel.add(canceljob);
430     // JAL-1580: setMaximumSize() doesn't work, so just size for the worst case:
431     // check for null is for JUnit usage
432     final int windowHeight = Desktop.instance == null ? 540
433             : Desktop.instance.getHeight();
434     setPreferredSize(new Dimension(540, windowHeight));
435     add(dialogpanel, BorderLayout.SOUTH);
436     validate();
437   }
438
439   protected void revert_actionPerformed(ActionEvent e)
440   {
441     reInitDialog(lastParmSet);
442     updateWebServiceMenus();
443   }
444
445   protected void update_actionPerformed(ActionEvent e)
446   {
447     if (isUserPreset)
448     {
449       String curname = ((String) setName.getSelectedItem()).trim();
450       _updatePreset(lastParmSet, curname);
451       lastParmSet = curname;
452       isUserPreset = true;
453       initArgSetModified();
454       syncSetNamesWithStore();
455     }
456   }
457
458   private void _deleteUserPreset(String lastParmSet2)
459   {
460     paramStore.deletePreset(lastParmSet2);
461   }
462
463   protected void delete_actionPerformed(ActionEvent e)
464   {
465     if (isUserPreset)
466     {
467       // delete current preset's saved entry
468       _deleteUserPreset(lastParmSet);
469     }
470     reInitDialog(null); // service default
471     updateWebServiceMenus();
472   }
473
474   protected void create_actionPerformed(ActionEvent e)
475   {
476     String curname = ((String) setName.getSelectedItem()).trim();
477     if (curname.length() > 0)
478     {
479       _storeCurrentPreset(curname);
480       lastParmSet = curname;
481       isUserPreset = true;
482       reInitDialog(curname);
483       initArgSetModified();
484       updateWebServiceMenus();
485     }
486     else
487     {
488       // TODO: show warning
489       System.err.println("Invalid name. Not saved.");
490     }
491   }
492
493   protected void canceljob_actionPerformed(ActionEvent e)
494   {
495     response = 0;
496     if (frame != null)
497     {
498       frame.setVisible(false);
499     }
500   }
501
502   protected void startjob_actionPerformed(ActionEvent e)
503   {
504     response = 1;
505     if (frame != null)
506     {
507       frame.setVisible(false);
508     }
509   }
510
511   Jws2Instance service;
512
513   /**
514    * list of service presets in the gui
515    */
516   Hashtable servicePresets = null;
517
518   /**
519    * set if dialog is being set - so handlers will avoid spurious events
520    */
521   boolean settingDialog = false;
522
523   void initForService(Jws2Instance service, WsParamSetI jabap,
524           List<Argument> jabajobArgset)
525   {
526     WsParamSetI p = null;
527     List<ArgumentI> jobArgset = null;
528     settingDialog = true;
529     { // instantiate the abstract proxy for Jaba objects
530       jobArgset = jabajobArgset == null ? null : JabaParamStore
531               .getJwsArgsfromJaba(jabajobArgset);
532       p = jabap; // (jabap != null) ? paramStore.getPreset(jabap.getName()) :
533                  // null;
534     }
535
536     Hashtable exnames = new Hashtable();
537     for (int i = 0, iSize = setName.getItemCount(); i < iSize; i++)
538     {
539       exnames.put(setName.getItemAt(i), setName.getItemAt(i));
540     }
541     servicePresets = new Hashtable();
542     // Add the default entry - if not present already.
543     if (!exnames.contains(SVC_DEF))
544     {
545       setName.addItem(SVC_DEF);
546       exnames.put(SVC_DEF, SVC_DEF);
547       servicePresets.put(SVC_DEF, SVC_DEF);
548     }
549     String curname = (p == null ? "" : p.getName());
550     for (WsParamSetI pr : paramStore.getPresets())
551     {
552       if (!pr.isModifiable())
553       {
554         servicePresets.put(pr.getName(), "preset");
555       }
556       else
557       {
558       }
559       if (!exnames.contains(pr.getName()))
560       {
561         setName.addItem(pr.getName());
562       }
563     }
564     // TODO: if initial jobArgset matches a given user setting or preset then
565     // should recover setting accordingly
566     // updateTable(p, jobArgset);
567     if (p != null)
568     {
569       reInitDialog(p.getName());
570       initArgSetModified();
571     }
572     else
573     {
574       if (jobArgset != null && jobArgset.size() > 0)
575       {
576         curSetName = "Supplied Settings";
577         isUserPreset = false;
578         updateTable(p, jobArgset);
579         setName.setSelectedItem(curSetName);
580         updateButtonDisplay();
581       }
582       else
583       {
584         curSetName = null;
585         reInitDialog(null);
586       }
587     }
588     settingDialog = false;
589
590   }
591
592   @SuppressWarnings("unchecked")
593   private void updateTable(WsParamSetI p, List<ArgumentI> jobArgset)
594   {
595     boolean setDefaultParams = false;
596     if (lastParmSet == null)
597     {
598       isUserPreset = false;
599       // First call - so provide Service default settings
600       setName.setSelectedItem(lastSetName = SVC_DEF);
601     }
602     if (p == null && SVC_DEF.equals("" + setName.getSelectedItem()))
603     {
604       // indicate that service defaults should be set if available
605       setDefaultParams = true;
606     }
607     // populate table from default parameter set.
608     List<ArgumentI> args = paramStore.getServiceParameters();
609
610     // split to params and required arguments
611     {
612       int cw = 0;
613       boolean optset = false;
614       for (ArgumentI myarg : args)
615       {
616         // Ideally, Argument would implement isRequired !
617         if (myarg instanceof ParameterI)
618         {
619           ParameterI parm = (ParameterI) myarg;
620           opanp.addParameter(parm).validate();
621         }
622         else
623         {
624           if (myarg instanceof OptionI)
625           {
626             OptionI opt = (OptionI) myarg;
627             OptionBox ob = opanp.addOption(opt);
628             ob.resetToDefault(setDefaultParams);
629             if (MAX_OPTWIDTH < ob.getPreferredSize().width)
630             {
631               MAX_OPTWIDTH = ob.getPreferredSize().width;
632             }
633             ob.validate();
634             cw += ob.getPreferredSize().width + 5;
635           }
636           else
637           {
638             System.err.println("Ignoring unknown service argument type "
639                     + myarg.getClass().getName());
640           }
641         }
642       }
643       args = null; // no more args to process.
644     }
645     if (p != null)
646     {
647       isUserPreset = false;
648       // initialise setname
649       setName.setSelectedItem(lastSetName = p.getName());
650       setDescr.setText(lastDescrText = p.getDescription());
651       // TODO - URL link
652       try
653       {
654         args = p.getArguments();
655       } catch (Exception e)
656       {
657         e.printStackTrace();
658       }
659       // TODO: check if args should be unselected prior to resetting using the
660       // preset
661     }
662
663     if (jobArgset != null)
664     {
665       argSetModified(jobArgset, true);
666       args = jobArgset;
667     }
668     // get setargs from current object
669     if (args != null)
670     {
671       for (ArgumentI arg : args)
672       {
673         if (arg instanceof ParameterI)
674         {
675           opanp.setParameter((ParameterI) arg);
676         }
677         else
678         {
679           if (arg instanceof OptionI)
680           {
681             // System.out.println("Setting option "
682             // + System.identityHashCode(arg) + ":" + arg.getName()
683             // + " with " + arg.getDefaultValue());
684             opanp.selectOption((OptionI) arg, arg.getValue());
685           }
686         }
687
688       }
689     }
690
691     refreshParamLayout();
692     revalidate();
693   }
694
695   private boolean isModified()
696   {
697     return modifiedElements.size() > 0;
698   }
699
700   private Hashtable modifiedElements = new Hashtable();
701
702   /**
703    * reset gui and modification state settings
704    */
705   private void initArgSetModified()
706   {
707     curSetName = null;
708     modifiedElements.clear();
709     updateButtonDisplay();
710   }
711
712   private void updateButtonDisplay()
713   {
714     boolean _update = false, _create = false, _delete = false, _revert = false;
715     if (modifiedElements.size() > 0)
716     {
717       // set modified
718       _revert = true;
719       _update = isUserPreset; // can only update user presets
720       if (!isUserPreset || modifiedElements.containsKey(setName))
721       {
722         // name modified - can create new preset
723         _create = true;
724       }
725     }
726     else
727     {
728       // set unmodified
729     }
730     // can still delete a user preset
731     _delete = isUserPreset;
732
733     createpref.setVisible(_create);
734     updatepref.setVisible(_update);
735     deletepref.setVisible(_delete);
736     revertpref.setVisible(_revert);
737     validate();
738   }
739
740   public void argSetModified(Object modifiedElement, boolean b)
741   {
742     if (settingDialog)
743     {
744       return;
745     }
746     if (!b)
747     {
748       modifiedElements.remove(modifiedElement);
749     }
750     else
751     {
752       if (b && modifiedElement == setName
753               && modifiedElements.contains(modifiedElement))
754       {
755         // HACK! prevents iteration on makeSetNameValid
756         b = false;
757       }
758       modifiedElements.put(modifiedElement, modifiedElement);
759     }
760     // set mod status based on presence of elements in table
761     if (b && modifiedElements.size() > 0)
762     {
763       makeSetNameValid(!isUserPreset);
764       SetNamePanel.revalidate();
765     }
766     updateButtonDisplay();
767   }
768
769   private boolean isServicePreset(String selectedItem)
770   {
771     return selectedItem.equals(SVC_DEF)
772             || servicePresets.containsKey(selectedItem);
773   }
774
775   /**
776    * check if the current set name is a valid set name for saving, if not, then
777    * fix it.
778    */
779   private void makeSetNameValid(boolean newuserset)
780   {
781     boolean stn = settingDialog;
782     boolean renamed = false;
783     settingDialog = true;
784     String nm = (curSetName != null ? curSetName : (String) setName
785             .getSelectedItem());
786     // check if the name is reserved - if it is, rename it.
787     if (isServicePreset(nm))
788     {
789       nm = "User " + nm;
790       renamed = true;
791     }
792     String tnm = nm;
793     if (newuserset)
794     {
795       int i = 0;
796       while (paramStore.getPreset(tnm) != null)
797       {
798         tnm = nm + " (" + (++i) + ")";
799         renamed = true;
800       }
801       if (i > 0)
802       {
803         nm = tnm;
804       }
805     }
806
807     boolean makeupdate = false;
808     // sync the gui with the preset database
809     for (int i = 0, iS = setName.getItemCount(); i < iS; i++)
810     {
811       String snm = (String) setName.getItemAt(i);
812       if (snm.equals(nm))
813       {
814         makeupdate = true;
815         // setName.setSelectedIndex(i);
816       }
817     }
818     if (!makeupdate)
819     {
820       setName.addItem(curSetName = nm);
821       setName.setSelectedItem(curSetName);
822     }
823     if (renamed)
824     {
825       settingDialog = false; // we need this name change to be registered.
826       argSetModified(setName, renamed);
827     }
828     settingDialog = stn;
829   }
830
831   public void refreshParamLayout()
832   {
833     // optsAndparams.setPreferredSize(null);
834     FlowLayout fl = new FlowLayout(FlowLayout.LEFT);
835     int sep = fl.getVgap();
836     boolean fh = true;
837     int os = 0, s = jobOptions.getBorder().getBorderInsets(jobOptions).bottom
838             + jobOptions.getBorder().getBorderInsets(jobOptions).top
839             + 2
840             * sep;
841     /**
842      * final height for viewport
843      */
844     int finalh = s;
845     int panewidth = paramPane.getViewport().getSize().width - 120
846             - jobOptions.getBorder().getBorderInsets(jobOptions).left
847             + jobOptions.getBorder().getBorderInsets(jobOptions).right;
848
849     int w = 2
850             * fl.getHgap()
851             + (MAX_OPTWIDTH > OptsAndParamsPage.PARAM_WIDTH ? MAX_OPTWIDTH
852                     : OptsAndParamsPage.PARAM_WIDTH);
853     int hgap = fl.getHgap(), cw = hgap;
854
855     if (opanp.getOptSet().size() > 0)
856     {
857
858       jobOptions.setLayout(new MigLayout("", "", ""));
859       jobOptions.removeAll();
860
861       for (OptionBox pbox : opanp.getOptSet().values())
862       {
863         pbox.validate();
864         cw += pbox.getSize().width + hgap;
865         if (cw + 120 > panewidth)
866         {
867           jobOptions.add(pbox, "wrap");
868           // System.out.println("Wrap on "+pbox.option.getName());
869           cw = hgap + pbox.getSize().width;
870           fh = true;
871         }
872         else
873         {
874           jobOptions.add(pbox);
875         }
876         if (fh)
877         {
878           finalh += pbox.getSize().height + fl.getVgap();
879           fh = false;
880         }
881       }
882       jobOptions.revalidate();
883     }
884     else
885     {
886       jobOptions.setVisible(false);
887     }
888
889     // Now layout the parameters assuming they occupy one column - to calculate
890     // total height of options+parameters
891     fl = new FlowLayout(FlowLayout.LEFT);
892     // helpful hint from
893     // http://stackoverflow.com/questions/2743177/top-alignment-for-flowlayout
894     fl.setAlignOnBaseline(true);
895     if (opanp.getParamSet().size() > 0)
896     {
897       paramList.removeAll();
898       paramList.setLayout(new MigLayout("", "", ""));
899       fh = true;
900       for (ParamBox pbox : opanp.getParamSet().values())
901       {
902         pbox.validate();
903         cw += pbox.getSize().width + hgap;
904         if (cw + 160 > panewidth)
905         {
906           paramList.add(pbox, "wrap");
907           cw = pbox.getSize().width + hgap;
908           fh = true;
909         }
910         else
911         {
912           paramList.add(pbox);
913         }
914         if (fh)
915         {
916           finalh += pbox.getSize().height + fl.getVgap();
917           fh = false;
918         }
919
920       }
921       /*
922        * s = 2 * sep; for (ParamBox pbox : opanp.getParamSet().values()) {
923        * pbox.validate(); s += sep +
924        * pbox.getPreferredSize().height+pbox.getBorder
925        * ().getBorderInsets(pbox).bottom; }
926        * 
927        * // paramList.setPreferredSize(new Dimension(w, s));
928        * os+=s+2*sep+paramList
929        * .getBorder().getBorderInsets(paramList).bottom+paramList
930        * .getBorder().getBorderInsets(paramList).top;
931        */
932       paramList.revalidate();
933     }
934     else
935     {
936       paramList.setVisible(false);
937     }
938     // TODO: waste some time trying to eliminate any unnecessary .validate calls
939     // here
940     // System.out.println("Size will be : "+w+","+os);
941     // optsAndparams.setPreferredSize(null);
942     // paramPane.getViewport().setView(optsAndparams);
943     paramPane.getViewport().setAutoscrolls(true);
944     paramPane.revalidate();
945     revalidate();
946   }
947
948   /**
949    * testing method - grab a service and parameter set and show the window
950    * 
951    * @param args
952    */
953   public static void main(String[] args)
954   {
955     jalview.ws.jws2.Jws2Discoverer disc = jalview.ws.jws2.Jws2Discoverer
956             .getDiscoverer();
957     int p = 0;
958     if (args.length > 0)
959     {
960       Vector<String> services = new Vector<String>();
961       services.addElement(args[p++]);
962       Jws2Discoverer.getDiscoverer().setServiceUrls(services);
963     }
964     try
965     {
966       disc.run();
967     } catch (Exception e)
968     {
969       System.err.println("Aborting. Problem discovering services.");
970       e.printStackTrace();
971       return;
972     }
973     Jws2Instance lastserv = null;
974     for (Jws2Instance service : disc.getServices())
975     {
976       lastserv = service;
977       if (p >= args.length || service.serviceType.equalsIgnoreCase(args[p]))
978       {
979         if (lastserv != null)
980         {
981           List<Preset> prl = null;
982           Preset pr = null;
983           if (++p < args.length)
984           {
985             PresetManager prman = lastserv.getPresets();
986             if (prman != null)
987             {
988               pr = prman.getPresetByName(args[p]);
989               if (pr == null)
990               {
991                 // just grab the last preset.
992                 prl = prman.getPresets();
993               }
994             }
995           }
996           else
997           {
998             PresetManager prman = lastserv.getPresets();
999             if (prman != null)
1000             {
1001               prl = prman.getPresets();
1002             }
1003           }
1004           Iterator<Preset> en = (prl == null) ? null : prl.iterator();
1005           while (en != null && en.hasNext())
1006           {
1007             if (en != null)
1008             {
1009               if (!en.hasNext())
1010               {
1011                 en = prl.iterator();
1012               }
1013               pr = en.next();
1014             }
1015             {
1016               System.out.println("Testing opts dupes for "
1017                       + lastserv.getUri() + " : "
1018                       + lastserv.getActionText() + ":" + pr.getName());
1019               List<Option> rg = lastserv.getRunnerConfig().getOptions();
1020               for (Option o : rg)
1021               {
1022                 try
1023                 {
1024                   Option cpy = jalview.ws.jws2.ParameterUtils.copyOption(o);
1025                 } catch (Exception e)
1026                 {
1027                   System.err.println("Failed to copy " + o.getName());
1028                   e.printStackTrace();
1029                 } catch (Error e)
1030                 {
1031                   System.err.println("Failed to copy " + o.getName());
1032                   e.printStackTrace();
1033                 }
1034               }
1035             }
1036             {
1037               System.out.println("Testing param dupes:");
1038               List<Parameter> rg = lastserv.getRunnerConfig()
1039                       .getParameters();
1040               for (Parameter o : rg)
1041               {
1042                 try
1043                 {
1044                   Parameter cpy = jalview.ws.jws2.ParameterUtils
1045                           .copyParameter(o);
1046                 } catch (Exception e)
1047                 {
1048                   System.err.println("Failed to copy " + o.getName());
1049                   e.printStackTrace();
1050                 } catch (Error e)
1051                 {
1052                   System.err.println("Failed to copy " + o.getName());
1053                   e.printStackTrace();
1054                 }
1055               }
1056             }
1057             {
1058               System.out.println("Testing param write:");
1059               List<String> writeparam = null, readparam = null;
1060               try
1061               {
1062                 writeparam = jalview.ws.jws2.ParameterUtils
1063                         .writeParameterSet(
1064                                 pr.getArguments(lastserv.getRunnerConfig()),
1065                                 " ");
1066                 System.out.println("Testing param read :");
1067                 List<Option> pset = jalview.ws.jws2.ParameterUtils
1068                         .processParameters(writeparam,
1069                                 lastserv.getRunnerConfig(), " ");
1070                 readparam = jalview.ws.jws2.ParameterUtils
1071                         .writeParameterSet(pset, " ");
1072                 Iterator<String> o = pr.getOptions().iterator(), s = writeparam
1073                         .iterator(), t = readparam.iterator();
1074                 boolean failed = false;
1075                 while (s.hasNext() && t.hasNext())
1076                 {
1077                   String on = o.next(), sn = s.next(), st = t.next();
1078                   if (!sn.equals(st))
1079                   {
1080                     System.out.println("Original was " + on
1081                             + " Phase 1 wrote " + sn + "\tPhase 2 wrote "
1082                             + st);
1083                     failed = true;
1084                   }
1085                 }
1086                 if (failed)
1087                 {
1088                   System.out.println("Original parameters:\n"
1089                           + pr.getOptions());
1090                   System.out.println("Wrote parameters in first set:\n"
1091                           + writeparam);
1092                   System.out.println("Wrote parameters in second set:\n"
1093                           + readparam);
1094
1095                 }
1096               } catch (Exception e)
1097               {
1098                 e.printStackTrace();
1099               }
1100             }
1101             WsJobParameters pgui = new WsJobParameters(lastserv,
1102                     new JabaPreset(lastserv, pr));
1103             JFrame jf = new JFrame(MessageManager.formatMessage(
1104                     "label.ws_parameters_for", new String[]
1105                     { lastserv.getActionText() }));
1106             JPanel cont = new JPanel(new BorderLayout());
1107             pgui.validate();
1108             cont.setPreferredSize(pgui.getPreferredSize());
1109             cont.add(pgui, BorderLayout.CENTER);
1110             jf.setLayout(new BorderLayout());
1111             jf.add(cont, BorderLayout.CENTER);
1112             jf.validate();
1113             final Thread thr = Thread.currentThread();
1114             jf.addWindowListener(new WindowListener()
1115             {
1116
1117               public void windowActivated(WindowEvent e)
1118               {
1119                 // TODO Auto-generated method stub
1120
1121               }
1122
1123               public void windowClosed(WindowEvent e)
1124               {
1125               }
1126
1127               public void windowClosing(WindowEvent e)
1128               {
1129                 thr.interrupt();
1130
1131               }
1132
1133               public void windowDeactivated(WindowEvent e)
1134               {
1135                 // TODO Auto-generated method stub
1136
1137               }
1138
1139               public void windowDeiconified(WindowEvent e)
1140               {
1141                 // TODO Auto-generated method stub
1142
1143               }
1144
1145               public void windowIconified(WindowEvent e)
1146               {
1147                 // TODO Auto-generated method stub
1148
1149               }
1150
1151               public void windowOpened(WindowEvent e)
1152               {
1153                 // TODO Auto-generated method stub
1154
1155               }
1156
1157             });
1158             jf.setVisible(true);
1159             boolean inter = false;
1160             while (!inter)
1161             {
1162               try
1163               {
1164                 Thread.sleep(10000);
1165               } catch (Exception e)
1166               {
1167                 inter = true;
1168               }
1169               ;
1170             }
1171             jf.dispose();
1172           }
1173         }
1174       }
1175     }
1176   }
1177
1178   public boolean isServiceDefaults()
1179   {
1180     return (!isModified() && (lastParmSet != null && lastParmSet
1181             .equals(SVC_DEF)));
1182   }
1183
1184   public List<ArgumentI> getJobParams()
1185   {
1186     return opanp.getCurrentSettings();
1187   }
1188
1189   String lastParmSet = null;
1190
1191   /*
1192    * Hashtable<String, Object[]> editedParams = new Hashtable<String,
1193    * Object[]>();
1194    * 
1195    * store the given parameters in the user parameter set database.
1196    * 
1197    * @param storeSetName - lastParmSet
1198    * 
1199    * @param descr - setDescr.getText()
1200    * 
1201    * @param jobParams - getJobParams()
1202    * 
1203    * private void _storeUserPreset(String storeSetName, String descr,
1204    * List<ArgumentI> jobParams) { // this is a simple hash store. Object[] pset;
1205    * editedParams.put(storeSetName, pset = new Object[3]); pset[0] =
1206    * storeSetName; pset[1] = descr; pset[2] = jobParams; // writeParam("Saving "
1207    * + storeSetName + ": ", jobParams); }
1208    * 
1209    * private void writeParam(String nm, List<ArgumentI> params) { for (ArgumentI
1210    * p : params) { System.out.println(nm + ":" + System.identityHashCode(p) +
1211    * " Name: " + p.getName() + " Value: " + p.getDefaultValue()); } }
1212    * 
1213    * private Object[] _getUserPreset(String setName) { Object[] pset =
1214    * editedParams.get(setName); // if (pset != null) // writeParam("Retrieving "
1215    * + setName + ": ", (List<Argument>) pset[2]); return pset; }
1216    * 
1217    * * remove the given user preset from the preset stash
1218    * 
1219    * @param setName
1220    * 
1221    * private void _deleteUserPreset(String setName) {
1222    * editedParams.remove(setName); }
1223    */
1224
1225   private void syncSetNamesWithStore()
1226   {
1227     int n = 0;
1228     // remove any set names in the drop down menu that aren't either a reserved
1229     // setting, or a user defined or service preset.
1230     Vector items = new Vector();
1231     while (n < setName.getItemCount())
1232     {
1233       String item = (String) setName.getItemAt(n);
1234       if (!item.equals(SVC_DEF) && !paramStore.presetExists(item))
1235       {
1236         setName.removeItemAt(n);
1237       }
1238       else
1239       {
1240         items.addElement(item);
1241         n++;
1242       }
1243     }
1244     if (!items.contains(SVC_DEF))
1245     {
1246       setName.addItem(SVC_DEF);
1247     }
1248     for (WsParamSetI upn : paramStore.getPresets())
1249     {
1250       if (!items.contains(upn.getName()))
1251       {
1252         setName.addItem(upn.getName());
1253       }
1254     }
1255   }
1256
1257   /**
1258    * true if lastParmSet is a user preset
1259    */
1260   boolean isUserPreset = false;
1261
1262   private void reInitDialog(String nextPreset)
1263   {
1264     settingDialog = true;
1265     // updateTable(null,null); // first reset to defaults
1266     WsParamSetI pset = null;
1267     if (nextPreset != null && nextPreset.length() > 0)
1268     {
1269       pset = paramStore.getPreset(nextPreset);
1270     }
1271     if (pset != null)
1272     {
1273       if (pset.isModifiable())
1274       {
1275         isUserPreset = true;
1276         setDescr.setText(pset.getDescription());
1277         updateTable(null, pset.getArguments());
1278         lastParmSet = nextPreset;
1279       }
1280       else
1281       {
1282         isUserPreset = false;
1283         setDescr.setText("");
1284         // must be a default preset from service
1285         updateTable(pset, null);
1286         lastParmSet = nextPreset;
1287       }
1288     }
1289     else
1290     {
1291       isUserPreset = false;
1292       // Service defaults
1293       setDescr.setText("");
1294       updateTable(null, null);
1295       lastParmSet = SVC_DEF;
1296     }
1297
1298     initArgSetModified();
1299     syncSetNamesWithStore();
1300     setName.setSelectedItem(lastParmSet);
1301     SetNamePanel.validate();
1302     validate();
1303     settingDialog = false;
1304   }
1305
1306   /**
1307    * Rebuild the AlignFrame web service menus (after add/delete of a preset
1308    * option).
1309    */
1310   protected void updateWebServiceMenus()
1311   {
1312     for (AlignFrame alignFrame : Desktop.getAlignFrames())
1313     {
1314       alignFrame.BuildWebServiceMenu();
1315     }
1316   }
1317
1318   String curSetName = null;
1319
1320   public void itemStateChanged(ItemEvent e)
1321   {
1322     if (e.getSource() == setName && e.getStateChange() == e.SELECTED)
1323     {
1324       final String setname = (String) setName.getSelectedItem();
1325       System.out.println("Item state changed for " + setname
1326               + " (handling ? " + !settingDialog + ")");
1327       if (settingDialog)
1328       {
1329         // ignore event
1330         return;
1331       }
1332       if (setname == null)
1333       {
1334         return;
1335       }
1336       javax.swing.SwingUtilities.invokeLater(new Runnable()
1337       {
1338         public void run()
1339         {
1340           doPreferenceComboStateChange(setname);
1341         }
1342       });
1343     }
1344   }
1345
1346   private void doPreferenceComboStateChange(String setname)
1347   {
1348     // user has selected a different item from combo-box
1349     if (isModified())
1350     {
1351       String lsetname = (curSetName != null) ? curSetName : lastParmSet;
1352       if (lsetname.equals(setname))
1353       {
1354         // setname was just edited - so ignore this event.
1355         return;
1356       }
1357       settingDialog = true;
1358       System.out.println("Prompting to save " + lsetname);
1359       if (javax.swing.JOptionPane
1360               .showConfirmDialog(
1361                       this,
1362                       "Parameter set '"
1363                               + lsetname
1364                               + "' is modifed, and your changes will be lost.\nReally change preset ?",
1365                       "Warning: Unsaved Changes",
1366                       javax.swing.JOptionPane.OK_CANCEL_OPTION) != JOptionPane.OK_OPTION)
1367       {
1368         // revert the combobox to the current item
1369         settingDialog = true;
1370         setName.setSelectedItem(lsetname);
1371         settingDialog = false;
1372         // and leave.
1373         return;
1374         // System.out.println("Saving for " + lsetname);
1375         // _storeCurrentPreset(lsetname);
1376
1377       }
1378     }
1379     settingDialog = true;
1380     reInitDialog(setname);
1381     settingDialog = false;
1382
1383   }
1384
1385   private void _renameExistingPreset(String oldName, String curSetName2)
1386   {
1387     paramStore.updatePreset(oldName, curSetName2, setDescr.getText(),
1388             getJobParams());
1389   }
1390
1391   /**
1392    * store current settings as given name. You should then reset gui.
1393    * 
1394    * @param curSetName2
1395    */
1396   private void _storeCurrentPreset(String curSetName2)
1397   {
1398     paramStore.storePreset(curSetName2, setDescr.getText(), getJobParams());
1399   }
1400
1401   private void _updatePreset(String lastParmSet2, String curname)
1402   {
1403     paramStore.updatePreset(lastParmSet2, curname, setDescr.getText(),
1404             getJobParams());
1405
1406   }
1407
1408   /**
1409    * last saved name for this user preset
1410    */
1411   String lastSetName = null;
1412
1413   /**
1414    * last saved value of the description text for this user preset
1415    */
1416   String lastDescrText = null;
1417
1418   public void actionPerformed(ActionEvent e)
1419   {
1420     if (e.getSource() instanceof Component)
1421     {
1422       Component src = (Component) e.getSource();
1423       if (src.getParent() == setName)
1424       {
1425         // rename any existing records we know about for this set.
1426         String newname = e.getActionCommand().trim();
1427         String msg = null;
1428         if (isServicePreset(newname))
1429         {
1430           final String oldname = curSetName != null ? curSetName
1431                   : lastParmSet;
1432           final Component ourframe = this;
1433           settingDialog = true;
1434           setName.getEditor().setItem(oldname);
1435           settingDialog = false;
1436           javax.swing.SwingUtilities.invokeLater(new Runnable()
1437           {
1438             public void run()
1439             {
1440               JOptionPane.showMessageDialog(ourframe, MessageManager
1441                       .getString("label.invalid_name_preset_exists"),
1442                       MessageManager.getString("label.invalid_name"),
1443                       JOptionPane.WARNING_MESSAGE);
1444             }
1445           });
1446
1447           return;
1448         }
1449         curSetName = newname;
1450         System.err.println("New name for user setting " + curSetName
1451                 + " (was " + setName.getSelectedItem() + ")");
1452         if (curSetName.equals(setName.getSelectedItem()))
1453         {
1454           curSetName = null;
1455         }
1456         if (curSetName != null)
1457         {
1458           argSetModified(setName, true);
1459           return;
1460         }
1461
1462       }
1463     }
1464   }
1465
1466   private void checkDescrModified()
1467   {
1468     if (!settingDialog)
1469     {
1470
1471       argSetModified(
1472               setDescr,
1473               (lastDescrText == null ? setDescr.getText().trim().length() > 0
1474                       : !setDescr.getText().equals(lastDescrText)));
1475
1476     }
1477   }
1478
1479   public void insertUpdate(DocumentEvent e)
1480   {
1481     checkDescrModified();
1482   }
1483
1484   public void removeUpdate(DocumentEvent e)
1485   {
1486     checkDescrModified();
1487   }
1488
1489   public void changedUpdate(DocumentEvent e)
1490   {
1491     checkDescrModified();
1492   }
1493
1494   /**
1495    * 
1496    * @return null or the service preset selected by the user
1497    */
1498   public WsParamSetI getPreset()
1499   {
1500     if (isUserPreset || isModified()
1501             || (lastParmSet != null && lastParmSet.equals(SVC_DEF)))
1502     {
1503       return null;
1504     }
1505     else
1506     {
1507       return paramStore.getPreset(lastParmSet);
1508     }
1509   }
1510 }