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

import org.w3c.dom.Element;

import com.rapidminer.tools.XMLException;

/**
 * Helper class for GUI purposes. This parameter type should hold information
 * about other inner operator names, e.g. for the definition of the inner operator
 * of the OperatorEnabler operator.
 * 
 * @author Ingo Mierswa
 */
public class ParameterTypeInnerOperator extends ParameterTypeSingle {

    private static final long serialVersionUID = -8428679832770835634L;

    public ParameterTypeInnerOperator(Element element) throws XMLException {
        super(element);
        setOptional(false);
    }

    public ParameterTypeInnerOperator(String key, String description) {
        super(key, description);
        setOptional(false);
    }

    /** Returns null. */
    @Override
    public Object getDefaultValue() {
        return null;
    }

    /** Does nothing. */
    @Override
    public void setDefaultValue(Object defaultValue) {}

    @Override
    public String getRange() {
        return "inner operator names";
    }

    /** Returns false. */
    @Override
    public boolean isNumerical() { return false; }

    @Override
    public String notifyOperatorRenaming(String oldOperatorName, String newOperatorName, String parameterValue) {
        if (oldOperatorName.equals(parameterValue))
            return newOperatorName;
        return parameterValue;
    }

    @Override
    protected void writeDefinitionToXML(Element typeElement) {
    }
}