Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* 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 2

* 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, write to the Free Software

* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

package org.gvsig.raster.algorithm.process;

import java.util.ArrayList;

import java.util.Hashtable;

import java.util.Iterator;

import java.util.List;

import org.gvsig.fmap.dal.coverage.datastruct.Extent;

import org.gvsig.gui.beans.incrementabletask.IIncrementable;

import org.gvsig.gui.beans.incrementabletask.IncrementableListener;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.extensionpoint.ExtensionPoint;

import org.gvsig.tools.extensionpoint.ExtensionPointManager;

/**

 * Base class for all geoprocesses. This class contains all utilities to register

 * and get parameters in a geoprocess instance

 * 

 * @author Nacho Brodin nachobrodin@gmail.com

 */

public abstract class ProcessParamsManagement extends ProcessUtils implements IIncrementable, IncrementableListener, Runnable, Disposable {

        public static String                TIME                               = "TIME";

        public static String                PROCESS                            = "PROCESS";

        public static String                PROCESS_NAME                       = "PROCESS_NAME";

        protected Hashtable<String, Object> taskParams                         = new Hashtable<String, Object>();

        public static final String          REGISTER_INPUT_PARAMETERS_LABEL    = "RasterProcessInputParam";

        public static final String          REGISTER_OUTPUT_PARAMETERS_LABEL   = "RasterProcessOutputParam";

        /**

         *  Registers input parameters of a raster process

         */

        public static void registerInputParameter(String parameterLabel, Class<?> parameterClass, String processLabel) {

                registerParameter(processLabel, parameterLabel, parameterClass, REGISTER_INPUT_PARAMETERS_LABEL);

        }

        /**

         *  Registers output parameters of a raster process

         */

        public static void registerOutputParameter(String parameterLabel, Class<?> parameterClass, String processLabel) {

                registerParameter(processLabel, parameterLabel, parameterClass, REGISTER_OUTPUT_PARAMETERS_LABEL);

        }

        /**

         * Registers a parameter for a raster process

         */

        private static void registerParameter(String processLabel, String parameterLabel, Class<?> parameterClass, String type) {

                ExtensionPointManager extensionPoints = ToolsLocator.getExtensionPointManager();

                ExtensionPoint point = extensionPoints.add(type + "_" + processLabel);

                point.append(parameterLabel, "", parameterClass);

                registerGlobalOutputParameters(parameterLabel, parameterClass, processLabel);

        }

        public static void registerGlobalOutputParameters(String parameterLabel, Class<?> parameterClass, String processLabel) {

                ExtensionPointManager extensionPoints = ToolsLocator.getExtensionPointManager();

                ExtensionPoint point = extensionPoints.add(REGISTER_OUTPUT_PARAMETERS_LABEL + "_" + processLabel);

                if(!point.has(TIME) && !point.has(PROCESS)) {

                        point.append(TIME, "", Long.class);

                        point.append(PROCESS, "", DataProcess.class);

                        point.append(PROCESS_NAME, "", String.class);

                }

        }

        /**

         * Gets the key list of the input parameters

         * @param processLabel

         * @return

         */

        @SuppressWarnings("unchecked")

        public List<String> getRasterTaskInputParameters(String processLabel) {

                ExtensionPointManager extensionPoints = ToolsLocator.getExtensionPointManager();

                ExtensionPoint point = extensionPoints.add(REGISTER_INPUT_PARAMETERS_LABEL + "_" + processLabel);

                return point.getNames();

        }

        /**

         * Gets the key list of the output parameters

         * @param processLabel

         * @return

         */

        @SuppressWarnings("unchecked")

        public List<String> getRasterTaskOutputParameters(String processLabel) {

                ExtensionPointManager extensionPoints = ToolsLocator.getExtensionPointManager();

                ExtensionPoint point = extensionPoints.add(REGISTER_OUTPUT_PARAMETERS_LABEL + "_" + processLabel);

                return point.getNames();

        }

        /**

         * Gets the class of a parameter in a process.

         * @param processLabel

         * @param parameterName

         * @return

         */

