src/jalview/gui/WsJobParameters.java

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