src/jalview/gui/WsJobParameters.java

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