src/jalview/gui/WsJobParameters.java

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