root/tools/routingservice/trunk/src/jp/co/orkney/restlet/util/Parameter.java

package jp.co.orkney.restlet.util;

import org.jdom.Element;

/**
 * Copyright (c) 2007 Orkney, Inc. <http://www.orkney.co.jp/>
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * <b>Parameter is a class which represents a parameter.</b>
 * <p>
 * A parameter is characterized by the following information:
 * <ul>
 * <li>A name</li>
 * <li>A type (integer,text,boolean, ...)</li>
 * <li>A code name (used in GET and POST request)</li>
 * <li>A boolean determining whether this parameter is required for its parent
 * service.</li>
 * <li>A default value</li>
 * <li>A current value</li>
 * </ul>
 * </p>
 * 
 * @author Matthieu Bilbille - Orkney Inc.
 * @version 1.0
 */
public class Parameter
{
    private String name;

    private String type;

    private String codeName;

    private boolean isRequired;

    private String defaultValue;

    private String value;

    /**
         * Constructor Parameter.
         * <p>
         * Creates a new parameter with empty data (name,type,...); "isRequired"
         * is initialized with FALSE value
         * </p>
         */
    public Parameter()
    {
        name = "";
        type = "";
        codeName = "";
        isRequired = false;
        defaultValue = "";
        value = "";
    }

    public Parameter(Element parameter)
    {
        this.name = parameter.getAttributeValue("name");
        this.type = parameter.getAttributeValue("type");
        this.codeName = parameter.getAttributeValue("codename");
        this.isRequired = new Boolean(parameter.getAttributeValue("required"));
        this.defaultValue = parameter.getAttributeValue("default");
        this.value = parameter.getAttributeValue("default");
    }

    /**
         * Constructor Parameter.
         * <p>
         * Creates a new parameter with the specified data (name,type,...). The
         * value of the parameter is initialized with its default value
         * </p>
         * 
         * @param name
         *                parameter name
         * @param type
         *                parameter type
         * @param codeName
         *                parameter codeName
         * @param isRequired
         *                boolean determining whether this parameter is required
         *                for its parent service.
         * @param defaultValue
         *                parameter default value
         */
    public Parameter(String name, String type, String codeName,
            boolean isRequired, String defaultValue)
    {
        this.name = name;
        this.type = type;
        this.codeName = codeName;
        this.isRequired = isRequired;
        this.defaultValue = defaultValue;
        this.value = defaultValue;
    }

    /**
         * Gets the value of the parameter
         * 
         * @return this parameter's value
         */
    public String getValue()
    {
        return value;
    }

    /**
         * Sets the value of the parameter to the specified string.
         * 
         * @param value
         *                the string that is to be this parameter's value
         */
    public void setValue(String value)
    {
        this.value = value;
    }

    /**
         * Gets the name of the parameter
         * 
         * @return this parameter's name
         */
    public String getName()
    {
        return name;
    }

    /**
         * Sets the name of the parameter to the specified string.
         * 
         * @param name
         *                the string that is to be this parameter's name
         */
    public void setName(String name)
    {
        this.name = name;
    }

    /**
         * Gets the type of the parameter
         * 
         * @return this parameter's name
         */
    public String getType()
    {
        return type;
    }

    /**
         * Sets the type of the parameter to the specified string.
         * 
         * @param type
         *                the string that is to be this parameter's type
         */
    public void setType(String type)
    {
        this.type = type;
    }

    /**
         * Gets the code name of the parameter
         * 
         * @return this parameter's code name
         */
    public String getCodeName()
    {
        return codeName;
    }

    /**
         * Sets the code name of the parameter to the specified string.
         * 
         * @param codeName
         *                the string that is to be this parameter's code name
         */
    public void setCodeName(String codeName)
    {
        this.codeName = codeName;
    }

    /**
         * Returns whether this parameter is required for its parent service.
         * 
         * @return true if this parameter is required; false otherwise
         */
    public boolean isRequired()
    {
        return isRequired;
    }

    /**
         * Sets required or not required this parameter. A required parameter is
         * needed to launch its parent service. Parameters are not required
         * initially by default.
         * 
         * @param isRequired
         *                if true, this parameter is required; otherwise it is
         *                optional
         */
    public void setRequired(boolean isRequired)
    {
        this.isRequired = isRequired;
    }

    /**
         * Gets the default value of the parameter
         * 
         * @return this parameter's default value
         */
    public String getDefaultValue()
    {
        return defaultValue;
    }

    /**
         * Sets the default value of the parameter to the specified string.
         * 
         * @param defaultValue
         *                the string that is to be this parameter's default
         *                value
         */
    public void setDefaultValue(String defaultValue)
    {
        this.defaultValue = defaultValue;
    }
}