3 import java.awt.BorderLayout;
5 import java.awt.Component;
6 import java.awt.Dimension;
7 import java.awt.FlowLayout;
9 import java.awt.GridLayout;
10 import java.awt.Rectangle;
11 import java.awt.event.ActionEvent;
12 import java.awt.event.ActionListener;
13 import java.awt.event.ComponentEvent;
14 import java.awt.event.ComponentListener;
15 import java.awt.event.ContainerEvent;
16 import java.awt.event.ContainerListener;
17 import java.awt.event.ItemEvent;
18 import java.awt.event.ItemListener;
19 import java.awt.event.KeyEvent;
20 import java.awt.event.KeyListener;
21 import java.awt.event.MouseEvent;
22 import java.awt.event.MouseListener;
23 import java.awt.event.WindowEvent;
24 import java.awt.event.WindowListener;
25 import java.awt.event.WindowStateListener;
27 import java.util.ArrayList;
28 import java.util.EventObject;
29 import java.util.HashSet;
30 import java.util.Hashtable;
31 import java.util.Iterator;
32 import java.util.List;
34 import java.util.Vector;
36 import javax.swing.JButton;
37 import javax.swing.JCheckBox;
38 import javax.swing.JComboBox;
39 import javax.swing.JComponent;
40 import javax.swing.JDialog;
41 import javax.swing.JFrame;
42 import javax.swing.JLabel;
43 import javax.swing.JList;
44 import javax.swing.JMenuItem;
45 import javax.swing.JOptionPane;
46 import javax.swing.JPanel;
47 import javax.swing.JPopupMenu;
48 import javax.swing.JScrollPane;
49 import javax.swing.JSlider;
50 import javax.swing.JSplitPane;
51 import javax.swing.JTable;
52 import javax.swing.JTextArea;
53 import javax.swing.JTextField;
54 import javax.swing.ListSelectionModel;
55 import javax.swing.SwingConstants;
56 import javax.swing.SwingUtilities;
57 import javax.swing.border.TitledBorder;
58 import javax.swing.event.CellEditorListener;
59 import javax.swing.event.ChangeEvent;
60 import javax.swing.event.ChangeListener;
61 import javax.swing.event.DocumentEvent;
62 import javax.swing.event.DocumentListener;
63 import javax.swing.table.*;
65 import compbio.metadata.Argument;
66 import compbio.metadata.Option;
67 import compbio.metadata.Parameter;
68 import compbio.metadata.Preset;
69 import compbio.metadata.PresetManager;
70 import compbio.metadata.RunnerConfig;
71 import compbio.metadata.ValueConstrain;
72 import compbio.metadata.WrongParameterException;
73 import compbio.metadata.ValueConstrain.Type;
75 import jalview.util.jarInputStreamProvider;
76 import jalview.ws.jws2.JabaParamStore;
77 import jalview.ws.jws2.JabaPreset;
78 import jalview.ws.jws2.Jws2Discoverer;
79 import jalview.ws.jws2.ParameterUtils;
80 import jalview.ws.jws2.Jws2Discoverer.Jws2Instance;
81 import jalview.ws.jws2.dm.JabaOption;
82 import jalview.ws.jws2.dm.JabaParameter;
83 import jalview.ws.params.ArgumentI;
84 import jalview.ws.params.OptionI;
85 import jalview.ws.params.ParamDatastoreI;
86 import jalview.ws.params.ParameterI;
87 import jalview.ws.params.ValueConstrainI;
88 import jalview.ws.params.WsParamSetI;
91 * job parameter editing/browsing dialog box. User can browse existing settings
92 * (user + presets + Defaults), and any changes to parameters creates a modified
93 * user parameter set. LOGIC: If the parameter set is modified, and its name is
94 * a valid, non-existant user parameter set, then a save button is shown. If the
95 * parameter set is modified and its name is a valid, extant user parameter set,
96 * then an update button is shown. If user parameter set's name is edited, and
97 * old name exists as a writable user parameter set, then rename button is
98 * shown. If current parameter set is associated with a user defined parameter
99 * set, then : if set is modifed, a 'revert' button is shown. if set is not
100 * modified, a 'delete' button is shown.
105 public class WsJobParameters extends JPanel implements ItemListener,
106 ActionListener, DocumentListener
108 private static final String SVC_DEF = "Defaults"; // this is the null
109 // parameter set as shown to
112 private static final int PARAM_WIDTH = 340, PARAM_HEIGHT = 150,
113 PARAM_CLOSEDHEIGHT = 80;
115 private static final int OPTSET_HEIGHT = 30;
117 JPanel SetNamePanel = new JPanel();
119 JPanel setDetails = new JPanel();
121 JSplitPane settingsPanel = new JSplitPane();
123 JSplitPane jobPanel = new JSplitPane();
125 JPanel jobOptions = new JPanel();
127 JScrollPane jobOptionsPane = new JScrollPane();
129 JPanel jobParameters = new JPanel();
131 JButton createpref = new JButton();
133 JButton deletepref = new JButton();
135 JButton revertpref = new JButton();
137 JButton updatepref = new JButton();
139 JButton startjob = new JButton();
141 JButton canceljob = new JButton();
143 JComboBox setName = new JComboBox();
145 JTextArea setDescr = new JTextArea();
147 JScrollPane paramPane = new JScrollPane();
149 JPanel paramList = new JPanel();
151 RunnerConfig serviceOptions;
153 ParamDatastoreI paramStore;
155 WsJobParameters(Jws2Instance service)
160 public WsJobParameters(Jws2Instance service, WsParamSetI preset)
162 this(null, service, preset, null);
168 * - if null, create new JFrame outside of desktop
172 public WsJobParameters(JFrame parent, Jws2Instance service, WsParamSetI preset,
173 List<Argument> jobArgset)
175 this(parent, null, service, preset, jobArgset);
186 public WsJobParameters(JFrame parent, ParamDatastoreI paramStorei,
187 Jws2Instance service, WsParamSetI preset, List<Argument> jobArgset)
191 this.paramStore = paramStorei;
192 if (paramStore == null)
194 paramStore = service.getParamStore();
196 this.service = service;
197 // argSetModified(false);
198 // populate parameter table
199 initForService(service, preset, jobArgset);
200 // display in new JFrame attached to parent.
206 JDialog frame = null;
209 * shows a modal dialog containing the parameters.
213 public boolean showRunDialog()
216 frame = new JDialog(Desktop.instance, true);
218 frame.setTitle("Edit parameters for " + service.getActionText());
219 Rectangle deskr = Desktop.instance.getBounds();
220 frame.setBounds(new Rectangle((int) (deskr.getCenterX() - 240),
221 (int) (deskr.getCenterY() - 250), 480, 500));
222 frame.setContentPane(this);
223 // should recover defaults from user prefs.
225 settingsPanel.setDividerLocation(0.4);
226 jobPanel.setDividerLocation(0.3);
227 frame.setVisible(true);
236 protected JButton makeButton(String label, String tooltip,
237 ActionListener action)
239 JButton button = new JButton();
240 button.setText(label);
241 button.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
242 button.setForeground(Color.black);
243 button.setHorizontalAlignment(SwingConstants.CENTER);
244 button.setToolTipText(tooltip);
245 button.addActionListener(action);
249 private void jbInit()
251 updatepref = makeButton("Update", "Update the stored user preference",
255 public void actionPerformed(ActionEvent e)
257 update_actionPerformed(e);
260 deletepref = makeButton("Delete", "Delete the user preference",
264 public void actionPerformed(ActionEvent e)
266 delete_actionPerformed(e);
269 createpref = makeButton("Create", "Create a new preference",
273 public void actionPerformed(ActionEvent e)
275 create_actionPerformed(e);
278 revertpref = makeButton("Revert",
279 "Undo all changes to the current set", new ActionListener()
282 public void actionPerformed(ActionEvent e)
284 revert_actionPerformed(e);
287 startjob.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
288 startjob.setText("Start");
289 startjob.setToolTipText("Start Job");
290 startjob.addActionListener(new ActionListener()
292 public void actionPerformed(ActionEvent e)
294 startjob_actionPerformed(e);
297 canceljob.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
298 canceljob.setText("Cancel");
299 canceljob.setToolTipText("Cancel Job");
300 canceljob.addActionListener(new ActionListener()
302 public void actionPerformed(ActionEvent e)
304 canceljob_actionPerformed(e);
308 setDetails.setBorder(new TitledBorder("Details"));
309 setDetails.setLayout(new BorderLayout());
310 setDescr.setColumns(40);
311 setDescr.setWrapStyleWord(true);
312 setDescr.setLineWrap(true);
313 setDescr.setBackground(getBackground());
314 setDescr.setEditable(true);
315 setDescr.getDocument().addDocumentListener(this);
316 JScrollPane setDescrView = new JScrollPane();
317 // setDescrView.setPreferredSize(new Dimension(350, 200));
318 setDescrView.getViewport().setView(setDescr);
319 setName.setEditable(true);
320 setName.addItemListener(this);
321 setName.getEditor().addActionListener(this);
322 JPanel setNameInfo = new JPanel(new FlowLayout(FlowLayout.LEFT));
323 SetNamePanel.setLayout(new GridLayout(2, 1));
324 SetNamePanel.setMinimumSize(new Dimension(300, 40));
325 JLabel setNameLabel = new JLabel("Parameter set: ");
326 setNameLabel.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10));
327 // setNameLabel.setHorizontalAlignment(FlowLayout.LEFT);
328 setNameInfo.add(setNameLabel);
329 setNameInfo.add(setName);
330 // initial button visibility
331 updatepref.setVisible(false);
332 deletepref.setVisible(false);
333 revertpref.setVisible(false);
334 createpref.setVisible(false);
335 JPanel setsavebuts = new JPanel();
336 setsavebuts.setLayout(new FlowLayout(FlowLayout.LEFT)); // GridLayout(1,2));
337 ((FlowLayout) setsavebuts.getLayout()).setHgap(10);
338 ((FlowLayout) setsavebuts.getLayout()).setVgap(0);
339 setsavebuts.add(deletepref);
340 setsavebuts.add(revertpref);
341 setsavebuts.add(createpref);
342 setsavebuts.add(updatepref);
343 setsavebuts.setSize(new Dimension(150, 20));
344 JPanel buttonArea = new JPanel(new GridLayout(1, 1));
345 buttonArea.add(setsavebuts);
346 SetNamePanel.add(setNameInfo);
347 SetNamePanel.add(buttonArea);
348 setDetails.add(setDescrView, BorderLayout.CENTER);
349 // setDetails.setPreferredSize(new Dimension(360, 100));
350 jobParameters.setBorder(new TitledBorder("Parameters"));
351 jobParameters.setLayout(new BorderLayout());
352 paramPane.setPreferredSize(new Dimension(360, 300));
353 paramPane.getVerticalScrollBar().setUnitIncrement(20);
354 // paramPanel.setPreferredSize(new Dimension(360, 300));
355 // TODO: relayout buttons nicely
356 paramPane.getViewport().setView(paramList);
357 jobParameters.add(paramPane, BorderLayout.CENTER);
358 JPanel jobOptionsPanel = new JPanel();
359 jobOptionsPanel.setLayout(new BorderLayout());
360 jobOptionsPanel.setBorder(new TitledBorder("Options"));
361 jobOptionsPane.getViewport().setView(jobOptions);
362 jobOptionsPanel.add(jobOptionsPane, BorderLayout.CENTER);
363 settingsPanel.setLeftComponent(jobOptionsPanel);
364 settingsPanel.setRightComponent(jobParameters);
365 settingsPanel.setOrientation(JSplitPane.VERTICAL_SPLIT);
367 setLayout(new BorderLayout());
368 // setPreferredSize(new Dimension(400, 600));
369 // setSize(new Dimension(400, 600));
370 jobPanel.setLeftComponent(setDetails);
371 jobPanel.setRightComponent(settingsPanel);
372 jobPanel.setOrientation(JSplitPane.VERTICAL_SPLIT);
373 add(SetNamePanel, BorderLayout.NORTH);
374 add(jobPanel, BorderLayout.CENTER);
375 JPanel dialogpanel = new JPanel();
376 dialogpanel.add(startjob);
377 dialogpanel.add(canceljob);
378 add(dialogpanel, BorderLayout.SOUTH);
381 protected void revert_actionPerformed(ActionEvent e)
383 reInitDialog(lastParmSet);
387 protected void update_actionPerformed(ActionEvent e)
391 String curname = ((String) setName.getSelectedItem()).trim();
392 if (curname.length() > 0 && !curname.equals(lastParmSet))
394 _deleteUserPreset(lastParmSet);
396 _storeCurrentPreset(curname);
397 lastParmSet = curname;
399 initArgSetModified();
400 syncSetNamesWithStore();
404 private void _deleteUserPreset(String lastParmSet2)
406 paramStore.deletePreset(lastParmSet2);
409 protected void delete_actionPerformed(ActionEvent e)
413 // delete current preset's saved entry
414 _deleteUserPreset(lastParmSet);
416 reInitDialog(null); // service default
419 protected void create_actionPerformed(ActionEvent e)
421 String curname = ((String) setName.getSelectedItem()).trim();
422 if (curname.length() > 0)
424 _storeCurrentPreset(curname);
425 lastParmSet = curname;
427 initArgSetModified();
431 // TODO: show warning
432 System.err.println("Invalid name. Not saved.");
436 protected void canceljob_actionPerformed(ActionEvent e)
441 frame.setVisible(false);
445 protected void startjob_actionPerformed(ActionEvent e)
450 frame.setVisible(false);
454 Jws2Instance service;
457 * list of service presets in the gui
459 Hashtable servicePresets = null;
462 * set if dialog is being set - so handlers will avoid spurious events
464 boolean settingDialog = false;
466 void initForService(Jws2Instance service, WsParamSetI jabap,
467 List<Argument> jabajobArgset)
469 WsParamSetI p = null;
470 List<ArgumentI> jobArgset = null;
471 settingDialog = true;
472 { // instantiate the abstract proxy for Jaba objects
473 jobArgset = jabajobArgset == null ? null : JabaParamStore
474 .getJwsArgsfromJaba(jabajobArgset);
475 p = jabap; // (jabap != null) ? paramStore.getPreset(jabap.getName()) : null;
477 // TODO: Recover window geometry prefs for this service
478 // jobPanel.setDividerLocation(proportionalLocation)
479 // settingsPanel.setDividerLocation(proportionalLocation)
480 Hashtable exnames = new Hashtable();
481 for (int i = 0, iSize = setName.getItemCount(); i < iSize; i++)
483 exnames.put((String) setName.getItemAt(i), setName.getItemAt(i));
485 servicePresets = new Hashtable();
486 // Add the default entry - if not present already.
487 if (!exnames.contains(SVC_DEF))
489 setName.addItem(SVC_DEF);
490 exnames.put(SVC_DEF, SVC_DEF);
491 servicePresets.put(SVC_DEF, SVC_DEF);
493 String curname = (p == null ? "" : p.getName());
494 for (WsParamSetI pr : paramStore.getPresets())
496 if (!pr.isModifiable())
498 servicePresets.put(pr.getName(), "preset");
503 if (!exnames.contains(pr.getName()))
505 setName.addItem(pr.getName());
508 // TODO: if initial jobArgset matches a given user setting or preset then
509 // should recover setting accordingly
510 // updateTable(p, jobArgset);
513 reInitDialog(p.getName());
514 initArgSetModified();
518 if (jobArgset != null && jobArgset.size() > 0)
520 curSetName = "Supplied Settings";
521 updateTable(p, jobArgset);
529 settingDialog = false;
533 @SuppressWarnings("unchecked")
534 private void updateTable(WsParamSetI p, List<ArgumentI> jobArgset)
536 // populate table from default parameter set.
537 List<ArgumentI> args = paramStore.getServiceParameters();
539 // split to params and required arguments
541 for (ArgumentI myarg : args)
543 // Ideally, Argument would implement isRequired !
544 if (myarg instanceof ParameterI)
546 ParameterI parm = (ParameterI) myarg;
551 if (myarg instanceof OptionI)
553 OptionI opt = (OptionI) myarg;
554 addOption(opt).resetToDefault();
558 System.err.println("Ignoring unknown service argument type "
559 + myarg.getClass().getName());
563 args = null; // no more args to process.
567 isUserPreset = false;
568 // initialise setname
569 setName.setSelectedItem(lastSetName = p.getName());
570 setDescr.setText(lastDescrText = p.getDescription());
574 args = p.getArguments();
575 } catch (Exception e)
579 // TODO: check if args should be unselected prior to resetting using the
584 if (lastParmSet == null)
586 isUserPreset = false;
587 // first call - so create a dummy name
589 setName.setSelectedItem(lastSetName = SVC_DEF);
593 if (jobArgset != null)
595 argSetModified(jobArgset, true);
598 // get setargs from current object
601 for (ArgumentI arg : args)
603 if (arg instanceof ParameterI)
605 setParameter((ParameterI) arg);
609 if (arg instanceof OptionI)
611 // System.out.println("Setting option "
612 // + System.identityHashCode(arg) + ":" + arg.getName()
613 // + " with " + arg.getDefaultValue());
614 selectOption((OptionI) arg, arg.getDefaultValue());
621 jobOptions.setPreferredSize(new Dimension(PARAM_WIDTH, optSet.size()
623 jobOptions.setLayout(new GridLayout(optSet.size(), 1));
624 refreshParamLayout();
625 paramPane.validate();
629 private boolean isModified()
631 return modifiedElements.size() > 0;
634 private Hashtable modifiedElements = new Hashtable();
637 * reset gui and modification state settings
639 private void initArgSetModified()
642 modifiedElements.clear();
643 updateButtonDisplay();
646 private void updateButtonDisplay()
648 boolean _update = false, _create = false, _delete = false, _revert = false;
649 if (modifiedElements.size() > 0)
653 _update = isUserPreset; // can only update user presets
654 if (!isUserPreset || modifiedElements.containsKey(setName))
656 // name modified - can create new preset
664 // can still delete a user preset
665 _delete = isUserPreset;
667 createpref.setVisible(_create);
668 updatepref.setVisible(_update);
669 deletepref.setVisible(_delete);
670 revertpref.setVisible(_revert);
674 private void argSetModified(Object modifiedElement, boolean b)
682 modifiedElements.remove(modifiedElement);
686 if (b && modifiedElement == setName
687 && modifiedElements.contains(modifiedElement))
689 // HACK! prevents iteration on makeSetNameValid
692 modifiedElements.put(modifiedElement, modifiedElement);
694 // set mod status based on presence of elements in table
695 if (b && modifiedElements.size() > 0)
697 makeSetNameValid(!isUserPreset);
698 SetNamePanel.revalidate();
700 updateButtonDisplay();
703 private boolean isServicePreset(String selectedItem)
705 return selectedItem.equals(SVC_DEF)
706 || servicePresets.containsKey(selectedItem);
710 * check if the current set name is a valid set name for saving, if not, then
713 private void makeSetNameValid(boolean newuserset)
715 boolean stn = settingDialog;
716 boolean renamed = false;
717 settingDialog = true;
718 String nm = (String) setName.getSelectedItem();
719 // check if the name is reserved - if it is, rename it.
720 if (isServicePreset(nm))
729 while (paramStore.getPreset(tnm) != null)
731 tnm = nm + " (" + (++i) + ")";
740 boolean makeupdate = false;
741 // sync the gui with the preset database
742 for (int i = 0, iS = setName.getItemCount(); i < iS; i++)
744 String snm = (String) setName.getItemAt(i);
748 // setName.setSelectedIndex(i);
753 setName.addItem(curSetName = nm);
754 setName.setSelectedItem(curSetName);
758 settingDialog = false; // we need this name change to be registered.
759 argSetModified(setName, renamed);
764 private void addParameter(ParameterI arg)
766 ParamBox pb = paramSet.get(arg.getName());
769 pb = new ParamBox(this, arg);
770 paramSet.put(arg.getName(), pb);
774 // take the defaults from the parameter
775 pb.updateControls(arg);
778 private void setParameter(ParameterI arg)
780 ParamBox pb = paramSet.get(arg.getName());
787 pb.updateControls(arg);
792 private void selectOption(OptionI option, String string)
794 OptionBox cb = optSet.get(option.getName());
797 cb = addOption(option);
799 cb.enabled.setSelected(string != null); // initial state for an option.
802 if (option.getPossibleValues().contains(string))
804 cb.val.setSelectedItem(string);
808 throw new Error("Invalid value " + string + " for option " + option);
812 if (option.isRequired() && !cb.enabled.isSelected())
814 // TODO: indicate paramset is not valid.. option needs to be selected!
816 cb.setInitialValue();
819 Map<String, ParamBox> paramSet = new Hashtable<String, ParamBox>();
821 public class ParamBox extends JPanel implements ChangeListener,
822 ActionListener, MouseListener
824 JButton showDesc = new JButton();
826 JTextArea string = new JTextArea();
828 JScrollPane descPanel = new JScrollPane();
830 JSlider slider = null;
832 JTextField valueField = null;
834 ValueConstrainI validator = null;
836 JPanel settingPanel = new JPanel();
838 JPanel controlPanel = new JPanel();
840 boolean integ = false;
842 boolean choice = false;
844 boolean descisvisible = false;
846 final WsJobParameters pmdialogbox;
850 public ParamBox(final WsJobParameters pmlayout, ParameterI parm)
852 pmdialogbox = pmlayout;
853 setPreferredSize(new Dimension(PARAM_WIDTH, PARAM_CLOSEDHEIGHT));
854 setBorder(new TitledBorder(parm.getName()));
856 showDesc.setFont(new Font("Verdana", Font.PLAIN, 6));
857 showDesc.setText("+");
858 string.setFont(new Font("Verdana", Font.PLAIN, 11));
859 string.setBackground(getBackground());
860 // string.setSize(new Dimension(PARAM_WIDTH, 80));
861 string.setEditable(false);
862 descPanel.getViewport().setView(string);
863 // descPanel.setLocation(2,17);
864 descPanel.setVisible(false);
865 // string.setMinimumSize(new Dimension(140,80));
866 // string.setMaximumSize(new Dimension(280,80));
867 final ParamBox me = this;
868 finfo = parm.getFurtherDetails();
871 showDesc.setToolTipText("<html><p>Click to show brief description, and right click to open link for further information.</p></html>");
872 showDesc.addMouseListener(this);
876 showDesc.setToolTipText("<html><p>Click to show brief description.</p></html>");
878 showDesc.addActionListener(new ActionListener()
881 public void actionPerformed(ActionEvent e)
883 descisvisible = !descisvisible;
884 descPanel.setVisible(descisvisible);
885 me.setPreferredSize(new Dimension(PARAM_WIDTH,
886 (descisvisible) ? PARAM_HEIGHT : PARAM_CLOSEDHEIGHT));
888 pmlayout.refreshParamLayout();
891 string.setWrapStyleWord(true);
892 string.setLineWrap(true);
893 string.setColumns(32);
894 string.setText(parm.getDescription());
895 JPanel firstrow = new JPanel();
896 firstrow.setLayout(null);
897 controlPanel.setLayout(new BorderLayout());
898 controlPanel.setBounds(new Rectangle(39, 10, PARAM_WIDTH - 70,
899 PARAM_CLOSEDHEIGHT - 50));
900 showDesc.setBounds(new Rectangle(10, 10, 16, 16));
901 firstrow.add(showDesc);
902 firstrow.add(controlPanel);
903 firstrow.setBounds(new Rectangle(10, 20, PARAM_WIDTH - 30,
904 PARAM_CLOSEDHEIGHT - 30));
906 validator = parm.getValidValue();
908 if (validator != null)
910 integ = validator.getType() == Type.Integer;
914 if (parameter.getPossibleValues() != null)
919 updateControls(parm);
920 descPanel.setBounds(new Rectangle(10, PARAM_CLOSEDHEIGHT,
921 PARAM_WIDTH - 20, PARAM_HEIGHT - PARAM_CLOSEDHEIGHT - 5));
928 // reset the widget's initial value.
932 boolean adjusting = false;
934 ParameterI parameter;
938 public int getBoxHeight()
940 return (descisvisible ? PARAM_HEIGHT : PARAM_CLOSEDHEIGHT);
943 public void updateControls(ParameterI parm)
946 boolean init = (choicebox == null && valueField == null);
953 choicebox = new JComboBox();
954 choicebox.addActionListener(this);
955 controlPanel.add(choicebox, BorderLayout.CENTER);
959 slider = new JSlider();
960 slider.addChangeListener(this);
961 valueField = new JTextField();
962 valueField.addActionListener(this);
963 valueField.setPreferredSize(new Dimension(60, 25));
964 controlPanel.add(slider, BorderLayout.WEST);
965 controlPanel.add(valueField, BorderLayout.EAST);
976 List vals = parm.getPossibleValues();
977 for (Object val : vals)
979 choicebox.addItem(val);
983 if (parm.getDefaultValue() != null)
985 choicebox.setSelectedItem(parm.getDefaultValue());
990 valueField.setText(parm.getDefaultValue());
993 lastVal = updateSliderFromValueField();
999 public ParameterI getParameter()
1001 ParameterI prm = parameter.copy();
1004 prm.setDefaultValue((String) choicebox.getSelectedItem());
1008 prm.setDefaultValue(valueField.getText());
1013 public Object updateSliderFromValueField()
1017 if (validator != null)
1024 valueField.setText(valueField.getText().trim());
1025 iVal = Integer.valueOf(valueField.getText());
1026 if (validator.getMin()!=null && validator.getMin().intValue()>iVal)
1028 iVal = validator.getMin().intValue();
1029 // TODO: provide visual indication that hard limit was reached for this parameter
1031 if (validator.getMax()!=null && validator.getMax().intValue()<iVal)
1033 iVal = validator.getMax().intValue();
1034 // TODO: provide visual indication that hard limit was reached for this parameter
1036 } catch (Exception e)
1040 if (validator.getMin() != null && validator.getMax() != null)
1042 slider.getModel().setRangeProperties(iVal, 1,
1043 validator.getMin().intValue(),
1044 validator.getMax().intValue(), true);
1048 slider.setVisible(false);
1058 fVal = Float.valueOf(valueField.getText());
1059 if (validator.getMin()!=null && validator.getMin().floatValue()>fVal)
1061 fVal = validator.getMin().floatValue();
1062 // TODO: provide visual indication that hard limit was reached for this parameter
1064 if (validator.getMax()!=null && validator.getMax().floatValue()<fVal)
1066 fVal = validator.getMax().floatValue();
1067 // TODO: provide visual indication that hard limit was reached for this parameter
1069 } catch (Exception e)
1073 if (validator.getMin() != null && validator.getMax() != null)
1075 slider.getModel().setRangeProperties((int) fVal * 1000, 1,
1076 (int) validator.getMin().floatValue() * 1000,
1077 (int) validator.getMax().floatValue() * 1000, true);
1081 slider.setVisible(false);
1091 slider.setVisible(false);
1093 { valueField.getText().trim() };
1098 { (String) choicebox.getSelectedItem() };
1104 public void stateChanged(ChangeEvent e)
1108 valueField.setText(""
1109 + ((integ) ? ("" + (int) slider.getValue())
1110 : ("" + (float) (slider.getValue() / 1000f))));
1116 public void actionPerformed(ActionEvent e)
1124 updateSliderFromValueField();
1129 private void checkIfModified()
1131 Object cstate = updateSliderFromValueField();
1132 boolean notmod = false;
1133 if (cstate.getClass() == lastVal.getClass())
1135 if (cstate instanceof int[])
1137 notmod = (((int[]) cstate)[0] == ((int[]) lastVal)[0]);
1139 else if (cstate instanceof float[])
1141 notmod = (((float[]) cstate)[0] == ((float[]) lastVal)[0]);
1143 else if (cstate instanceof String[])
1145 notmod = (((String[]) cstate)[0].equals(((String[]) lastVal)[0]));
1148 pmdialogbox.argSetModified(this, !notmod);
1151 public void mouseClicked(MouseEvent e)
1153 if (javax.swing.SwingUtilities.isRightMouseButton(e))
1155 Desktop.showUrl(finfo.toString());
1159 public void mousePressed(MouseEvent e)
1161 // TODO Auto-generated method stub
1165 public void mouseReleased(MouseEvent e)
1167 // TODO Auto-generated method stub
1171 public void mouseEntered(MouseEvent e)
1173 // TODO Auto-generated method stub
1177 public void mouseExited(MouseEvent e)
1179 // TODO Auto-generated method stub
1185 Map<String, OptionBox> optSet = new Hashtable<String, OptionBox>();
1187 public class OptionBox extends JPanel implements MouseListener,
1190 JComboBox val = new JComboBox();
1192 JCheckBox enabled = new JCheckBox();
1194 JLabel optlabel = new JLabel();
1196 URL linkImageURL = getClass().getResource("/images/link.gif");
1200 boolean hasLink = false;
1204 public OptionBox(OptionI opt)
1207 setLayout(new BorderLayout());
1208 enabled.setSelected(opt.isRequired()); // TODO: lock required options
1209 enabled.setFont(new Font("Verdana", Font.PLAIN, 11));
1210 enabled.setText("");
1211 enabled.setText(opt.getName());
1212 enabled.addActionListener(this);
1213 finfo = option.getFurtherDetails();
1217 // optlabel.setToolTipText("<html><p>"+opt.getDescription()+"</p><img src=\""+linkImageURL+"\"/></html>");
1218 enabled.setToolTipText("<html><p>" + opt.getDescription()
1219 + "</p><img src=\"" + linkImageURL + "\"/></html>");
1220 // optlabel.addMouseListener(this);
1221 enabled.addMouseListener(this);
1225 // optlabel.setToolTipText(opt.getDescription());
1226 enabled.setToolTipText(opt.getDescription());
1228 add(enabled, BorderLayout.NORTH);
1229 if (opt.getPossibleValues().size() > 1)
1231 setLayout(new GridLayout(1, 2));
1232 for (Object str : opt.getPossibleValues())
1234 val.addItem((String) str);
1236 val.setSelectedItem((String) opt.getDefaultValue());
1237 val.addActionListener(this);
1238 add(val, BorderLayout.SOUTH);
1240 // TODO: add actionListeners for popup (to open further info),
1241 // and to update list of parameters if an option is enabled
1242 // that takes a value.
1246 public void resetToDefault()
1248 enabled.setSelected(false);
1249 if (option.isRequired())
1251 // Apply default value
1252 selectOption(option, option.getDefaultValue());
1256 boolean initEnabled = false;
1258 String initVal = null;
1260 public void setInitialValue()
1262 initEnabled = enabled.isSelected();
1263 if (option.getPossibleValues() != null
1264 && option.getPossibleValues().size() > 1)
1266 initVal = (String) val.getSelectedItem();
1270 initVal = (initEnabled) ? option.getDefaultValue() : null;
1274 public OptionI getOptionIfEnabled()
1276 if (!enabled.isSelected())
1280 OptionI opt = option.copy();
1282 if (val.getSelectedItem() != null)
1284 opt.setDefaultValue((String) val.getSelectedItem());
1289 public void actionPerformed(ActionEvent e)
1291 if (e.getSource() != enabled)
1293 enabled.setSelected(true);
1298 private void checkIfModified()
1300 boolean notmod = (initEnabled == enabled.isSelected());
1301 if (enabled.isSelected())
1303 if (initVal != null)
1305 notmod &= initVal.equals(val.getSelectedItem());
1309 // compare against default service setting
1310 notmod &= option.getDefaultValue() == null
1311 || option.getDefaultValue().equals(val.getSelectedItem());
1316 notmod &= initVal == null;
1318 argSetModified(this, !notmod);
1321 public void mouseClicked(MouseEvent e)
1323 if (javax.swing.SwingUtilities.isRightMouseButton(e))
1325 showUrlPopUp(this, finfo.toString(), e.getX(), e.getY());
1329 public void mousePressed(MouseEvent e)
1331 // TODO Auto-generated method stub
1335 public void mouseReleased(MouseEvent e)
1337 // TODO Auto-generated method stub
1341 public void mouseEntered(MouseEvent e)
1343 // TODO Auto-generated method stub
1347 public void mouseExited(MouseEvent e)
1349 // TODO Auto-generated method stub
1355 private OptionBox addOption(OptionI opt)
1357 OptionBox cb = optSet.get(opt.getName());
1360 cb = new OptionBox(opt);
1361 optSet.put(opt.getName(), cb);
1367 public static void showUrlPopUp(JComponent invoker, final String finfo,
1371 JPopupMenu mnu = new JPopupMenu();
1372 JMenuItem mitem = new JMenuItem("View " + finfo);
1373 mitem.addActionListener(new ActionListener()
1377 public void actionPerformed(ActionEvent e)
1379 Desktop.showUrl(finfo);
1384 mnu.show(invoker, x, y);
1387 protected void refreshParamLayout()
1389 FlowLayout fl = new FlowLayout();
1390 paramList.setLayout(fl);
1391 int s = 2 * fl.getVgap();
1392 for (ParamBox pbox : paramSet.values())
1394 s += fl.getVgap() + pbox.getBoxHeight(); // getBoxHeight();
1396 paramList.setPreferredSize(new Dimension(PARAM_WIDTH, s));
1401 * testing method - grab a service and parameter set and show the window
1405 public static void main(String[] args)
1407 jalview.ws.jws2.Jws2Discoverer disc = jalview.ws.jws2.Jws2Discoverer
1410 if (args.length > 3)
1412 Vector<String> services = new Vector<String>();
1413 services.addElement(args[p++]);
1414 Jws2Discoverer.setServiceUrls(services);
1419 } catch (Exception e)
1421 System.err.println("Aborting. Problem discovering services.");
1422 e.printStackTrace();
1425 Jws2Discoverer.Jws2Instance lastserv = null;
1426 for (Jws2Discoverer.Jws2Instance service : disc.getServices())
1429 if (p >= args.length || service.serviceType.equalsIgnoreCase(args[p]))
1431 if (lastserv != null)
1433 List<Preset> prl = null;
1435 if (++p < args.length)
1437 PresetManager prman = lastserv.getPresets();
1440 pr = prman.getPresetByName(args[p]);
1443 // just grab the last preset.
1444 prl = prman.getPresets();
1450 PresetManager prman = lastserv.getPresets();
1453 prl = prman.getPresets();
1456 Iterator<Preset> en = (prl == null) ? null : prl.iterator();
1457 while (en != null && en.hasNext())
1463 en = prl.iterator();
1468 System.out.println("Testing opts dupes for "
1469 + lastserv.getHost() + " : "
1470 + lastserv.getActionText() + ":" + pr.getName());
1471 List<Option> rg = lastserv.getRunnerConfig().getOptions();
1476 Option cpy = jalview.ws.jws2.ParameterUtils.copyOption(o);
1477 } catch (Exception e)
1479 System.err.println("Failed to copy " + o.getName());
1480 e.printStackTrace();
1483 System.err.println("Failed to copy " + o.getName());
1484 e.printStackTrace();
1489 System.out.println("Testing param dupes:");
1490 List<Parameter> rg = lastserv.getRunnerConfig()
1492 for (Parameter o : rg)
1496 Parameter cpy = jalview.ws.jws2.ParameterUtils
1498 } catch (Exception e)
1500 System.err.println("Failed to copy " + o.getName());
1501 e.printStackTrace();
1504 System.err.println("Failed to copy " + o.getName());
1505 e.printStackTrace();
1510 System.out.println("Testing param write:");
1511 List<String> writeparam = null, readparam = null;
1514 writeparam = jalview.ws.jws2.ParameterUtils
1516 pr.getArguments(lastserv.getRunnerConfig()),
1518 System.out.println("Testing param read :");
1519 List<Option> pset = jalview.ws.jws2.ParameterUtils
1520 .processParameters(writeparam,
1521 lastserv.getRunnerConfig(), " ");
1522 readparam = jalview.ws.jws2.ParameterUtils
1523 .writeParameterSet(pset, " ");
1524 Iterator<String> o = pr.getOptions().iterator(), s = writeparam
1525 .iterator(), t = readparam.iterator();
1526 boolean failed = false;
1527 while (s.hasNext() && t.hasNext())
1529 String on = o.next(), sn = s.next(), st = t.next();
1532 System.out.println("Original was " + on
1533 + " Phase 1 wrote " + sn + "\tPhase 2 wrote "
1540 System.out.println("Original parameters:\n"
1542 System.out.println("Wrote parameters in first set:\n"
1544 System.out.println("Wrote parameters in second set:\n"
1548 } catch (Exception e)
1550 e.printStackTrace();
1553 WsJobParameters pgui = new WsJobParameters(lastserv, new JabaPreset(lastserv, pr));
1554 JFrame jf = new JFrame("Parameters for "
1555 + lastserv.getActionText());
1556 JPanel cont = new JPanel();
1557 // jf.setPreferredSize(new Dimension(600, 800));
1560 final Thread thr = Thread.currentThread();
1561 jf.addWindowListener(new WindowListener()
1564 public void windowActivated(WindowEvent e)
1566 // TODO Auto-generated method stub
1570 public void windowClosed(WindowEvent e)
1574 public void windowClosing(WindowEvent e)
1580 public void windowDeactivated(WindowEvent e)
1582 // TODO Auto-generated method stub
1586 public void windowDeiconified(WindowEvent e)
1588 // TODO Auto-generated method stub
1592 public void windowIconified(WindowEvent e)
1594 // TODO Auto-generated method stub
1598 public void windowOpened(WindowEvent e)
1600 // TODO Auto-generated method stub
1605 jf.setVisible(true);
1606 boolean inter = false;
1611 Thread.sleep(10000);
1612 } catch (Exception e)
1625 public List<ArgumentI> getJobParams()
1627 List<ArgumentI> argSet = new ArrayList<ArgumentI>();
1628 // recover options and parameters from GUI
1629 for (OptionBox opts : optSet.values())
1631 OptionI opt = opts.getOptionIfEnabled();
1637 for (ParamBox parambox : paramSet.values())
1639 ParameterI parm = parambox.getParameter();
1649 String lastParmSet = null;
1652 * Hashtable<String, Object[]> editedParams = new Hashtable<String,
1655 * store the given parameters in the user parameter set database.
1657 * @param storeSetName - lastParmSet
1659 * @param descr - setDescr.getText()
1661 * @param jobParams - getJobParams()
1663 * private void _storeUserPreset(String storeSetName, String descr,
1664 * List<ArgumentI> jobParams) { // this is a simple hash store. Object[] pset;
1665 * editedParams.put(storeSetName, pset = new Object[3]); pset[0] =
1666 * storeSetName; pset[1] = descr; pset[2] = jobParams; // writeParam("Saving "
1667 * + storeSetName + ": ", jobParams); }
1669 * private void writeParam(String nm, List<ArgumentI> params) { for (ArgumentI
1670 * p : params) { System.out.println(nm + ":" + System.identityHashCode(p) +
1671 * " Name: " + p.getName() + " Value: " + p.getDefaultValue()); } }
1673 * private Object[] _getUserPreset(String setName) { Object[] pset =
1674 * editedParams.get(setName); // if (pset != null) // writeParam("Retrieving "
1675 * + setName + ": ", (List<Argument>) pset[2]); return pset; }
1677 * * remove the given user preset from the preset stash
1681 * private void _deleteUserPreset(String setName) {
1682 * editedParams.remove(setName); }
1685 private void syncSetNamesWithStore()
1688 // remove any set names in the drop down menu that aren't either a reserved
1689 // setting, or a user defined or service preset.
1690 Vector items = new Vector();
1691 while (n < setName.getItemCount())
1693 String item = (String) setName.getItemAt(n);
1694 if (!item.equals(SVC_DEF) && !paramStore.presetExists(item))
1696 setName.removeItemAt(n);
1700 items.addElement(item);
1704 if (!items.contains(SVC_DEF))
1706 setName.addItem(SVC_DEF);
1708 for (WsParamSetI upn : paramStore.getPresets())
1710 if (!items.contains(upn.getName()))
1712 setName.addItem(upn.getName());
1718 * true if lastParmSet is a user preset
1720 boolean isUserPreset = false;
1722 private void reInitDialog(String nextPreset)
1724 settingDialog = true;
1725 // updateTable(null,null); // first reset to defaults
1726 WsParamSetI pset = null;
1727 if (nextPreset != null && nextPreset.length() > 0)
1729 pset = paramStore.getPreset(nextPreset);
1733 if (pset.isModifiable())
1735 isUserPreset = true;
1736 setDescr.setText(pset.getDescription());
1737 updateTable(null, pset.getArguments());
1738 lastParmSet = nextPreset;
1742 isUserPreset = false;
1743 setDescr.setText("");
1744 // must be a default preset from service
1745 updateTable(pset, null);
1746 lastParmSet = nextPreset;
1751 isUserPreset = false;
1753 updateTable(null, null);
1754 lastParmSet = SVC_DEF;
1757 initArgSetModified();
1758 syncSetNamesWithStore();
1759 setName.setSelectedItem(lastParmSet);
1761 settingDialog = false;
1765 String curSetName = null;
1767 public void itemStateChanged(ItemEvent e)
1769 if (e.getSource() == setName && e.getStateChange() == e.SELECTED)
1771 String setname = (String) setName.getSelectedItem();
1772 System.out.println("Item state changed for " + setname
1773 + " (handling ? " + !settingDialog + ")");
1779 if (setname == null)
1783 // user has selected a different item from combo-box
1786 String lsetname = (curSetName != null) ? curSetName : lastParmSet;
1787 if (lsetname.equals(setname))
1789 // setname was just edited - so ignore this event.
1792 settingDialog = true;
1793 System.out.println("Prompting to save " + lsetname);
1794 if (javax.swing.JOptionPane.showConfirmDialog(this,
1795 "Parameter set '" + lsetname + "' is modifed\nsave ?",
1796 "Save changes ?", javax.swing.JOptionPane.OK_CANCEL_OPTION) == JOptionPane.OK_OPTION)
1798 System.out.println("Saving for " + lsetname);
1799 _storeCurrentPreset(lsetname);
1803 settingDialog = true;
1804 reInitDialog(setname);
1805 settingDialog = false;
1811 * store current settings as given name. You should then reset gui.
1813 * @param curSetName2
1815 private void _storeCurrentPreset(String curSetName2)
1817 paramStore.storePreset(curSetName2, setDescr.getText(), getJobParams());
1821 * last saved name for this user preset
1823 String lastSetName = null;
1826 * last saved value of the description text for this user preset
1828 String lastDescrText = null;
1830 public void actionPerformed(ActionEvent e)
1832 if (e.getSource() instanceof Component)
1834 Component src = (Component) e.getSource();
1835 if (src.getParent() == setName)
1837 // rename any existing records we know about for this set.
1838 String newname = (String) e.getActionCommand().trim();
1840 if (isServicePreset(newname))
1842 JOptionPane.showConfirmDialog(this,
1843 "Invalid name - preset already exists.", "Invalid name",
1844 JOptionPane.OK_OPTION);
1846 setName.setSelectedItem(curSetName);
1849 curSetName = newname;
1850 System.err.println("New name for user setting " + curSetName
1851 + " (was " + setName.getSelectedItem() + ")");
1852 if (curSetName.equals(setName.getSelectedItem()))
1856 if (curSetName != null)
1858 argSetModified(setName, true);
1866 private void checkDescrModified()
1873 (lastDescrText == null ? setDescr.getText().trim().length() > 0
1874 : !setDescr.getText().equals(lastDescrText)));
1879 public void insertUpdate(DocumentEvent e)
1881 checkDescrModified();
1884 public void removeUpdate(DocumentEvent e)
1886 checkDescrModified();
1889 public void changedUpdate(DocumentEvent e)
1891 checkDescrModified();
1896 * @return null or the service preset selected by the user
1898 public WsParamSetI getPreset()
1900 if (isUserPreset || isModified()
1901 || (lastParmSet != null && lastParmSet.equals(SVC_DEF)))
1907 return paramStore.getPreset(lastParmSet);