Fix bug in GeneralOptimizationDialog related to sorting the optimization

parameters.  Switched to using a table row sorter instead of manually
sorting the array.
This commit is contained in:
kruland2607 2012-10-31 09:41:21 -05:00
parent 1d686c88e5
commit c9827cd5c1

View File

@ -48,6 +48,7 @@ import javax.swing.event.TreeSelectionListener;
import javax.swing.table.AbstractTableModel;
import javax.swing.table.DefaultTableCellRenderer;
import javax.swing.table.TableColumnModel;
import javax.swing.table.TableRowSorter;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.TreePath;
@ -96,7 +97,6 @@ import net.sf.openrocket.util.TextUtil;
import com.itextpdf.text.Font;
/**
* General rocket optimization dialog.
*
@ -108,7 +108,6 @@ public class GeneralOptimizationDialog extends JDialog {
private static final Collator collator = Collator.getInstance();
private static final String GOAL_MAXIMIZE = trans.get("goal.maximize");
private static final String GOAL_MINIMIZE = trans.get("goal.minimize");
private static final String GOAL_SEEK = trans.get("goal.seek");
@ -116,8 +115,6 @@ public class GeneralOptimizationDialog extends JDialog {
private static final String START_TEXT = trans.get("btn.start");
private static final String STOP_TEXT = trans.get("btn.stop");
private final List<OptimizableParameter> optimizationParameters = new ArrayList<OptimizableParameter>();
private final Map<Object, List<SimulationModifier>> simulationModifiers =
new HashMap<Object, List<SimulationModifier>>();
@ -126,7 +123,6 @@ public class GeneralOptimizationDialog extends JDialog {
private final OpenRocketDocument baseDocument;
private OpenRocketDocument documentCopy;
private final JButton addButton;
private final JButton removeButton;
private final JButton removeAllButton;
@ -136,10 +132,10 @@ public class GeneralOptimizationDialog extends JDialog {
private final DescriptionArea selectedModifierDescription;
private final SimulationModifierTree availableModifierTree;
private final JComboBox simulationSelectionCombo;
private final JComboBox optimizationParameterCombo;
private final JComboBox<Object> simulationSelectionCombo;
private final JComboBox<Object> optimizationParameterCombo;
private final JComboBox optimizationGoalCombo;
private final JComboBox<String> optimizationGoalCombo;
private final JSpinner optimizationGoalSpinner;
private final UnitSelector optimizationGoalUnitSelector;
private final DoubleModel optimizationSeekValue;
@ -177,7 +173,6 @@ public class GeneralOptimizationDialog extends JDialog {
/** The optimization worker that is running */
private OptimizationWorker worker = null;
private double bestValue = Double.NaN;
private Unit bestValueUnit = Unit.NOUNIT;
private int stepCount = 0;
@ -187,10 +182,8 @@ public class GeneralOptimizationDialog extends JDialog {
private final Map<Point, FunctionEvaluationData> evaluationHistory = new LinkedHashMap<Point, FunctionEvaluationData>();
private final List<Point> optimizationPath = new LinkedList<Point>();
private boolean updating = false;
/**
* Sole constructor.
*
@ -213,7 +206,6 @@ public class GeneralOptimizationDialog extends JDialog {
JPanel panel = new JPanel(new MigLayout("fill"));
ChangeListener clearHistoryChangeListener = new ChangeListener() {
@Override
public void stateChanged(ChangeEvent e) {
@ -227,8 +219,6 @@ public class GeneralOptimizationDialog extends JDialog {
}
};
// // Selected modifiers table
selectedModifierTableModel = new ParameterSelectionTableModel();
@ -237,6 +227,9 @@ public class GeneralOptimizationDialog extends JDialog {
selectedModifierTable.setRowSelectionAllowed(true);
selectedModifierTable.setColumnSelectionAllowed(false);
selectedModifierTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
TableRowSorter<ParameterSelectionTableModel> sorter = new TableRowSorter<ParameterSelectionTableModel>(selectedModifierTableModel);
sorter.setComparator(0, new SimulationModifierComparator());
selectedModifierTable.setRowSorter( sorter );
// Make sure spinner editor fits into the cell height
selectedModifierTable.setRowHeight(new JSpinner().getPreferredSize().height - 4);
@ -275,8 +268,6 @@ public class GeneralOptimizationDialog extends JDialog {
disableComponents.add(selectedModifierDescription);
panel.add(selectedModifierDescription, "growx");
// // Add/remove buttons
sub = new JPanel(new MigLayout("fill"));
@ -331,8 +322,6 @@ public class GeneralOptimizationDialog extends JDialog {
panel.add(sub);
// // Available modifier tree
availableModifierTree = new SimulationModifierTree(documentCopy.getRocket(), simulationModifiers, selectedModifiers);
availableModifierTree.getSelectionModel().addTreeSelectionListener(new TreeSelectionListener() {
@ -365,9 +354,6 @@ public class GeneralOptimizationDialog extends JDialog {
panel.add(label, "split 2, flowy");
panel.add(scroll, "width 300lp, height 200lp, grow, wrap para*2");
// // Optimization options sub-panel
sub = new JPanel(new MigLayout("fill"));
@ -376,7 +362,6 @@ public class GeneralOptimizationDialog extends JDialog {
sub.setBorder(border);
disableComponents.add(sub);
// // Simulation to optimize
label = new JLabel(trans.get("lbl.optimizeSim"));
@ -385,15 +370,13 @@ public class GeneralOptimizationDialog extends JDialog {
disableComponents.add(label);
sub.add(label, "");
simulationSelectionCombo = new JComboBox();
simulationSelectionCombo = new JComboBox<Object>();
simulationSelectionCombo.setToolTipText(tip);
populateSimulations();
simulationSelectionCombo.addActionListener(clearHistoryActionListener);
disableComponents.add(simulationSelectionCombo);
sub.add(simulationSelectionCombo, "growx, wrap unrel");
// // Value to optimize
label = new JLabel(trans.get("lbl.optimizeValue"));
tip = trans.get("lbl.optimizeValue.ttip");
@ -401,15 +384,13 @@ public class GeneralOptimizationDialog extends JDialog {
disableComponents.add(label);
sub.add(label, "");
optimizationParameterCombo = new JComboBox();
optimizationParameterCombo = new JComboBox<Object>();
optimizationParameterCombo.setToolTipText(tip);
populateParameters();
optimizationParameterCombo.addActionListener(clearHistoryActionListener);
disableComponents.add(optimizationParameterCombo);
sub.add(optimizationParameterCombo, "growx, wrap unrel");
// // Optimization goal
label = new JLabel(trans.get("lbl.optimizeGoal"));
tip = trans.get("lbl.optimizeGoal");
@ -417,14 +398,13 @@ public class GeneralOptimizationDialog extends JDialog {
disableComponents.add(label);
sub.add(label, "");
optimizationGoalCombo = new JComboBox(new String[] { GOAL_MAXIMIZE, GOAL_MINIMIZE, GOAL_SEEK });
optimizationGoalCombo = new JComboBox<String>(new String[] { GOAL_MAXIMIZE, GOAL_MINIMIZE, GOAL_SEEK });
optimizationGoalCombo.setToolTipText(tip);
optimizationGoalCombo.setEditable(false);
optimizationGoalCombo.addActionListener(clearHistoryActionListener);
disableComponents.add(optimizationGoalCombo);
sub.add(optimizationGoalCombo, "growx");
// // Optimization custom value
optimizationSeekValue = new DoubleModel(0, UnitGroup.UNITS_NONE);
optimizationSeekValue.addChangeListener(clearHistoryChangeListener);
@ -441,11 +421,8 @@ public class GeneralOptimizationDialog extends JDialog {
disableComponents.add(optimizationGoalUnitSelector);
sub.add(optimizationGoalUnitSelector, "width 20lp, wrap unrel");
panel.add(sub, "grow");
// // Required stability sub-panel
sub = new JPanel(new MigLayout("fill"));
@ -454,15 +431,12 @@ public class GeneralOptimizationDialog extends JDialog {
sub.setBorder(border);
disableComponents.add(sub);
double ref = CaliberUnit.calculateCaliber(baseDocument.getRocket());
minimumStability = new DoubleModel(ref, UnitGroup.stabilityUnits(ref));
maximumStability = new DoubleModel(5 * ref, UnitGroup.stabilityUnits(ref));
minimumStability.addChangeListener(clearHistoryChangeListener);
maximumStability.addChangeListener(clearHistoryChangeListener);
// // Minimum stability
tip = trans.get("lbl.requireMinStability.ttip");
minimumStabilitySelected = new JCheckBox(trans.get("lbl.requireMinStability"));
@ -488,7 +462,6 @@ public class GeneralOptimizationDialog extends JDialog {
disableComponents.add(minimumStabilityUnitSelector);
sub.add(minimumStabilityUnitSelector, "growx, wrap unrel");
// // Maximum stability
tip = trans.get("lbl.requireMaxStability.ttip");
maximumStabilitySelected = new JCheckBox(trans.get("lbl.requireMaxStability"));
@ -521,12 +494,8 @@ public class GeneralOptimizationDialog extends JDialog {
// disableComponents.add(desc);
// sub.add(desc, "span, growx");
panel.add(sub, "span 2, grow, wrap para*2");
// // Rocket figure
figure = new RocketFigure(getSelectedSimulation().getConfiguration());
figure.setBorderPixels(1, 1);
@ -534,10 +503,8 @@ public class GeneralOptimizationDialog extends JDialog {
figureScrollPane.setFitting(true);
panel.add(figureScrollPane, "span, split, height 200lp, grow");
sub = new JPanel(new MigLayout("fill"));
label = new JLabel(trans.get("status.bestValue"));
tip = trans.get("status.bestValue.ttip");
label.setToolTipText(tip);
@ -547,7 +514,6 @@ public class GeneralOptimizationDialog extends JDialog {
bestValueLabel.setToolTipText(tip);
sub.add(bestValueLabel, "wmin 60lp, wrap rel");
label = new JLabel(trans.get("status.stepCount"));
tip = trans.get("status.stepCount.ttip");
label.setToolTipText(tip);
@ -557,7 +523,6 @@ public class GeneralOptimizationDialog extends JDialog {
stepCountLabel.setToolTipText(tip);
sub.add(stepCountLabel, "wrap rel");
label = new JLabel(trans.get("status.evalCount"));
tip = trans.get("status.evalCount.ttip");
label.setToolTipText(tip);
@ -567,7 +532,6 @@ public class GeneralOptimizationDialog extends JDialog {
evaluationCountLabel.setToolTipText(tip);
sub.add(evaluationCountLabel, "wrap rel");
label = new JLabel(trans.get("status.stepSize"));
tip = trans.get("status.stepSize.ttip");
label.setToolTipText(tip);
@ -577,7 +541,6 @@ public class GeneralOptimizationDialog extends JDialog {
stepSizeLabel.setToolTipText(tip);
sub.add(stepSizeLabel, "wrap para");
// // Start/Stop button
startButton = new JToggleButton(START_TEXT);
@ -599,7 +562,6 @@ public class GeneralOptimizationDialog extends JDialog {
});
sub.add(startButton, "span, growx, wrap para*2");
plotButton = new JButton(trans.get("btn.plotPath"));
plotButton.setToolTipText(trans.get("btn.plotPath.ttip"));
plotButton.addActionListener(new ActionListener() {
@ -619,7 +581,6 @@ public class GeneralOptimizationDialog extends JDialog {
disableComponents.add(plotButton);
sub.add(plotButton, "span, growx, wrap");
saveButton = new JButton(trans.get("btn.save"));
saveButton.setToolTipText(trans.get("btn.save.ttip"));
saveButton.addActionListener(new ActionListener() {
@ -632,13 +593,8 @@ public class GeneralOptimizationDialog extends JDialog {
disableComponents.add(saveButton);
sub.add(saveButton, "span, growx");
panel.add(sub, "wrap para*2");
// // Bottom buttons
applyButton = new JButton(trans.get("btn.apply"));
@ -677,21 +633,18 @@ public class GeneralOptimizationDialog extends JDialog {
});
panel.add(closeButton, "right");
this.add(panel);
clearHistory();
updateComponents();
GUIUtil.setDisposableDialogOptions(this, null);
}
private void startOptimization() {
if (running) {
log.info("Optimization already running");
return;
}
if (selectedModifiers.isEmpty()) {
JOptionPane.showMessageDialog(this, trans.get("error.selectParams.text"),
trans.get("error.selectParams.title"), JOptionPane.ERROR_MESSAGE);
@ -702,7 +655,6 @@ public class GeneralOptimizationDialog extends JDialog {
return;
}
running = true;
// Update the button status
@ -761,7 +713,6 @@ public class GeneralOptimizationDialog extends JDialog {
maxAbsolute = true;
}
if (!minimumStabilitySelected.isSelected()) {
min = Double.NaN;
minAbsolute = maxAbsolute;
@ -862,7 +813,6 @@ public class GeneralOptimizationDialog extends JDialog {
};
worker.start();
clearHistory();
updateComponents();
@ -889,13 +839,9 @@ public class GeneralOptimizationDialog extends JDialog {
startButton.setText(START_TEXT);
updating = false;
updateComponents();
}
/**
* Reset the current optimization history and values. This does not reset the design.
*/
@ -911,7 +857,6 @@ public class GeneralOptimizationDialog extends JDialog {
updateComponents();
}
private void applyDesign() {
// TODO: MEDIUM: Apply also potential changes to simulations
Rocket src = getSelectedSimulation().getRocket().copyWithOriginalID();
@ -938,7 +883,6 @@ public class GeneralOptimizationDialog extends JDialog {
}
}
private void resetDesign() {
clearHistory();
@ -969,7 +913,6 @@ public class GeneralOptimizationDialog extends JDialog {
availableModifierTree.populateTree(documentCopy.getRocket(), simulationModifiers);
availableModifierTree.expandComponents();
// Update selectable simulations
populateSimulations();
@ -978,7 +921,6 @@ public class GeneralOptimizationDialog extends JDialog {
}
private void populateSimulations() {
String current = null;
Object selection = simulationSelectionCombo.getSelectedItem();
@ -986,7 +928,6 @@ public class GeneralOptimizationDialog extends JDialog {
current = selection.toString();
}
List<Named<Simulation>> simulations = new ArrayList<Named<Simulation>>();
Rocket rocket = documentCopy.getRocket();
@ -1006,14 +947,13 @@ public class GeneralOptimizationDialog extends JDialog {
simulations.add(new Named<Simulation>(sim, name));
}
Simulation sim = new Simulation(rocket);
sim.getConfiguration().setFlightConfigurationID(null);
String name = createSimulationName(trans.get("noSimulationName"), rocket.getFlightConfigurationNameOrDescription(null));
simulations.add(new Named<Simulation>(sim, name));
simulationSelectionCombo.setModel(new DefaultComboBoxModel(simulations.toArray()));
simulationSelectionCombo.setModel(new DefaultComboBoxModel<Object>(simulations.toArray()));
simulationSelectionCombo.setSelectedIndex(0);
if (current != null) {
for (int i = 0; i < simulations.size(); i++) {
@ -1025,7 +965,6 @@ public class GeneralOptimizationDialog extends JDialog {
}
}
private void populateParameters() {
String current = null;
Object selection = optimizationParameterCombo.getSelectedItem();
@ -1041,7 +980,7 @@ public class GeneralOptimizationDialog extends JDialog {
parameters.add(new Named<OptimizableParameter>(p, p.getName()));
}
optimizationParameterCombo.setModel(new DefaultComboBoxModel(parameters.toArray()));
optimizationParameterCombo.setModel(new DefaultComboBoxModel<Object>(parameters.toArray()));
for (int i = 0; i < parameters.size(); i++) {
if (parameters.get(i).toString().equals(current)) {
@ -1058,7 +997,6 @@ public class GeneralOptimizationDialog extends JDialog {
stepSizeLabel.setText(UnitGroup.UNITS_RELATIVE.toStringUnit(stepSize));
}
private void loadOptimizationParameters() {
optimizationParameters.clear();
optimizationParameters.addAll(OptimizationServiceHelper.getOptimizableParameters(documentCopy));
@ -1075,7 +1013,6 @@ public class GeneralOptimizationDialog extends JDialog {
});
}
private void loadSimulationModifiers() {
simulationModifiers.clear();
@ -1101,13 +1038,10 @@ public class GeneralOptimizationDialog extends JDialog {
}
private void addModifier(SimulationModifier mod) {
if (!selectedModifiers.contains(mod)) {
log.user(1, "Adding simulation modifier " + mod);
selectedModifiers.add(mod);
Collections.sort(selectedModifiers, new SimulationModifierComparator());
selectedModifierTableModel.fireTableDataChanged();
availableModifierTree.repaint();
} else {
@ -1115,7 +1049,6 @@ public class GeneralOptimizationDialog extends JDialog {
}
}
private void removeModifier(SimulationModifier mod) {
log.user(1, "Removing simulation modifier " + mod);
selectedModifiers.remove(mod);
@ -1123,8 +1056,6 @@ public class GeneralOptimizationDialog extends JDialog {
availableModifierTree.repaint();
}
/**
* Update the enabled status of all components in the dialog.
*/
@ -1140,7 +1071,6 @@ public class GeneralOptimizationDialog extends JDialog {
updating = true;
// First enable all components if optimization not running
if (!running) {
log.debug("Initially enabling all components");
@ -1149,7 +1079,6 @@ public class GeneralOptimizationDialog extends JDialog {
}
}
// "Add" button
SimulationModifier mod = getSelectedAvailableModifier();
state = (mod != null && !selectedModifiers.contains(mod));
@ -1166,7 +1095,6 @@ public class GeneralOptimizationDialog extends JDialog {
log.debug("removeAllButton enabled: " + state);
removeAllButton.setEnabled(state);
// Optimization goal
String selected = (String) optimizationGoalCombo.getSelectedItem();
state = GOAL_SEEK.equals(selected);
@ -1174,7 +1102,6 @@ public class GeneralOptimizationDialog extends JDialog {
optimizationGoalSpinner.setVisible(state);
optimizationGoalUnitSelector.setVisible(state);
// Minimum/maximum stability options
state = minimumStabilitySelected.isSelected();
log.debug("minimumStabilitySpinner & UnitSelector enabled: " + state);
@ -1186,7 +1113,6 @@ public class GeneralOptimizationDialog extends JDialog {
maximumStabilitySpinner.setEnabled(state);
maximumStabilityUnitSelector.setEnabled(state);
// Plot button (enabled if path exists and dimensionality is 1 or 2)
state = (!optimizationPath.isEmpty() && (selectedModifiers.size() == 1 || selectedModifiers.size() == 2));
log.debug("plotButton enabled: " + state + " optimizationPath.isEmpty=" + optimizationPath.isEmpty() +
@ -1198,7 +1124,6 @@ public class GeneralOptimizationDialog extends JDialog {
log.debug("saveButton enabled: " + state);
saveButton.setEnabled(state);
// Last disable all components if optimization is running
if (running) {
log.debug("Disabling all components because optimization is running");
@ -1207,7 +1132,6 @@ public class GeneralOptimizationDialog extends JDialog {
}
}
// Update description text
mod = getSelectedModifier();
if (mod != null) {
@ -1216,14 +1140,12 @@ public class GeneralOptimizationDialog extends JDialog {
selectedModifierDescription.setText("");
}
// Update the figure
figure.setConfiguration(getSelectedSimulation().getConfiguration());
updating = false;
}
private void savePath() {
if (evaluationHistory.isEmpty()) {
@ -1282,7 +1204,6 @@ public class GeneralOptimizationDialog extends JDialog {
writer.write("\n");
}
for (FunctionEvaluationData data : evaluationHistory.values()) {
Value[] state = data.getState();
@ -1347,7 +1268,6 @@ public class GeneralOptimizationDialog extends JDialog {
return ((Named<Simulation>) item).get();
}
/**
* Return the currently selected simulation modifier from the table,
* or <code>null</code> if none selected.
@ -1362,7 +1282,6 @@ public class GeneralOptimizationDialog extends JDialog {
return selectedModifiers.get(row);
}
/**
* Return the currently selected optimization parameter.
* @return the selected optimization parameter.
@ -1372,7 +1291,6 @@ public class GeneralOptimizationDialog extends JDialog {
return ((Named<OptimizableParameter>) optimizationParameterCombo.getSelectedItem()).get();
}
private Unit getModifierUnit(int index) {
return selectedModifiers.get(index).getUnitGroup().getDefaultUnit();
}
@ -1524,7 +1442,6 @@ public class GeneralOptimizationDialog extends JDialog {
}
private class DoubleCellRenderer extends DefaultTableCellRenderer {
@Override
public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected,
@ -1590,6 +1507,4 @@ public class GeneralOptimizationDialog extends JDialog {
}
}
}