ChoiceChartParam.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package com.xpn.xwiki.plugin.charts.params;

import java.util.HashMap;
import java.util.Map;

import com.xpn.xwiki.plugin.charts.exceptions.InvalidParamException;
import com.xpn.xwiki.plugin.charts.exceptions.ParamException;

public abstract class ChoiceChartParam extends AbstractChartParam
{
    protected Map choices = new HashMap();

    public ChoiceChartParam(String name)
    {
        super(name);
        init();
    }

    public ChoiceChartParam(String name, boolean isOptional)
    {
        super(name, isOptional);
        init();
    }

    public void addChoice(String selector, Object value)
    {
        choices.put(selector, value);
    }

    @Override
    public Object convert(String selector) throws ParamException
    {
        Object value = choices.get(selector);
        if (value != null) {
            return value;
        } else {
            throw new InvalidParamException("Invalid parameter value: " + "Accepted values for the " + getName()
                + " parameter are " + choices.keySet().toString() + "; encountered: " + selector);
        }
    }

    protected abstract void init();

    @Override
    public abstract Class getType();
}