        public Class<?> getParameterTypeByProcess(String processLabel, String parameterName) {

                ExtensionPointManager extensionPoints = ToolsLocator.getExtensionPointManager();

                ExtensionPoint point = extensionPoints.get(REGISTER_INPUT_PARAMETERS_LABEL + "_" + processLabel);

                return point.get(parameterName).getExtension();

        }

        /**

         * Gets a list with the class of all parameters. 

         * @param processLabel

         * @param parameterName

         * @return

         */

        public List<Class<?>> getParameterClassList(String processLabel, String parameterName) {

                ExtensionPointManager extensionPoints = ToolsLocator.getExtensionPointManager();

                ExtensionPoint point = extensionPoints.get(REGISTER_INPUT_PARAMETERS_LABEL + "_" + processLabel);

                List<Class<?>> classList = new ArrayList<Class<?>>();

                Iterator<?> it = point.iterator();

                while(it.hasNext()) {

                        Object obj = it.next();

                        classList.add((Class<?>)obj);

                }

                return classList;

        }

        @Override

        protected void finalize() throws Throwable {

                if(taskParams != null) {

                        taskParams.clear();

                        taskParams = null;

                }

                super.finalize();

        }

        /**

         * Add a parameter to this task at runtime. The 

         * parameter should have been registered before add

         * @param name key

         * @param param object to this task

         */

        public void addParam(String key, Object param) {

                if (param != null)

                        taskParams.put(key, param);

                else

                        taskParams.remove(key);

        }

        /**

         * Remove a parameter to this task at runtime.

         * @param name key

         */

        public void removeParam(String key) {

                taskParams.remove(key);

        }

        /**

         * Gets a parameter from its key

         * @param name key

         * @return parameter

         */

        public Object getParam(String key) {

                return taskParams.get(key);

        }

        /**

         * Gets a <code>String</code> parameter from its key

         * @param key

         * @return parameter

         */

        public String getStringParam(String key) {

                Object value = taskParams.get(key);

                return (value != null && value instanceof String) ? (String)value : null;

        }

        /**

         * Gets a <code>Byte</code> parameter from its key

         * @param key

         * @return parameter

         */

        public byte getByteParam(String name) {

                Object value = taskParams.get(name);

                return (value != null && value instanceof Byte) ? ((Byte)value).byteValue() : 0;

        }

        /**

         * Gets a <code>Float</code> parameter from its key

         * @param key

         * @return parameter

         */

        public float getFloatParam(String name) {

                Object value = taskParams.get(name);

                return (value != null && value instanceof Float) ? ((Float)value).floatValue() : 0F;

        }

        /**

         * Gets a <code>double</code> parameter from its key

         * @param key

         * @return parameter

         */

        public double getDoubleParam(String name) {

                Object value = taskParams.get(name);

                return (value != null && value instanceof Double) ? ((Double)value).doubleValue() : 0D;

        }

        /**

         * Gets a <code>int</code> parameter from its key

         * @param key

         * @return parameter

         */

        public int getIntParam(String name) {

                Object value = taskParams.get(name);

                return (value != null && value instanceof Integer) ? ((Integer)value).intValue() : 0;

        }

        /**

         * Gets a <code>Boolean</code> parameter from its key

         * @param key

         * @return parameter

         */

        public boolean getBooleanParam(String name) {

                Object value = taskParams.get(name);

                return (value != null && value instanceof Boolean) ? ((Boolean)value).booleanValue() : false;

        }

        /**

         * Gets a <code>int[]</code> parameter from its key

         * @param key

         * @return parameter

         */

        public int[] getIntArrayParam(String name) {

                Object value = taskParams.get(name);

                return (value != null && value instanceof int[]) ? ((int[])value) : null;

        }

        /**

         * Gets a <code>double[]</code> parameter from its key

         * @param key

         * @return parameter

         */

        public double[] getDoubleArrayParam(String name) {

                Object value = taskParams.get(name);

                return (value != null && value instanceof double[]) ? ((double[])value) : null;

        }

        /**

         * Gets a <code>Extent</code> parameter from its key

         * @param key

         * @return parameter

         */

        public Extent getExtentParam(String name) {

                Object value = taskParams.get(name);

                return (value != null && value instanceof Extent) ? ((Extent)value) : null;

        }

}