/*
* 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.io;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.LinkedList;
import java.util.List;
import com.rapidminer.example.Attribute;
import com.rapidminer.example.AttributeParser;
import com.rapidminer.example.ExampleSet;
import com.rapidminer.operator.IOObject;
import com.rapidminer.operator.Operator;
import com.rapidminer.operator.OperatorDescription;
import com.rapidminer.operator.OperatorException;
import com.rapidminer.operator.UserError;
import com.rapidminer.parameter.ParameterType;
import com.rapidminer.parameter.ParameterTypeBoolean;
import com.rapidminer.parameter.ParameterTypeFile;
/**
* Loads an attribute set from a file and constructs the desired features. If
* keep_all is false, original attributes are deleted before the new ones are
* created. This also means that a feature selection is performed if only a
* subset of the original features was given in the file.
*
* @author Ingo Mierswa
* @version $Id: AttributeConstructionsLoader.java,v 1.12 2006/04/05 08:57:25 ingomierswa
* Exp $
*/
public class AttributeConstructionsLoader extends Operator {
/** The parameter name for "Filename for the attribute constructions file." */
public static final String PARAMETER_ATTRIBUTE_CONSTRUCTIONS_FILE = "attribute_constructions_file";
/** The parameter name for "If set to true, all the original attributes are kept, otherwise they are removed from the example set." */
public static final String PARAMETER_KEEP_ALL = "keep_all";
private static final Class[] INPUT_CLASSES = { ExampleSet.class };
private static final Class[] OUTPUT_CLASSES = { ExampleSet.class };
public AttributeConstructionsLoader(OperatorDescription description) {
super(description);
}
/** Loads the attribute set from a file and constructs desired features. */
public IOObject[] apply() throws OperatorException {
ExampleSet exampleSet = (ExampleSet) getInput(ExampleSet.class).clone();
boolean keepAll = getParameterAsBoolean(PARAMETER_KEEP_ALL);
List<Attribute> oldAttributes = new LinkedList<Attribute>();
for (Attribute attribute : exampleSet.getAttributes()) {
oldAttributes.add(attribute);
}
File file = getParameterAsFile(PARAMETER_ATTRIBUTE_CONSTRUCTIONS_FILE);
if (file != null) {
AttributeParser parser = new AttributeParser(exampleSet.getExampleTable());
InputStream in = null;
try {
in = new FileInputStream(file);
parser.generateAll(this, exampleSet, in);
} catch (java.io.IOException e) {
throw new UserError(this, e, 302, new Object[] { file.getName(), e.getMessage() });
} finally {
if (in != null) {
try {
in.close();
} catch (IOException e) {
logError("Cannot close stream to file " + file);
}
}
}
}
if (!keepAll) {
for (Attribute oldAttribute : oldAttributes) {
exampleSet.getAttributes().remove(oldAttribute);
}
}
return new IOObject[] { exampleSet };
}
public Class<?>[] getInputClasses() {
return INPUT_CLASSES;
}
public Class<?>[] getOutputClasses() {
return OUTPUT_CLASSES;
}
public List<ParameterType> getParameterTypes() {
List<ParameterType> types = super.getParameterTypes();
types.add(new ParameterTypeFile(PARAMETER_ATTRIBUTE_CONSTRUCTIONS_FILE, "Filename for the attribute constructions file.", "att", false));
types.add(new ParameterTypeBoolean(PARAMETER_KEEP_ALL, "If set to true, all the original attributes are kept, otherwise they are removed from the example set.", false));
return types;
}
}