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