src/jalview/gui/WsJobParameters.java

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