/*
 *  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.preprocessing.filter;

import java.util.List;

import com.rapidminer.example.Attribute;
import com.rapidminer.example.AttributeRole;
import com.rapidminer.operator.OperatorDescription;
import com.rapidminer.operator.OperatorException;
import com.rapidminer.parameter.ParameterType;
import com.rapidminer.parameter.ParameterTypeCategory;
import com.rapidminer.tools.Ontology;


/**
 * This operator switches off all features whose block type matches the one
 * given in the parameter <code>skip_features_of_type</code>. This can be
 * useful e.g. for preprocessing operators that can handle only series
 * attributes.
 * 
 * @author Buelent Moeller, Ingo Mierswa
 * @version $Id: FeatureBlockTypeFilter.java,v 1.7 2006/04/05 08:57:27
 *          ingomierswa Exp $
 */
public class FeatureBlockTypeFilter extends FeatureFilter {

	/** The parameter name for "All features of this type will be deselected off." */
	public static final String PARAMETER_SKIP_FEATURES_OF_TYPE = "skip_features_of_type";

	/** The parameter name for "All features of this type will not be deselected." */
	public static final String PARAMETER_EXCEPT_FEATURES_OF_TYPE = "except_features_of_type";
	
	public FeatureBlockTypeFilter(OperatorDescription description) {
		super(description);
	}

	/**
	 * Implements the method required by the superclass. For features whose type
	 * is a subtype of the one given as a parameter for this operator, TRUE is
	 * returned (otherwise FALSE). If no parameter was provided, FALSE is always
	 * returned, so no feature is switched off.
	 * 
	 * @param role
	 *            Feature to check.
	 * @return TRUE if this feature should <b>not</b> be active in the output
	 *         example set of this operator. FALSE otherwise.
	 */
	public boolean switchOffFeature(AttributeRole role) throws OperatorException {
		Attribute feature = role.getAttribute();
		
        // first type (most general) was omitted in parameters 
		int type = getParameterAsInt(PARAMETER_SKIP_FEATURES_OF_TYPE) + 1;
                
        int exceptionType = getParameterAsInt(PARAMETER_EXCEPT_FEATURES_OF_TYPE);
        if (exceptionType == 0) {
            return Ontology.ATTRIBUTE_BLOCK_TYPE.isA(feature.getBlockType(), type);
        } else {
            return 
                Ontology.ATTRIBUTE_BLOCK_TYPE.isA(feature.getBlockType(), type) &&
                !Ontology.ATTRIBUTE_BLOCK_TYPE.isA(feature.getBlockType(), exceptionType);
        }
	}

	public List<ParameterType> getParameterTypes() {
		List<ParameterType> types = super.getParameterTypes();
        // omitt first (most general) type
		String[] blockTypes = new String[Ontology.BLOCK_TYPE_NAMES.length - 1];
		for (int i = 0; i < blockTypes.length; i++)
			blockTypes[i] = Ontology.BLOCK_TYPE_NAMES[i + 1];
        
		ParameterType type = new ParameterTypeCategory(PARAMETER_SKIP_FEATURES_OF_TYPE, "All features of this type will be deselected off.", blockTypes, 0);
		type.setExpert(false);
		types.add(type);
        
        String[] exceptionBlockTypes = new String[blockTypes.length + 1];
        exceptionBlockTypes[0] = "none";
        System.arraycopy(blockTypes, 0, exceptionBlockTypes, 1, blockTypes.length);
        types.add(new ParameterTypeCategory(PARAMETER_EXCEPT_FEATURES_OF_TYPE, "All features of this type will not be deselected.", exceptionBlockTypes, 0));
		return types;
	}
}