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

package jp.co.orkney.restlet.util;

/**
 * Copyright (c) 2008 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/>.
 */

import java.util.Vector;

/**
 * <b>Service is a class which represents a service.</b>
 * <p>
 * A service is characterized by the following information:
 * <ul>
 * <li>A name</li>
 * <li>A data projection</li>
 * <li>An array of SQL queries</li>
 * <li>A boolean to enable or disable the service</li>
 * <li>A vector containing its parameters</li>
 * <li>A vector containing all formats available for this service</li>
 * <li>A database access configuration (DatabaseConfiguration object)</li>
 * </ul>
 * </p>
 * 
 * @author Matthieu Bilbille - Orkney Inc.
 * @version 1.0
 * @see DatabaseConfiguration
 */
public class Service
{
        private static int nbr_query = 4;
        private String name;
        private String dataProjection;
        private String units;
        private String sqlQuery[];
        private boolean isEnable;
        private Vector<Parameter> parameters;
        private Vector<Format> formats;
        private DatabaseConfiguration databaseConfiguration;
        private Limit limit;

        /**
         * Constructor Service.
         * <p>
         * Creates a new service with empty data (name,projection,...); "isEnable"
         * is initialized with FALSE value
         * </p>
         */
        public Service()
        {
                name = "";
                dataProjection = "";
                sqlQuery = new String[nbr_query];
                isEnable = false;
                parameters = new Vector<Parameter>();
                formats = new Vector<Format>();
                databaseConfiguration = new DatabaseConfiguration();
                limit = new Limit();
        }

        /**
         * Constructor Service
         * <p>
         * Makes a copy of an UnService object with new references.
         * </p>
         * 
         * @param name
         *            service name
         * @param dataProjection
         *            service data projection code
         * @param sqlQuery
         *            service SQL queries
         * @param isEnable
         *            boolean to enable or disable the service
         * @param parameters
         *            service parameters
         * @param formats
         *            service formats
         * @param databaseConfiguration
         *            service database configuratio * To do these steps, ShortestPath class calls some method in IOHelper and DatabaseConnectionn
         */
        public Service(String name, String dataProjection, String[] sqlQuery, boolean isEnable, Vector<Parameter> parameters, Vector<Format> formats,
                        DatabaseConfiguration databaseConfiguration, Limit limit)
        {
                this.name = name;
                this.dataProjection = dataProjection;
                this.sqlQuery = sqlQuery;
                this.isEnable = isEnable;
                this.parameters = new Vector<Parameter>();
                Parameter tmpParameter = new Parameter();
                if (parameters != null)
                {
                        for (int i = 0; i < parameters.size(); i++)
                        {
                                tmpParameter = parameters.get(i);
                                this.parameters.add(new Parameter(tmpParameter.getName(), tmpParameter.getType(), tmpParameter.getCodeName(), tmpParameter
                                                .isRequired(), tmpParameter.getDefaultValue()));
                        }
                }
                //TODO why we can't just assign this.formats = formats ?
                this.formats = new Vector<Format>();
                Format tmpFormat = new Format();
                if (formats != null)
                {
                        for (int i = 0; i < formats.size(); i++)
                        {
                                tmpFormat = formats.get(i);
                                this.formats.add(new Format(tmpFormat.getName(), tmpFormat.getSrid(), tmpFormat.isEnableInput(), tmpFormat.isEnableOutput()));
                        }
                }
                this.databaseConfiguration = new DatabaseConfiguration(databaseConfiguration.getDriver(), databaseConfiguration.getURL(),
                                databaseConfiguration.getUser(), databaseConfiguration.getPassword());
                this.limit = limit;
        }

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

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

        /**
         * Determines whether this service is enabled. A service may be enabled or
         * disabled by calling its setEnable method.
         * 
         * @return true if the service is enabled, false otherwise
         */
        public boolean isEnable()
        {
                return isEnable;
        }

