/*
* RapidMiner
*
* Copyright (C) 2001-2008 by Rapid-I and the contributors
*
* Complete list of developers available at our web site:
*
* http://rapid-i.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*/
package com.rapidminer.operator.meta;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.nio.charset.Charset;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import javax.swing.Icon;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
import com.rapidminer.Process;
import com.rapidminer.RapidMiner;
import com.rapidminer.gui.tools.SwingTools;
import com.rapidminer.operator.Operator;
import com.rapidminer.operator.ResultObjectAdapter;
import com.rapidminer.operator.performance.PerformanceVector;
import com.rapidminer.tools.Tools;
/**
* A set of parameters generated by a <code>ParameterOptimizationOperator</code>.
*
* @author Simon Fischer, Ingo Mierswa
* @version $Id: ParameterSet.java,v 1.11 2008/07/11 09:52:56 ingomierswa Exp $
*/
public class ParameterSet extends ResultObjectAdapter {
private static final long serialVersionUID = -2615523039124583537L;
private static final String RESULT_ICON_NAME = "preferences.png";
private static Icon resultIcon = null;
static {
resultIcon = SwingTools.createIcon("16/" + RESULT_ICON_NAME);
}
private List<ParameterValue> parameterValues = new LinkedList<ParameterValue>();
private PerformanceVector performance;
/** Private constructor for the read() method. */
private ParameterSet() {}
/**
* Constructs a new ParameterSet. The three arrays must have equal length.
* For each <i>i</i>, the ParameterSet specifies the value
* <code>values[i]</code> for the parameter <code>parameters[i]</code>
* of the operator named <code>operators[i]</code>.
*/
public ParameterSet(Operator[] operators, String[] parameters, String[] values, PerformanceVector value) {
if ((operators.length != parameters.length) || (operators.length != values.length)) {
throw new IllegalArgumentException("The arrays operators, parameters, and values must be of equal size!");
}
for (int i = 0; i < operators.length; i++) {
parameterValues.add(new ParameterValue(operators[i].getName(), parameters[i], values[i]));
}
this.performance = value;
}
public String getName() {
return "ParameterSet";
}
public String toString() {
StringBuffer str = new StringBuffer("Parameter set:" + Tools.getLineSeparator());
str.append(Tools.getLineSeparator() + "Performance: " + performance + Tools.getLineSeparator());
Iterator i = parameterValues.iterator();
while (i.hasNext()) {
str.append(i.next().toString() + Tools.getLineSeparator());
}
return str.toString();
}
/**
* Returns the performance of this parameter set. Attension: This may be
* null if the ParameterSet was read from a file.
*/
public PerformanceVector getPerformance() {
return performance;
}
/**
* Applies all parameters in the set to their operators. The entries in the
* nameMap can be used if the names of the operators in two processes (one
* parameter optimization process and one application process) are not
* the same. Each entry in nameMap maps the name read from the file to the
* name of the operator in the process definition.
*/
public void applyAll(Process process, Map nameMap) {
Iterator i = parameterValues.iterator();
while (i.hasNext()) {
((ParameterValue) i.next()).apply(process, nameMap);
}
}
public void save(File file) throws IOException {
PrintWriter out = null;
try {
out = new PrintWriter(new FileWriter(file));
writeParameterSet(out, Tools.getDefaultEncoding());
} catch (IOException e) {
throw e;
} finally {
if (out != null) {
out.close();
}
}
}
public String getExtension() { return "par"; }
public String getFileDescription() { return "parameter set file"; }
public Iterator<ParameterValue> getParameterValues() {
return this.parameterValues.iterator();
}
public void writeParameterSet(PrintWriter out, Charset encoding) {
out.println("<?xml version=\"1.0\" encoding=\"" + encoding + "\"?>");
out.println("<parameterset version=\"" + RapidMiner.getShortVersion() + "\">");
Iterator<ParameterValue> i = parameterValues.iterator();
while (i.hasNext()) {
ParameterValue value = i.next();
out.println(" <parameter operator=\"" + value.getOperator() + "\" key=\"" + value.getParameterKey() + "\" value=\"" + value.getParameterValue() + "\"/>");
}
out.println("</parameterset>");
}
/** Reads a parameter set from a file. */
public static ParameterSet readParameterSet(InputStream in) throws IOException {
ParameterSet parameterSet = new ParameterSet();
Document document = null;
try {
document = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(in);
} catch (SAXException e1) {
throw new IOException(e1.getMessage());
} catch (ParserConfigurationException e1) {
throw new IOException(e1.getMessage());
}
Element parametersElement = document.getDocumentElement();
if (!parametersElement.getTagName().equals("parameterset")) {
throw new IOException("Outer tag of parameter set file must be <parameterset>");
}
NodeList parameters = parametersElement.getChildNodes();
for (int i = 0; i < parameters.getLength(); i++) {
Node node = parameters.item(i);
if (node instanceof Element) {
Element parameterTag = (Element)node;
String tagName = parameterTag.getTagName();
if (!tagName.equals("parameter"))
throw new IOException("Only tags <parameter> are allowed, was " + tagName);
String operatorName = parameterTag.getAttribute("operator");
String parameterKey = parameterTag.getAttribute("key");
String parameterValue = parameterTag.getAttribute("value");
parameterSet.parameterValues.add(new ParameterValue(operatorName, parameterKey, parameterValue));
}
}
return parameterSet;
}
public Icon getResultIcon() {
return resultIcon;
}
}