src/jalview/gui/WsJobParameters.java

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