src/jalview/gui/WsJobParameters.java

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