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