/*
 *  RapidMiner
 *
 *  Copyright (C) 2001-2011 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.parameter.conditions;

import org.w3c.dom.Element;

import com.rapidminer.io.process.XMLTools;
import com.rapidminer.parameter.ParameterHandler;
import com.rapidminer.tools.XMLException;

/**
 * This condition checks if a boolean parameter has a certain value.
 * 
 * @author Sebastian Land, Ingo Mierswa
 */
public class BooleanParameterCondition extends ParameterCondition {

    private static final String ELEMENT_CONDITION_VALUE = "ConditionValue";

    private boolean conditionValue;

    public BooleanParameterCondition(Element element) throws XMLException {
        super(element);

        conditionValue = Boolean.valueOf(XMLTools.getTagContents(element, ELEMENT_CONDITION_VALUE, true));
    }

    public BooleanParameterCondition(ParameterHandler parameterHandler, String conditionParameter, boolean becomeMandatory, boolean conditionValue) {
        super(parameterHandler, conditionParameter, becomeMandatory);
        this.conditionValue = conditionValue;
    }

    @Override
    public boolean isConditionFullfilled() {
        return parameterHandler.getParameterAsBoolean(conditionParameter) == conditionValue;
    }

    @Override
    public String toString() {
        return conditionParameter.replace('_',' ') + " = " + conditionValue;
    }

    @Override
    public void getDefinitionAsXML(Element element) {
        XMLTools.addTag(element, ELEMENT_CONDITION_VALUE, conditionParameter + "");
    }
}