src/jalview/gui/WsJobParameters.java

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