/**
 * Copyright (C) 2001-2017 by RapidMiner and the contributors
 * 
 * Complete list of developers available at our web site:
 * 
 * http://rapidminer.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.learner.tree;

import java.util.List;

import com.rapidminer.example.Example;
import com.rapidminer.example.ExampleSet;
import com.rapidminer.example.set.ExampleSetUtilities;
import com.rapidminer.operator.Model;
import com.rapidminer.operator.OperatorException;
import com.rapidminer.operator.learner.SimplePredictionModel;
import com.rapidminer.operator.learner.meta.ConfidenceVoteModel;
import com.rapidminer.operator.learner.meta.MetaModel;
import com.rapidminer.operator.learner.meta.SimpleVoteModel;


/**
 * Random forest that can be configured to either use majority voting or confidence based voting for
 * its prediction.
 *
 * @author Michael Knopf
 * @since 7.0.0
 */
public class ConfigurableRandomForestModel extends SimplePredictionModel implements MetaModel {

	public enum VotingStrategy {
		MAJORITY_VOTE("majority vote"), CONFIDENCE_VOTE("confidence vote");

		private final String value;

		private VotingStrategy(String value) {
			this.value = value;
		}

		@Override
		public String toString() {
			return value;
		}
	}

	private static final long serialVersionUID = 1L;

	/** The wrapped voting meta model. */
	private final SimplePredictionModel model;

	public ConfigurableRandomForestModel(ExampleSet exampleSet, List<? extends TreeModel> models, VotingStrategy strategy) {
		super(exampleSet, ExampleSetUtilities.SetsCompareOption.EQUAL,
				ExampleSetUtilities.TypesCompareOption.ALLOW_SAME_PARENTS);
		switch (strategy) {
			case MAJORITY_VOTE:
				model = new SimpleVoteModel(exampleSet, models);
				break;
			default:
				model = new ConfidenceVoteModel(exampleSet, models);
		}
	}

	@Override
	public List<? extends Model> getModels() {
		return ((MetaModel) model).getModels();
	}

	@Override
	public List<String> getModelNames() {
		return ((MetaModel) model).getModelNames();
	}

	@Override
	public String getName() {
		return "Random Forest Model";
	}

	@Override
	public double predict(Example example) throws OperatorException {
		return model.predict(example);
	}

	@Override
	public String toString() {
		return model.toString();
	}

}