        /**
         * Enables or disables this service. Services are disabled initially by
         * default.
         * 
         * @param isEnable
         *            if true, this service is enabled; otherwise this service is
         *            disabled
         */
        public void setEnable(boolean isEnable)
        {
                this.isEnable = isEnable;
        }

        /**
         * Gets the database configuration of the service
         * 
         * @return this service's database configuration
         * @see DatabaseConfiguration
         */
        public DatabaseConfiguration getDatabaseConfiguration()
        {
                return databaseConfiguration;
        }

        /**
         * Sets the database configuration of the service to the specified
         * DatabaseConfiguration object.
         * 
         * @param databaseConfiguration
         *            the databaseConfiguration that is to be this service's
         *            database configuration
         * @see DatabaseConfiguration
         */
        public void setDatabaseConfiguration(DatabaseConfiguration databaseConfiguration)
        {
                this.databaseConfiguration = databaseConfiguration;
        }

        /**
         * Gets the data projection code of the service
         * 
         * @return this service's data projection code
         */
        public String getDataProjection()
        {
                return dataProjection;
        }

        /**
         * Sets the data projection of the service to the specified string.
         * 
         * @param dataProjection
         *            the string that is to be this service's data projection
         */
        public void setDataProjection(String dataProjection)
        {
                this.dataProjection = dataProjection;
        }

        /**
         * Gets the SQL query at the specified position among the SQL queries of the
         * service.
         * 
         * @return this service's SQL query at the specified position
         */
        public String getSQL(int index)
        {
                return sqlQuery[index];
        }

        /**
         * Gets the SQL queries of the service
         * 
         * @return this service's SQL queries
         */
        public String[] getSQL()
        {
                return sqlQuery;
        }

        /**
         * Sets the query at the specified position to the specified string.
         * 
         * @param sqlQuery
         *            query to be stored at the specified position.
         * @param index
         *            index of query to replace.
         */
        public void setSQL(String sqlQuery, int index)
        {
                this.sqlQuery[index] = sqlQuery;
        }

        /**
         * Gets the parameters of the service
         * 
         * @return this service's parameters
         * @see Parameter
         */
        public Vector<Parameter> getParameters()
        {
                return parameters;
        }

        /**
         * Gets the parameter at the specified position among the parameters of the
         * service(Vector)
         * 
         * @param index
         *            index of parameter to return
         * @return parameter at the specified index
         * @see Parameter
         */
        public Parameter getParameter(int index)
        {
                return parameters.get(index);
        }

        /**
         * Gets the first parameter with the specified name among the parameters of
         * the service(Vector)
         * 
         * @param name
         *            parameter name
         * @return this service's parameter with the same name (first one)
         * @see Parameter
         */
        public Parameter getParameter(String name)
        {
                for (int i = 0; i < parameters.size(); i++)
                {
                        if (parameters.get(i).getName().equals(name))
                                return parameters.get(i);
                }
                return null;
        }

        /**
         * Sets the parameters of the service to the specified vector<Parameter>
         * 
         * @param parameters
         *            the vector<Parameter> that is to be this service's parameters
         * @see Parameter
         */
        public void setParameters(Vector<Parameter> parameters)
        {
                this.parameters = parameters;
        }

        /**
         * Sets a parameter of the service at the specified position to the
         * specified parameter.
         * 
         * @param index
         *            index of parameter to replace.
         * @param parameter
         *            Parameter to be stored at the specified position.
         */
        public void setParameter(int index, Parameter parameter)
        {
                parameters.set(index, parameter);
        }

        /**
         * Gets the formats of the service
         * 
         * @return this service's formats
         * @see Format
         */
        public Vector<Format> getFormats()
        {
                return formats;
        }

        /**
         * Sets the formats of the service to the specified vector<Format>.
         * 
         * @param formats
         *            the vector<Format> that is to be this service's formats
         */
        public void setFormats(Vector<Format> formats)
        {
                this.formats = formats;
        }

        public Limit getLimit()
        {
                return limit;
        }

        public void setLimit(Limit limit)
        {
                this.limit = limit;
        }
        
        
}