/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2008, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library 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
* Lesser General Public License for more details.
*/
package org.geotools.swing.process;
import java.awt.GridLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JPanel;
import org.geotools.data.Parameter;
import org.geotools.process.ProcessFactory;
import org.geotools.swing.wizard.JDoubleField;
import org.geotools.swing.wizard.JField;
import org.geotools.swing.wizard.JGeometryField;
import org.geotools.swing.wizard.JPage;
import org.geotools.swing.wizard.ParamField;
import org.opengis.feature.type.Name;
import com.vividsolutions.jts.geom.Geometry;
/**
* This page is responsible making a user interface based on the provided ProcessFactory.
*
* @author Jody, gdavis
* @since 8.0
*
* @source $URL$
* @version $Id$
*/
public class ProcessParameterPage extends JPage {
/**
* The selected factory we are working on.
*/
ProcessFactory factory;
/**
* Name of the process we are working with.
*/
Name name;
/**
* The user supplied input parameters.
*/
Map<String, Object> input;
// map of ParamField to keys, but value is a list of ParamFields
Map<String, List<ParamField>> fields = new HashMap<String, List<ParamField>>();
// map of keys with values for the input parameters, the value is a list of "values"
Map<String, Object> paramMap = null;
public ProcessParameterPage(ProcessFactory factory) {
this(factory, null);
}
public ProcessParameterPage(ProcessFactory factory, Map<String, Object> input) {
super("Enter Params");
this.factory = factory;
}
public void setProcessFactory(ProcessFactory factory) {
this.factory = factory;
}
public ProcessFactory getProcessFactory() {
return this.factory;
}
public String getBackPageIdentifier() {
return "select";
}
public String getNextPageIdentifier() {
createParamMap();
// validate the params first...
// if (paramMap == null) {
// return null;
// }
ProcessRunPage resultPage = new ProcessRunPage(factory, paramMap);
this.getJWizard().registerWizardPanel(resultPage);
return resultPage.getPageIdentifier();
}
/**
* Run through the current values in the widgets and make a process param map out of them for
* running an actual process
*/
private void createParamMap() {
if (fields.size() == 0) {
return;
}
paramMap = new HashMap<String, Object>();
for (String key : fields.keySet()) {
List<ParamField> pws = (List<ParamField>) (fields.get(key));
if (pws.size() > 1) {
// param has a list of values from multiple widgets
List<Object> values = new ArrayList<Object>();
for (ParamField pw : pws) {
if (pw.getValue() != null) {
values.add(pw.getValue());
}
}
paramMap.put(key, values);
} else { // only a single value/widget
ParamField ParamField = pws.get(0);
if (ParamField.getValue() != null) {
paramMap.put(key, ParamField.getValue());
}
}
}
}
public void preDisplayPanel() {
JPanel page = getPanel();
page.removeAll();
page.setLayout(new GridLayout(0, 2));
JLabel title = new JLabel(factory.getTitle().toString());
page.add(title);
JLabel description = new JLabel(factory.getDescription(name).toString());
page.add(description);
for (Entry<String, Parameter<?>> entry : factory.getParameterInfo(name).entrySet()) {
Parameter<?> parameter = entry.getValue();
// if the minOccurs of the param is -1, it can be any number so default
// with 1 for now.
int min = parameter.minOccurs;
if (min < 1)
min = 1;
// if the maxOccurs of the parameter is -1, then it can have any number
// of widgets equal to or greater than the minOccurs. So add + buttons
if (parameter.maxOccurs == -1) {
createAddButton(parameter);
}
// create a list for the widgets this parameter (even if there is only
// one widget)
List<ParamField> widgets = new ArrayList<ParamField>();
// loop through and create the min number of widgets for this param
for (int i = 0; i < min; i++) {
ParamField newWidget = createNewField(parameter, true);
widgets.add(newWidget);
}
// add the widget(s) to the fields map
fields.put(parameter.key, widgets);
}
}
private void createAddButton(final Parameter<?> parameter) {
JPanel page = getPanel();
JLabel buttLabel;
buttLabel = new JLabel("Press '+' to add a new " + parameter.title + " field: ");
page.add(buttLabel);
JButton butt = new JButton("+");
butt.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
createNewField(parameter, true);
}
});
page.add(butt);
}
/**
* Create a new widget and label for the given parameter
*
* @param parameter
* @param resize whether to resize the wizard after adding or not
*/
private ParamField createNewField(Parameter<?> parameter, boolean resize) {
JPanel page = getPanel();
JLabel label;
label = new JLabel(parameter.title.toString());
page.add(label);
ParamField widget;
if (Double.class.isAssignableFrom(parameter.type)) {
widget = new JDoubleField(parameter);
} else if (Geometry.class.isAssignableFrom(parameter.type)) {
widget = new JGeometryField(parameter);
} else {
// We got nothing special, let's hope the converter api can deal
widget = new JField(parameter);
}
JComponent field = widget.doLayout();
page.add(field);
page.validate();
// resize the wizard to fit new component
if (resize) {
getJWizard().pack();
getJWizard().validate();
}
return widget;
}
}