src/jalview/gui/WsJobParameters.java

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