X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FWsJobParameters.java;h=8543827c0da26415842ca6cff724679e10a2b831;hb=7692386ccfe778075dd83a753d30a7a27fe507be;hp=7c4391e774fba2f41a869ebf81d28f90a184783a;hpb=ede1e100824dea19a919f082f91a9697b391ce32;p=jalview.git diff --git a/src/jalview/gui/WsJobParameters.java b/src/jalview/gui/WsJobParameters.java index 7c4391e..8543827 100644 --- a/src/jalview/gui/WsJobParameters.java +++ b/src/jalview/gui/WsJobParameters.java @@ -1,887 +1,1500 @@ +/* + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors + * + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, either version 3 + * of the License, or (at your option) any later version. + * + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. + */ package jalview.gui; +import jalview.gui.OptsAndParamsPage.OptionBox; +import jalview.gui.OptsAndParamsPage.ParamBox; +import jalview.util.MessageManager; +import jalview.ws.jws2.JabaParamStore; +import jalview.ws.jws2.JabaPreset; +import jalview.ws.jws2.Jws2Discoverer; +import jalview.ws.jws2.jabaws2.Jws2Instance; +import jalview.ws.params.ArgumentI; +import jalview.ws.params.OptionI; +import jalview.ws.params.ParamDatastoreI; +import jalview.ws.params.ParameterI; +import jalview.ws.params.WsParamSetI; + import java.awt.BorderLayout; import java.awt.Component; import java.awt.Dimension; import java.awt.FlowLayout; import java.awt.Font; +import java.awt.GridBagConstraints; +import java.awt.GridBagLayout; import java.awt.GridLayout; +import java.awt.Rectangle; import java.awt.event.ActionEvent; import java.awt.event.ActionListener; -import java.awt.event.ComponentEvent; -import java.awt.event.ComponentListener; -import java.awt.event.ContainerEvent; -import java.awt.event.ContainerListener; -import java.awt.event.MouseEvent; -import java.awt.event.MouseListener; +import java.awt.event.HierarchyBoundsListener; +import java.awt.event.HierarchyEvent; +import java.awt.event.ItemEvent; +import java.awt.event.ItemListener; import java.awt.event.WindowEvent; import java.awt.event.WindowListener; -import java.awt.event.WindowStateListener; -import java.util.ArrayList; -import java.util.EventObject; -import java.util.HashSet; import java.util.Hashtable; +import java.util.Iterator; import java.util.List; -import java.util.Map; import java.util.Vector; import javax.swing.JButton; -import javax.swing.JCheckBox; import javax.swing.JComboBox; +import javax.swing.JDialog; import javax.swing.JFrame; import javax.swing.JLabel; -import javax.swing.JOptionPane; import javax.swing.JPanel; import javax.swing.JScrollPane; -import javax.swing.JTable; import javax.swing.JTextArea; -import javax.swing.ListSelectionModel; -import javax.swing.SwingUtilities; import javax.swing.border.TitledBorder; -import javax.swing.event.CellEditorListener; -import javax.swing.table.*; +import javax.swing.event.DocumentEvent; +import javax.swing.event.DocumentListener; import compbio.metadata.Argument; import compbio.metadata.Option; import compbio.metadata.Parameter; import compbio.metadata.Preset; import compbio.metadata.PresetManager; -import compbio.metadata.RunnerConfig; -import compbio.metadata.ValueConstrain; -import compbio.metadata.ValueConstrain.Type; +import net.miginfocom.swing.MigLayout; + +/** + * job parameter editing/browsing dialog box. User can browse existing settings + * (user + presets + Defaults), and any changes to parameters creates a modified + * user parameter set. LOGIC: If the parameter set is modified, and its name is + * a valid, non-existant user parameter set, then a save button is shown. If the + * parameter set is modified and its name is a valid, extant user parameter set, + * then an update button is shown. If user parameter set's name is edited, and + * old name exists as a writable user parameter set, then rename button is + * shown. If current parameter set is associated with a user defined parameter + * set, then : if set is modifed, a 'revert' button is shown. if set is not + * modified, a 'delete' button is shown. + * + * @author JimP + * + */ +public class WsJobParameters extends JPanel implements ItemListener, + ActionListener, DocumentListener, OptsParametersContainerI +{ + private static final int PREFERRED_WIDTH = 540; -import jalview.ws.jws2.Jws2Discoverer; -import jalview.ws.jws2.Jws2Discoverer.Jws2Instance; + private static final int DEFAULT_HEIGHT = 640; -public class WsJobParameters extends JPanel -{ - JPanel setDetails = new JPanel(); + // the default parameter set shown to the user + private static final String SVC_DEF = "Defaults"; - JPanel settingsPanel = new JPanel(); + private int maxOptWidth = 200; - JPanel jobOptions = new JPanel(); + // URL linkImageURL = getClass().getResource("/images/link.gif"); - JPanel jobParameters = new JPanel(); + /* + * controller for options and parameters layout + */ + OptsAndParamsPage opanp; - JPanel paramButtons = new JPanel(); + /* + * panel containing job options + */ + JPanel optionsPanel = new JPanel(); - JButton exportParams = new JButton(); + /* + * panel containing job parameters + */ + JPanel paramsPanel = new JPanel(); - JButton importParams = new JButton(); + JPanel setNamePanel = new JPanel(); - JButton resetParams = new JButton(); + JButton createpref = new JButton(); - JButton addParam = new JButton(); + JButton deletepref = new JButton(); - JButton removeParam = new JButton(); + JButton revertpref = new JButton(); - JButton editParam = new JButton(); + JButton updatepref = new JButton(); - JLabel setName = new JLabel(); + JComboBox setName = new JComboBox<>(); JTextArea setDescr = new JTextArea(); - JTable paramTable = new JTable(); - JScrollPane paramPane = new JScrollPane(); - RunnerConfig serviceOptions; + ParamDatastoreI paramStore; - List availableParameters; + // set true when 'Start Job' is clicked + boolean startJob = false; - private BorderLayout jparamLayout; + JDialog frame = null; - WsJobParameters(Jws2Instance service) - { - this(service, null); - } + Jws2Instance service; + + /* + * list of service presets in the gui + */ + Hashtable servicePresets = null; + + /* + * set if dialog is being set - so handlers will avoid spurious events + */ + boolean settingDialog = false; - public WsJobParameters(Jws2Instance service, Preset p) + private Hashtable modifiedElements = new Hashtable<>(); + + String lastParmSet = null; + + public WsJobParameters(ParamDatastoreI store, WsParamSetI preset, + List args) { - this(null, service, p); + super(); + + // parameters dialog in 'compact' format (help as tooltips) + opanp = new OptsAndParamsPage(this, true); + jbInit(); + this.paramStore = store; + this.service = null; + init(preset, args); + validate(); } /** + * Constructor given a set of parameters and presets, a service to be invoked, + * and a list of (Jabaws client) arguments * - * @param desktop - * - if null, create new JFrame outside of desktop + * @param paramStorei * @param service - * @param p + * @param preset + * @param jobArgset */ - public WsJobParameters(JFrame parent, Jws2Instance service, Preset p) + public WsJobParameters(ParamDatastoreI paramStorei, Jws2Instance service, + WsParamSetI preset, List jobArgset) { super(); - jbInit(); - initTableUI(); - // populate parameter table - initForService(service, p); - // display in new JFrame attached to parent. - validate(); - } - private void jbInit() - { - exportParams.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10)); - exportParams.setText("Export"); - exportParams.setToolTipText("Export parameters to a file"); - exportParams.addActionListener(new ActionListener() - { - public void actionPerformed(ActionEvent e) - { - exportParams_actionPerformed(e); - } - }); - importParams.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10)); - importParams.setText("Import"); - importParams.setToolTipText("Import parameters from a file"); - importParams.addActionListener(new ActionListener() - { - public void actionPerformed(ActionEvent e) - { - importParams_actionPerformed(e); - } - }); - resetParams.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10)); - resetParams.setText("Defaults"); - resetParams.setToolTipText("Reset to defaults"); - resetParams.addActionListener(new ActionListener() - { - public void actionPerformed(ActionEvent e) - { - resetParams_actionPerformed(e); - } - }); - addParam.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10)); - addParam.setText("Add"); - addParam.setToolTipText("Add new parameter"); - addParam.addActionListener(new ActionListener() - { - public void actionPerformed(ActionEvent e) - { - addParam_actionPerformed(e); - } - }); - removeParam.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10)); - removeParam.setText("Remove"); - removeParam.setToolTipText("Remove selected parameter"); - removeParam.addActionListener(new ActionListener() - { - public void actionPerformed(ActionEvent e) - { - removeParam_actionPerformed(e); - } - }); - editParam.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10)); - editParam.setText("Edit"); - editParam.setToolTipText("Edit selected parameter"); - editParam.addActionListener(new ActionListener() - { - public void actionPerformed(ActionEvent e) - { - editParam_actionPerformed(e); - } - }); + // parameters dialog in 'expanded' format (help text boxes) + opanp = new OptsAndParamsPage(this, false); - setDetails.setBorder(new TitledBorder("Details")); - setDetails.setLayout(new GridLayout(2, 1)); - setDescr.setColumns(40); - setDescr.setWrapStyleWord(true); - setDescr.setPreferredSize(new Dimension(350, 100)); - setDetails.add(setName); - setDetails.add(setDescr); - setDetails.setPreferredSize(new Dimension(360, 150)); - settingsPanel.setLayout(new BorderLayout()); - jobOptions.setBorder(new TitledBorder("Options")); - jobParameters.setBorder(new TitledBorder("Parameters")); - jobParameters.setLayout(jparamLayout = new BorderLayout()); - paramPane.setPreferredSize(new Dimension(360, 300)); - paramButtons.setLayout(new GridLayout(2, 3)); - paramButtons.add(addParam); - paramButtons.add(editParam); - paramButtons.add(removeParam); - // TODO: relayout buttons nicely - paramButtons.add(exportParams); - paramButtons.add(importParams); - paramButtons.add(resetParams); - jobParameters.add(paramPane, BorderLayout.NORTH); - jobParameters.add(paramButtons, BorderLayout.SOUTH); - settingsPanel.add(jobOptions, BorderLayout.NORTH); - settingsPanel.add(jobParameters, BorderLayout.SOUTH); - setLayout(new BorderLayout()); - setPreferredSize(new Dimension(400, 600)); - setSize(new Dimension(400, 600)); - add(setDetails, BorderLayout.NORTH); - add(settingsPanel, BorderLayout.CENTER); + jbInit(); + this.paramStore = paramStorei; + if (paramStore == null && service != null) + { + paramStore = service.getParamStore(); + } + this.service = service; + initForService(preset, jobArgset); + validate(); } /** - * need to populate table and validate after calling this to set up table and - * add it to pane + * Shows a modal dialog containing the parameters and Start or Cancel options. + * Answers true if the job is started, false if cancelled. + * + * @return */ - public void initTableUI() + public boolean showRunDialog() { - paramTable = new JTable(); - paramTable.getTableHeader() - .setFont(new Font("Verdana", Font.PLAIN, 12)); - paramTable.setFont(new Font("Verdana", Font.PLAIN, 12)); - paramPane.getViewport().removeAll(); - paramPane.getViewport().add(paramTable); - paramTable.setDefaultRenderer(Argument.class, new ArgumentRenderer()); - paramTable.setDefaultRenderer(Parameter.class, new ArgumentRenderer()); - paramTable.setDefaultRenderer(Option.class, new ArgumentRenderer()); - paramTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION); - paramTable.addMouseListener(new MouseListener() + frame = new JDialog(Desktop.instance, true); + if (service != null) { + frame.setTitle(MessageManager.formatMessage("label.edit_params_for", + new String[] + { service.getActionText() })); + } - @Override - public void mouseClicked(MouseEvent e) - { - if (e.getClickCount() > 1) - { - editParam_actionPerformed(null); - } - } + Rectangle deskr = Desktop.instance.getBounds(); + Dimension pref = this.getPreferredSize(); + frame.setBounds( + new Rectangle((int) (deskr.getCenterX() - pref.width / 2), + (int) (deskr.getCenterY() - pref.height / 2), + pref.width, pref.height)); + frame.setContentPane(this); + + // should perhaps recover defaults from user prefs. + frame.validate(); + javax.swing.SwingUtilities.invokeLater(new Runnable() + { @Override - public void mouseEntered(MouseEvent e) + public void run() { - // tooltips - // TODO Auto-generated method stub + // jobPanel.setDividerLocation(0.25); } + }); + frame.setVisible(true); - @Override - public void mouseExited(MouseEvent e) - { - // tooltips - // TODO Auto-generated method stub + return startJob; + } - } + private void jbInit() + { + this.addHierarchyBoundsListener(new HierarchyBoundsListener() + { @Override - public void mousePressed(MouseEvent e) + public void ancestorResized(HierarchyEvent arg0) { - // TODO Auto-generated method stub - + refreshParamLayout(); } @Override - public void mouseReleased(MouseEvent e) + public void ancestorMoved(HierarchyEvent arg0) { // TODO Auto-generated method stub } - }); - // paramTable.setDefaultEditor(Argument.class, new WsArgumentEditor(this)); - } - - public class WsArgumentEditor implements TableCellEditor - { - - int p; - - Argument arg; - - WsJobParameters wsparm; + updatepref = JvSwingUtils.makeButton( + MessageManager.getString("action.update"), + MessageManager.getString("label.update_user_parameter_set"), + new ActionListener() + { - public WsArgumentEditor(WsJobParameters wsJobParameters) - { - wsparm = wsJobParameters; - p = wsparm.paramTable.getSelectedRow(); - arg = (Argument) wsparm.paramTable.getValueAt(p, wsparm.paramTable - .getSelectedColumn()); - /* - * if (arg instanceof Option) { if - * (JOptionPane.showInternalConfirmDialog(Desktop.desktop, - * "Remove option "+arg.getName(), - * "Delete option ?",JOptionPane.YES_NO_OPTION, - * JOptionPane.QUESTION_MESSAGE) == JOptionPane.YES_OPTION) { - * - * } } - */ - } + @Override + public void actionPerformed(ActionEvent e) + { + update_actionPerformed(); + } + }); + deletepref = JvSwingUtils.makeButton( + MessageManager.getString("action.delete"), + MessageManager.getString("label.delete_user_parameter_set"), + new ActionListener() + { - @Override - public Component getTableCellEditorComponent(JTable table, - Object value, boolean isSelected, int row, int column) - { - // TODO Auto-generated method stub - return null; - } + @Override + public void actionPerformed(ActionEvent e) + { + delete_actionPerformed(); + } + }); + createpref = JvSwingUtils.makeButton( + MessageManager.getString("action.create"), + MessageManager.getString("label.create_user_parameter_set"), + new ActionListener() + { - @Override - public void addCellEditorListener(CellEditorListener l) - { - // TODO Auto-generated method stub + @Override + public void actionPerformed(ActionEvent e) + { + create_actionPerformed(); + } + }); + revertpref = JvSwingUtils.makeButton( + MessageManager.getString("action.revert"), + MessageManager + .getString("label.revert_changes_user_parameter_set"), + new ActionListener() + { - } + @Override + public void actionPerformed(ActionEvent e) + { + revert_actionPerformed(); + } + }); + + JButton startjob = JvSwingUtils.makeButton( + MessageManager.getString("action.start_job"), + MessageManager.getString("label.start_job_current_settings"), + new ActionListener() + { + @Override + public void actionPerformed(ActionEvent e) + { + startjob_actionPerformed(); + } + }); + JButton canceljob = JvSwingUtils.makeButton( + MessageManager.getString("action.cancel_job"), + MessageManager.getString("label.cancel_job_close_dialog"), + new ActionListener() + { + @Override + public void actionPerformed(ActionEvent e) + { + canceljob_actionPerformed(); + } + }); + + JPanel setDetails = new JPanel(); + setDetails.setBorder( + new TitledBorder(MessageManager.getString("label.details"))); + setDetails.setLayout(new BorderLayout()); + setDescr.setColumns(40); + setDescr.setWrapStyleWord(true); + setDescr.setLineWrap(true); + setDescr.setBackground(getBackground()); + setDescr.setEditable(true); + setDescr.getDocument().addDocumentListener(this); + setDescr.setToolTipText( + MessageManager.getString("label.edit_notes_parameter_set")); + JScrollPane setDescrView = new JScrollPane(); + setDescrView.getViewport().setView(setDescr); + setName.setEditable(true); + setName.addItemListener(this); + setName.getEditor().addActionListener(this); + JPanel setNameInfo = new JPanel(new FlowLayout(FlowLayout.LEFT)); + GridBagLayout gbl = new GridBagLayout(); + setNamePanel.setLayout(gbl); + + JLabel setNameLabel = new JLabel( + MessageManager.getString("label.current_parameter_set_name")); + setNameLabel.setFont(new java.awt.Font("Verdana", Font.PLAIN, 10)); + + setNameInfo.add(setNameLabel); + setNameInfo.add(setName); + + // initial button visibility + updatepref.setVisible(false); + deletepref.setVisible(false); + revertpref.setVisible(false); + createpref.setVisible(false); + JPanel setsavebuts = new JPanel(); + setsavebuts.setLayout(new FlowLayout(FlowLayout.LEFT, 10, 0)); // GridLayout(1,2)); + JPanel spacer = new JPanel(); + spacer.setPreferredSize(new Dimension(2, 30)); + setsavebuts.add(spacer); + setsavebuts.add(deletepref); + setsavebuts.add(revertpref); + setsavebuts.add(createpref); + setsavebuts.add(updatepref); + // setsavebuts.setSize(new Dimension(150, 30)); + JPanel buttonArea = new JPanel(new GridLayout(1, 1)); + buttonArea.add(setsavebuts); + setNamePanel.add(setNameInfo); + GridBagConstraints gbc = new GridBagConstraints(); + gbc.gridheight = 2; + gbl.setConstraints(setNameInfo, gbc); + setNamePanel.add(buttonArea); + gbc = new GridBagConstraints(); + gbc.gridx = 0; + gbc.gridy = 2; + gbc.gridheight = 1; + gbl.setConstraints(buttonArea, gbc); + setDetails.add(setDescrView, BorderLayout.CENTER); + + // paramPane.setPreferredSize(new Dimension(360, 400)); + // paramPane.setPreferredSize(null); + optionsPanel.setBorder( + new TitledBorder(MessageManager.getString("label.options"))); + optionsPanel.setOpaque(true); + paramsPanel.setBorder( + new TitledBorder(MessageManager.getString("label.parameters"))); + paramsPanel.setOpaque(true); + // optsAndparams.setScrollableWidth(ScrollableSizeHint.FIT); + // optsAndparams.setScrollableHeight(ScrollableSizeHint.NONE); + // optsAndparams.setLayout(new BorderLayout()); + JPanel optsAndparams = new JPanel(); + optsAndparams.setLayout(new BorderLayout()); + optsAndparams.add(optionsPanel, BorderLayout.NORTH); + optsAndparams.add(paramsPanel, BorderLayout.CENTER); + JPanel jp = new JPanel(new BorderLayout()); + jp.add(optsAndparams, BorderLayout.CENTER); + paramPane.getViewport().setView(jp); + paramPane.setBorder(null); + setLayout(new BorderLayout()); - @Override - public void cancelCellEditing() - { - // TODO Auto-generated method stub + JPanel jobPanel = new JPanel(); + jobPanel.setPreferredSize(null); + jobPanel.setLayout(new BorderLayout()); + jobPanel.add(setDetails, BorderLayout.NORTH); + jobPanel.add(paramPane, BorderLayout.CENTER); + // jobPanel.setOrientation(JSplitPane.VERTICAL_SPLIT); + + add(setNamePanel, BorderLayout.NORTH); + add(jobPanel, BorderLayout.CENTER); + + JPanel dialogpanel = new JPanel(); + dialogpanel.add(startjob); + dialogpanel.add(canceljob); + // JAL-1580: setMaximumSize() doesn't work, so just size for the worst case: + // check for null is for JUnit usage + final int windowHeight = Desktop.instance == null ? DEFAULT_HEIGHT + : Desktop.instance.getHeight(); + // setPreferredSize(new Dimension(PREFERRED_WIDTH, windowHeight)); + add(dialogpanel, BorderLayout.SOUTH); + validate(); + } - } + protected void revert_actionPerformed() + { + reInitDialog(lastParmSet); + updateWebServiceMenus(); + } - @Override - public Object getCellEditorValue() + protected void update_actionPerformed() + { + if (isUserPreset) { - // TODO Auto-generated method stub - return null; + String curname = ((String) setName.getSelectedItem()).trim(); + _updatePreset(lastParmSet, curname); + lastParmSet = curname; + isUserPreset = true; + initArgSetModified(); + syncSetNamesWithStore(); } + } - @Override - public boolean isCellEditable(EventObject anEvent) - { - // TODO Auto-generated method stub - return false; - } + private void _deleteUserPreset(String lastParmSet2) + { + paramStore.deletePreset(lastParmSet2); + } - @Override - public void removeCellEditorListener(CellEditorListener l) + protected void delete_actionPerformed() + { + if (isUserPreset) { - // TODO Auto-generated method stub - + // delete current preset's saved entry + _deleteUserPreset(lastParmSet); } + reInitDialog(null); // service default + updateWebServiceMenus(); + } - @Override - public boolean shouldSelectCell(EventObject anEvent) + protected void create_actionPerformed() + { + String curname = ((String) setName.getSelectedItem()).trim(); + if (curname.length() > 0) { - // TODO Auto-generated method stub - return false; + _storeCurrentPreset(curname); + lastParmSet = curname; + isUserPreset = true; + reInitDialog(curname); + initArgSetModified(); + updateWebServiceMenus(); } - - @Override - public boolean stopCellEditing() + else { - // TODO Auto-generated method stub - return false; + // TODO: show warning + System.err.println("Invalid name. Not saved."); } - } - protected void editParam_actionPerformed(ActionEvent e) + protected void canceljob_actionPerformed() { - // TODO Auto-generated method stub - - } - - protected void removeParam_actionPerformed(ActionEvent e) - { - // TODO Auto-generated method stub - + startJob = false; + if (frame != null) + { + frame.setVisible(false); + } } - protected void addParam_actionPerformed(ActionEvent e) + protected void startjob_actionPerformed() { - // TODO Auto-generated method stub - + startJob = true; + if (frame != null) + { + frame.setVisible(false); + } } - protected void resetParams_actionPerformed(ActionEvent e) + void initForService(WsParamSetI jabap, List jabajobArgset) { - // TODO Auto-generated method stub - - } + WsParamSetI p = null; + List jobArgset = null; + settingDialog = true; + { // instantiate the abstract proxy for Jaba objects + jobArgset = jabajobArgset == null ? null + : JabaParamStore.getJwsArgsfromJaba(jabajobArgset); + p = jabap; // (jabap != null) ? paramStore.getPreset(jabap.getName()) : + // null; + } - protected void importParams_actionPerformed(ActionEvent e) - { - // TODO Auto-generated method stub + init(p, jobArgset); } - protected void exportParams_actionPerformed(ActionEvent e) + void init(WsParamSetI p, List jobArgset) { - // TODO Auto-generated method stub - - } + Hashtable exnames = new Hashtable<>(); + for (int i = 0, iSize = setName.getItemCount(); i < iSize; i++) + { + exnames.put(setName.getItemAt(i), setName.getItemAt(i)); + } + servicePresets = new Hashtable<>(); + // Add the default entry - if not present already. + if (!exnames.contains(SVC_DEF)) + { + setName.addItem(SVC_DEF); + exnames.put(SVC_DEF, SVC_DEF); + servicePresets.put(SVC_DEF, SVC_DEF); + } - void initForService(Jws2Instance service, Preset p) - { - serviceOptions = service.getRunnerConfig(); - updateTable(p); + // String curname = (p == null ? "" : p.getName()); + for (WsParamSetI pr : paramStore.getPresets()) + { + if (!pr.isModifiable()) + { + servicePresets.put(pr.getName(), "preset"); + } + else + { + } + if (!exnames.contains(pr.getName())) + { + setName.addItem(pr.getName()); + } + } + // TODO: if initial jobArgset matches a given user setting or preset then + // should recover setting accordingly + // updateTable(p, jobArgset); + if (p != null) + { + reInitDialog(p.getName()); + initArgSetModified(); + } + else + { + if (jobArgset != null && jobArgset.size() > 0) + { + curSetName = "Supplied Settings"; + isUserPreset = false; + updateTable(p, jobArgset); + setName.setSelectedItem(curSetName); + updateButtonDisplay(); + } + else + { + curSetName = null; + reInitDialog(null); + } + } + settingDialog = false; } - @SuppressWarnings("unchecked") - private void updateTable(Preset p) + private void updateTable(WsParamSetI p, List jobArgset) { - WsParameterTableModel mdl = null; - TableModel tmdl = paramTable.getModel(); - if (tmdl instanceof WsParameterTableModel) + boolean setDefaultParams = false; + if (lastParmSet == null) { - mdl = (WsParameterTableModel) tmdl; + isUserPreset = false; + // First call - so provide Service default settings + setName.setSelectedItem(lastSetName = SVC_DEF); } - if (mdl == null) + if (p == null && SVC_DEF.equals("" + setName.getSelectedItem())) { - paramTable.setModel(mdl = new WsParameterTableModel()); + // indicate that service defaults should be set if available + setDefaultParams = true; } - availableParameters = new ArrayList(); - List setargs = new ArrayList(); // populate table from default parameter set. - List args = serviceOptions.getArguments(); - + List args = paramStore.getServiceParameters(); + // split to params and required arguments { - for (Argument arg : args) + int cw = 0; + boolean optset = false; + for (ArgumentI myarg : args) { - Argument myarg = (Argument) arg; // Ideally, Argument would implement isRequired ! - if (myarg instanceof Parameter) + if (myarg instanceof ParameterI) { - Parameter parm = (Parameter) myarg; - if (parm.isRequired()) - { - setargs.add(parm); - } - else - { - availableParameters.add(parm); - } + ParameterI parm = (ParameterI) myarg; + opanp.addParameter(parm).validate(); } else { - if (myarg instanceof Option) + if (myarg instanceof OptionI) { - Option opt = (Option) myarg; - addOption(opt); - if (opt.isRequired()) + OptionI opt = (OptionI) myarg; + OptionBox ob = opanp.addOption(opt); + ob.resetToDefault(setDefaultParams); + if (maxOptWidth < ob.getPreferredSize().width) { - selectOption(opt, opt.getDefaultValue()); + maxOptWidth = ob.getPreferredSize().width; } + ob.validate(); + cw += ob.getPreferredSize().width + 5; } else { System.err.println("Ignoring unknown service argument type " - + arg.getClass().getName()); + + myarg.getClass().getName()); } } } + args = null; // no more args to process. } - if (p != null) { - setDescr.setText(p.getDescription()); - setName.setText(p.getName()); + isUserPreset = false; + // initialise setname + setName.setSelectedItem(lastSetName = p.getName()); + setDescr.setText(lastDescrText = p.getDescription()); // TODO - URL link try { - args = p.getArguments(serviceOptions); + args = p.getArguments(); } catch (Exception e) { e.printStackTrace(); } - setargs.clear(); - // get setargs from current object - if (args != null) + // TODO: check if args should be unselected prior to resetting using the + // preset + } + + if (jobArgset != null) + { + argSetModified(jobArgset, true); + args = jobArgset; + } + // get setargs from current object + if (args != null) + { + for (ArgumentI arg : args) { - for (Argument arg : args) + if (arg instanceof ParameterI) + { + opanp.setParameter((ParameterI) arg); + } + else { - if (arg instanceof Parameter) + if (arg instanceof OptionI) { - setargs.add((Parameter) arg); + // System.out.println("Setting option " + // + System.identityHashCode(arg) + ":" + arg.getName() + // + " with " + arg.getDefaultValue()); + opanp.selectOption((OptionI) arg, arg.getValue()); } - else - { - if (arg instanceof Option) - { - selectOption((Option) arg, arg.getDefaultValue()); - } - } - } + } } - mdl.setData(setargs); - paramTable.setModel(mdl); - // paramTable.validate(); - jobOptions.setLayout(new GridLayout(optSet.size() / 2 + 1, 2)); - jobOptions.validate(); + refreshParamLayout(); + revalidate(); } - private void selectOption(Option opt, String string) + private boolean isModified() { - OptionBox cb = optSet.get(opt.getName()); - if (cb == null) - { - cb = addOption(opt); - } - if (string == null) + return modifiedElements.size() > 0; + } + + /** + * reset gui and modification state settings + */ + private void initArgSetModified() + { + curSetName = null; + modifiedElements.clear(); + updateButtonDisplay(); + } + + private void updateButtonDisplay() + { + boolean _update = false, _create = false, _delete = false, + _revert = false; + if (modifiedElements.size() > 0) { - // no value specified. - if (opt.isRequired()) - { - // indicate option needs to be selected! - } - else + // set modified + _revert = true; + _update = isUserPreset; // can only update user presets + if (!isUserPreset || modifiedElements.containsKey(setName)) { - cb.enabled.setSelected(false); + // name modified - can create new preset + _create = true; } } else { - cb.enabled.setSelected(true); + // set unmodified + } + // can still delete a user preset + _delete = isUserPreset; - if (opt.getPossibleValues().contains(string)) - { - cb.val.setSelectedItem(string); - } - else + createpref.setVisible(_create); + updatepref.setVisible(_update); + deletepref.setVisible(_delete); + revertpref.setVisible(_revert); + validate(); + } + + @Override + public void argSetModified(Object modifiedElement, boolean b) + { + if (settingDialog) + { + return; + } + if (!b) + { + modifiedElements.remove(modifiedElement); + } + else + { + if (b && modifiedElement == setName + && modifiedElements.contains(modifiedElement)) { - throw new Error("Invalid value " + string + " for option " + opt); + // HACK! prevents iteration on makeSetNameValid + b = false; } - + modifiedElements.put(modifiedElement, modifiedElement); } + // set mod status based on presence of elements in table + if (b && modifiedElements.size() > 0) + { + makeSetNameValid(!isUserPreset); + setNamePanel.revalidate(); + } + updateButtonDisplay(); } - Map optSet = new Hashtable(); - - public class OptionBox extends JPanel + private boolean isServicePreset(String selectedItem) { - JComboBox val = new JComboBox(); - - JCheckBox enabled = new JCheckBox(); + return selectedItem.equals(SVC_DEF) + || servicePresets.containsKey(selectedItem); + } - public OptionBox(Option opt) + /** + * check if the current set name is a valid set name for saving, if not, then + * fix it. + */ + private void makeSetNameValid(boolean newuserset) + { + boolean stn = settingDialog; + boolean renamed = false; + settingDialog = true; + String nm = (curSetName != null ? curSetName + : (String) setName.getSelectedItem()); + // check if the name is reserved - if it is, rename it. + if (isServicePreset(nm)) { - setLayout(new BorderLayout()); - enabled.setSelected(opt.isRequired()); - enabled.setFont(new Font("Verdana", Font.PLAIN, 11)); - enabled.setText(opt.getName()); - enabled.setToolTipText(opt.getDescription()); - add(enabled, BorderLayout.NORTH); - if (opt.getPossibleValues().size() > 1) + nm = "User " + nm; + renamed = true; + } + String tnm = nm; + if (newuserset) + { + int i = 0; + while (paramStore.getPreset(tnm) != null) { - setLayout(new GridLayout(1,2)); - for (Object str : opt.getPossibleValues()) - { - val.addItem((String) str); - } - val.setSelectedItem((String) opt.getDefaultValue()); - add(val, BorderLayout.SOUTH); + tnm = nm + " (" + (++i) + ")"; + renamed = true; + } + if (i > 0) + { + nm = tnm; } - // TODO: add actionListeners for popup (to open further info), - // and to update list of parameters if an option is enabled - // that takes a value. } - } - private OptionBox addOption(Option opt) - { - OptionBox cb = optSet.get(opt.getName()); - if (cb == null) + boolean makeupdate = false; + // sync the gui with the preset database + for (int i = 0, iS = setName.getItemCount(); i < iS; i++) { - cb = new OptionBox(opt); - optSet.put(opt.getName(), cb); - jobOptions.add(cb); + String snm = setName.getItemAt(i); + if (snm.equals(nm)) + { + makeupdate = true; + // setName.setSelectedIndex(i); + } } - return cb; + if (!makeupdate) + { + setName.addItem(curSetName = nm); + setName.setSelectedItem(curSetName); + } + if (renamed) + { + settingDialog = false; // we need this name change to be registered. + argSetModified(setName, renamed); + } + settingDialog = stn; } - class WsParameterTableModel extends AbstractTableModel + /** + * Rebuilds the Options and Parameters panels + */ + @Override + public void refreshParamLayout() { - // arg list - vector for thread safety - public Vector data = new Vector(); + final int rightMargin = 40; + final int availableWidth = paramPane.getViewport().getSize().width + - rightMargin + - optionsPanel.getBorder().getBorderInsets(optionsPanel).left + + optionsPanel.getBorder().getBorderInsets(optionsPanel).right; - private String[] colNames = - { "Parameter", "Value" }; - - @Override - public int getColumnCount() + if (opanp.getOptSet().size() > 0) { - return 2; - } + int hgap = 5; + int currentWidth = hgap; - @Override - public int findColumn(String columnName) + /* + * layout constraint 'nogrid' prevents vertical column alignment, + * allowing controls to flow without extra space inserted to align + */ + optionsPanel.setLayout(new MigLayout("nogrid", "", "")); + optionsPanel.removeAll(); + JPanel lastAdded = null; + + /* + * add each control in turn; if adding would overflow the right margin, + * remove and re-add the previous parameter with "wrap" (after) + * in order to start a new row + */ + for (OptionBox pbox : opanp.getOptSet().values()) + { + pbox.validate(); + int boxWidth = pbox.getSize().width; + currentWidth += boxWidth + hgap; + boolean wrapAfterLast = currentWidth > availableWidth + && lastAdded != null; + // System.out.println(String.format( + // "%s width=%d, paneWidth=%d, currentWidth=%d, wrapAfterLast=%s", + // pbox.toString(), boxWidth, panewidth, currentWidth, + // wrapAfterLast)); + if (wrapAfterLast) + { + optionsPanel.remove(lastAdded); + optionsPanel.add(lastAdded, "wrap"); + currentWidth = hgap + boxWidth; + } + optionsPanel.add(pbox); + lastAdded = pbox; + } + optionsPanel.revalidate(); + } + else { - // TODO Auto-generated method stub - return super.findColumn(columnName); + optionsPanel.setVisible(false); } - public void setData(List setargs) + if (opanp.getParamSet().size() > 0) { - if (setargs != null) - { - data = new Vector(setargs); + paramsPanel.removeAll(); + paramsPanel.setLayout(new MigLayout("", "", "")); + int hgap = 5; + int currentWidth = hgap; - } - else + JPanel lastAdded = null; + for (ParamBox pbox : opanp.getParamSet().values()) { - data = new Vector(); + pbox.validate(); + int boxWidth = pbox.getSize().width; + currentWidth += boxWidth + hgap; + boolean wrapAfterLast = currentWidth > availableWidth + && lastAdded != null; + if (wrapAfterLast) + { + paramsPanel.remove(lastAdded); + paramsPanel.add(lastAdded, "wrap"); + currentWidth = pbox.getSize().width + hgap; + } + paramsPanel.add(pbox); + lastAdded = pbox; } - } - public List getData() + /* + * s = 2 * sep; for (ParamBox pbox : opanp.getParamSet().values()) { + * pbox.validate(); s += sep + + * pbox.getPreferredSize().height+pbox.getBorder + * ().getBorderInsets(pbox).bottom; } + * + * // paramList.setPreferredSize(new Dimension(w, s)); + * os+=s+2*sep+paramList + * .getBorder().getBorderInsets(paramList).bottom+paramList + * .getBorder().getBorderInsets(paramList).top; + */ + paramsPanel.revalidate(); + } + else { - return new ArrayList(data); + paramsPanel.setVisible(false); } + // TODO: waste some time trying to eliminate any unnecessary .validate calls + // here + // System.out.println("Size will be : "+w+","+os); + // optsAndparams.setPreferredSize(null); + // paramPane.getViewport().setView(optsAndparams); + paramPane.getViewport().setAutoscrolls(true); + paramPane.revalidate(); + revalidate(); + } - @Override - public int getRowCount() + /** + * testing method - grab a service and parameter set and show the window + * + * @param args + */ + public static void main(String[] args) + { + jalview.ws.jws2.Jws2Discoverer disc = jalview.ws.jws2.Jws2Discoverer + .getDiscoverer(); + int p = 0; + if (args.length > 0) { - return data.size(); + Vector services = new Vector<>(); + services.addElement(args[p++]); + Jws2Discoverer.getDiscoverer().setServiceUrls(services); } - - @Override - public Object getValueAt(int rowIndex, int columnIndex) + try { - if (rowIndex >= 0 && rowIndex < data.size()) + disc.run(); + } catch (Exception e) + { + System.err.println("Aborting. Problem discovering services."); + e.printStackTrace(); + return; + } + Jws2Instance lastserv = null; + for (Jws2Instance service : disc.getServices()) + { + lastserv = service; + if (p >= args.length || service.getName().equalsIgnoreCase(args[p])) { - Parameter prm = data.elementAt(rowIndex); - switch (columnIndex) + if (lastserv != null) { - case 0: - return prm.getName(); - case 1: - Object exc = null; - // the accessor name for the parameter value is possibly confusing - String val = prm.getDefaultValue(); - try + List prl = null; + Preset pr = null; + if (++p < args.length) { - if (prm.getValidValue().getType().equals(Type.Float)) + PresetManager prman = lastserv.getPresets(); + if (prman != null) { - exc = new Float(0); - return Float.parseFloat(val); + pr = prman.getPresetByName(args[p]); + if (pr == null) + { + // just grab the last preset. + prl = prman.getPresets(); + } } - if (prm.getValidValue().getType().equals(Type.Integer)) + } + else + { + PresetManager prman = lastserv.getPresets(); + if (prman != null) { - exc = new Integer(0); - return Integer.parseInt(val); + prl = prman.getPresets(); } - } catch (NumberFormatException e) - { - return exc; } - // must be a string - return val; + Iterator en = (prl == null) ? null : prl.iterator(); + while (en != null && en.hasNext()) + { + if (en != null) + { + if (!en.hasNext()) + { + en = prl.iterator(); + } + pr = en.next(); + } + { + System.out.println("Testing opts dupes for " + + lastserv.getUri() + " : " + lastserv.getActionText() + + ":" + pr.getName()); + List