Application: gvSIG desktop » gvSIG raster

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<artifactId>org.gvsig.raster.tools</artifactId>

	<packaging>pom</packaging>

	<version>2.2.10</version>

	<name>org.gvsig.raster.tools</name>

	<description>Raster tools for gvSIG</description>

	<inceptionYear>2011</inceptionYear>

	<parent>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.desktop</artifactId>

      <version>2.0.101</version>

  </parent>

        <properties>

            <!-- El plugin versions:use-latest-versions falla con scope import -->

            <!-- asi que toca usar el versions:update-properties que si que funciona -->

            <org.gvsig.raster.version>2.2.13</org.gvsig.raster.version>

            <org.gvsig.geoprocess.version>2.2.27</org.gvsig.geoprocess.version>

        </properties>

  <repositories>

    <repository>

      <id>gvsig-public-http-repository</id>

      <name>gvSIG maven public HTTP repository</name>

      <url>http://devel.gvsig.org/m2repo/j2se</url>

      <releases>

        <enabled>true</enabled>

        <updatePolicy>daily</updatePolicy>

        <checksumPolicy>warn</checksumPolicy>

      </releases>

      <snapshots>

        <enabled>true</enabled>

        <updatePolicy>daily</updatePolicy>

        <checksumPolicy>warn</checksumPolicy>

      </snapshots>

    </repository>

  </repositories>

  <scm>

      <connection>scm:svn:https://devel.gvsig.org/svn/gvsig-raster/org.gvsig.raster.tools/tags/org.gvsig.raster.tools-2.2.10</connection>

      <developerConnection>scm:svn:https://devel.gvsig.org/svn/gvsig-raster/org.gvsig.raster.tools/tags/org.gvsig.raster.tools-2.2.10</developerConnection>

      <url>https://devel.gvsig.org/redmine/projects/gvsig-raster/repository/show/org.gvsig.raster.tools/tags/org.gvsig.raster.tools-2.2.10</url>

  </scm>

  <dependencyManagement>

  	<dependencies>

                        <dependency>

                                <groupId>org.gvsig</groupId>

                                <artifactId>org.gvsig.raster</artifactId>

                                <version>${org.gvsig.raster.version}</version>

                                <type>pom</type>

                                <scope>import</scope>

                        </dependency>

                        <dependency>

                                <groupId>org.gvsig</groupId>

                                <artifactId>org.gvsig.geoprocess</artifactId>

                                <version>${org.gvsig.geoprocess.version}</version>

                                <type>pom</type>

                                <scope>import</scope>

                        </dependency>

    	<!--

    	Versions of child projects

    	-->

			<dependency>

				<groupId>org.gvsig</groupId>

				<artifactId>org.gvsig.raster.tools.app.basic</artifactId>

				<version>2.2.10</version>

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

				<artifactId>org.gvsig.raster.tools.algorithm.layerdatatype</artifactId>

       	<version>2.2.10</version>

			</dependency>

			<dependency>

				<groupId>org.gvsig</groupId>

				<artifactId>org.gvsig.raster.tools.algorithm.saveraster</artifactId>

       	<version>2.2.10</version>

			</dependency>

			<!--

			<dependency>

				<groupId>org.gvsig</groupId>

				<artifactId>org.gvsig.raster.tools.algorithm.clip</artifactId>

       	<version>2.0.1-SNAPSHOT</version>

			</dependency>

			-->

			<dependency>

          <groupId>org.gvsig</groupId>

	        <artifactId>org.gvsig.raster.tools.algorithm.swing.api</artifactId>

	        <version>2.2.10</version>

    	</dependency>

    	<dependency>

          <groupId>org.gvsig</groupId>

	        <artifactId>org.gvsig.raster.tools.algorithm.swing.impl</artifactId>

	        <version>2.2.10</version>

    	</dependency>

    	<dependency>

          <groupId>org.gvsig</groupId>

	        <artifactId>org.gvsig.raster.tools.algorithm.maskthreshold</artifactId>

	        <version>2.2.10</version>

    	</dependency>

    	<dependency>

				<groupId>org.gvsig</groupId>

				<artifactId>org.gvsig.raster.tools.toolbox.algorithm</artifactId>

				<version>2.2.10</version>

			</dependency>

  	</dependencies>

  </dependencyManagement>

  <build>

      <plugins>

          <plugin>

              <groupId>org.apache.maven.plugins</groupId>

              <artifactId>maven-release-plugin</artifactId>

              <configuration>

                  <tagBase>https://devel.gvsig.org/svn/gvsig-raster/org.gvsig.raster.tools/tags/</tagBase>

                  <goals>deploy</goals>

              </configuration>

          </plugin>

      </plugins>

  </build>

	<modules>

		<module>org.gvsig.raster.tools.algorithm</module>

		<module>org.gvsig.raster.tools.app.basic</module>

		<module>org.gvsig.raster.tools.toolbox.algorithm</module>

		<!-- <module>org.gvsig.raster.tools.main</module>-->

	</modules>

</project>

layer_datatype=Cambiar tipo de dato

raster_layer=Capas r?ster

Input_layer=Capa de entrada

dst_datatype=Tipo de dato de destino

dec_2_int=De decimal a entero

big_2_small=De mayor a menor

file_exists=El fichero existe

convert_datatype=Convirtiendo el tipo de dato

layer_datatype=Change the data type

raster_layer=Raster layers

Input_layer=Input layer

dst_datatype=Data type of the result

dec_2_int=From decimal to integer

big_2_small=From greater type to lesser type

file_exists=The file exists

convert_datatype=Transforming the data type

<?xml version='1.0' encoding='ISO-8859-1' standalone='yes' ?>

<help>

	<element name="DESCRIPTION"

		text=""

		description="Descripción" type="0">

		<!-- <image description="" file="">

		</image>-->

	</element>

	<element name="ADDITIONAL_INFO" text=""

		description="Información adicional" type="0">

	</element>

	<element name="EXTENSION_AUTHOR" text=""

		description="Algoritmo creado por" type="0">

	</element>

	<element name="HELP_AUTHOR" text="" description="Ayuda creada por"

		type="0">

	</element>

	<element name="USER_NOTES" text="" description="Notas de usuario"

		type="0">

	</element>

</help>

<?xml version='1.0' encoding='ISO-8859-1' standalone='yes' ?>

<help>

	<element name="DESCRIPTION"

		text=""

		description="Descripción" type="0">

		<!-- <image description="" file="">

		</image> -->

	</element>

	<element name="ADDITIONAL_INFO" text=""

		description="Información adicional" type="0">

	</element>

	<element name="EXTENSION_AUTHOR" text=""

		description="Algoritmo creado por" type="0">

	</element>

	<element name="HELP_AUTHOR" text="" description="Ayuda creada por"

		type="0">

	</element>

	<element name="USER_NOTES" text="" description="Notas de usuario"

		type="0">

	</element>

</help>

org.gvsig.raster.tools.RasterToolsSextanteLibrary

package org.gvsig.raster.tools;

import java.util.HashMap;

import java.util.List;

import org.gvsig.fmap.dal.coverage.RasterLocator;

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

import org.gvsig.fmap.dal.coverage.exception.ProcessInterruptedException;

import org.gvsig.fmap.dal.coverage.store.RasterDataStore;

import org.gvsig.geoprocess.lib.sextante.AbstractSextanteGeoProcess;

import org.gvsig.geoprocess.lib.sextante.dataObjects.FLyrRasterIRasterLayer;

import org.gvsig.raster.algorithm.RasterBaseAlgorithmLibrary;

import org.gvsig.raster.algorithm.process.DataProcess;

import org.gvsig.raster.algorithm.process.IProcessActions;

import org.gvsig.raster.algorithm.process.ProcessException;

import org.gvsig.raster.fmap.layers.FLyrRaster;

import es.unex.sextante.core.AnalysisExtent;

import es.unex.sextante.core.Sextante;

import es.unex.sextante.dataObjects.IRasterLayer;

import es.unex.sextante.exceptions.GeoAlgorithmExecutionException;

import es.unex.sextante.exceptions.NullParameterAdditionalInfoException;

import es.unex.sextante.exceptions.NullParameterValueException;

import es.unex.sextante.exceptions.RepeatedParameterNameException;

import es.unex.sextante.exceptions.WrongParameterIDException;

import es.unex.sextante.exceptions.WrongParameterTypeException;

/**

 * Process to change a layer of data type

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public class LayerDatatypeSextanteAlgorithm extends AbstractSextanteGeoProcess implements IProcessActions {

    public static final String RESULT            = "RESULT";

    public static final String LAYER             = "RasterStore1";

	public static final String DATATYPE          = "Datatype";

	public static final String ADJUST_DEC2INT    = "AdjustDec2Int";

	public static final String ADJUST_BIG2SMALL  = "AdjustBig2Small";

	public static String[]    DEC2INT_OPTIONS    = new String[]{"Trunk", "Round", "Ceil", "Floor"};

	public static String[]    BIG2SMALL_OPTIONS  = new String[]{"Trunk", "Maxvalue", "NoData"};

	public static String[]    DATATYPES          = new String[]{"Byte", "UShort", "Short", "Integer", "Float", "Double"};

    private DataProcess        task            = null;

    public void defineCharacteristics() {

        setName(getTranslation("layer_datatype"));

        setGroup(getTranslation("raster_layer"));

        try {

            m_Parameters.addInputRasterLayer(LAYER, getTranslation("Input_layer"), true);

            m_Parameters.addSelection(DATATYPE, getTranslation("dst_datatype"), DATATYPES);

            m_Parameters.addSelection(ADJUST_DEC2INT, getTranslation("dec_2_int"), DEC2INT_OPTIONS);

            m_Parameters.addSelection(ADJUST_BIG2SMALL, getTranslation("big_2_small"), BIG2SMALL_OPTIONS);

        } catch (RepeatedParameterNameException e) {

            Sextante.addErrorToLog(e);

        }

        addOutputRasterLayer(RESULT, getTranslation("principalcomponents"));

    }

    public boolean processAlgorithm() throws GeoAlgorithmExecutionException {

    	if(existsOutPutFile(LayerDatatypeSextanteAlgorithm.RESULT, 0)) {

    		throw new GeoAlgorithmExecutionException(getTranslation("file_exists"));

    	}

    	IRasterLayer input = m_Parameters.getParameterValueAsRasterLayer(LAYER);

    	FLyrRaster lyrRaster = ((FLyrRaster)input.getBaseDataObject());

    	IRasterLayer output = null;

    	output = getNewRORasterLayer(

    			RESULT,

    			Sextante.getText("layerdatatype_description"),

    			input.getDataType(),

    			input.getBandsCount());

    	String fileName = ((FLyrRasterIRasterLayer)output).getName();

    	try {

    		setProgressText(getTranslation("convert_datatype"));

			task = createLayerDatatypeProcess(lyrRaster.getDataStore(), fileName);

			task.execute();

			HashMap<String, Object> params = task.getResult();

			fileName = (String)params.get("FileName");

			((FLyrRasterIRasterLayer)output).setBaseDataObject(fileName);

		} catch (ProcessInterruptedException e) {

			Sextante.addErrorToLog(e);

		} catch (ProcessException e) {

			Sextante.addErrorToLog(e);

		}

		if(getTaskMonitor().isCanceled())

			return false;

        return true;

    }

    /**

     * Creates a process to calculate statistics

     * @param inputStore

     * @return

     * @throws ProcessException

     * @throws NullParameterAdditionalInfoException

     * @throws NullParameterValueException

     * @throws WrongParameterIDException

     * @throws WrongParameterTypeException

     */

    private DataProcess createLayerDatatypeProcess(RasterDataStore inputStore, String fileName) throws ProcessException, WrongParameterTypeException, WrongParameterIDException, NullParameterValueException, NullParameterAdditionalInfoException {

    	DataProcess taskStats = RasterBaseAlgorithmLibrary.getManager().createRasterTask("LayerDatatypeProcess");

    	taskStats.setActions(this);

    	List<String> params = taskStats.getRasterTaskInputParameters("LayerDatatypeProcess");

    	for (int i = 0; i < params.size(); i++) {

    		String paramName = params.get(i);

    		Class<?> paramType = taskStats.getParameterTypeByProcess("LayerDatatypeProcess", paramName);

    		if(paramType == RasterDataStore.class) {

    			taskStats.addParam(paramName, (RasterDataStore)inputStore);

    		}

    		if(paramName.equals("Path")) {

    			taskStats.addParam(paramName, fileName);

    		}

    		if(paramName.equals(DATATYPE)) {

    			String value = m_Parameters.getParameterValueAsString(DATATYPE);

    			int position = 0;

    			for (int j = 0; j < DATATYPES.length; j++) {

					if(DATATYPES[j].equals(value))

						position = j;

				}

    			taskStats.addParam(paramName, position);

    		}

    		if(paramName.equals(ADJUST_DEC2INT)) {

    			String value = m_Parameters.getParameterValueAsString(ADJUST_DEC2INT);

    			int position = 0;

    			for (int j = 0; j < DEC2INT_OPTIONS.length; j++) {

					if(DEC2INT_OPTIONS[j].equals(value))

						position = j;

				}

    			taskStats.addParam(paramName, position);

    		}

    		if(paramName.equals(ADJUST_BIG2SMALL)) {

    			String value = m_Parameters.getParameterValueAsString(ADJUST_BIG2SMALL);

    			int position = 0;

    			for (int j = 0; j < BIG2SMALL_OPTIONS.length; j++) {

					if(BIG2SMALL_OPTIONS[j].equals(value))

						position = j;

				}

    			taskStats.addParam(paramName, position);

    		}

    		if(paramName.equals("WINDOW")) {

    			AnalysisExtent ext = getAnalysisExtent();

    			Extent bbox = RasterLocator.getManager().getDataStructFactory().createExtent(

    					ext.getXMin(), ext.getYMax(), ext.getXMax(), ext.getYMin());

    			Extent inputBbox = inputStore.getExtent();

    			if(bbox.getULX() != inputBbox.getULX() ||

    				bbox.getULY() != inputBbox.getULY() ||

    				bbox.getLRX() != inputBbox.getLRX() ||

    				bbox.getLRY() != inputBbox.getLRY()) {

    				taskStats.addParam(paramName, bbox);

    			}

    		}

    	}

    	return taskStats;

    }

	public void interrupted() {

	}

	public void end(Object param) {

	}

	public void updateProgress(int current, int total) {

		boolean cancelled = setProgress(current, total);

		if(!cancelled) {

			if(task != null)

				task.actionCanceled(null);

		}

	}

    /*

     * TODO: Customized panels

    @Override

    public Class<? extends GeoAlgorithmParametersPanel> getCustomParametersPanelClass() {

        return PrincipalComponentsParametersPanel.class;

    }*/

}

package org.gvsig.raster.tools;

import org.gvsig.geoprocess.algorithm.base.core.AlgorithmAbstractLibrary;

import org.gvsig.i18n.Messages;

import org.gvsig.tools.library.LibraryException;

/**

 * Initialization of <code>RasterToolsSextanteLibrary</code> library.

 */

public class RasterToolsSextanteLibrary extends AlgorithmAbstractLibrary {

    @Override

    protected void doInitialize() throws LibraryException {

        // Nothing to do

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

        Messages.addResourceFamily(

            "org.gvsig.raster.tools.sextante.i18n.text", RasterToolsSextanteLibrary.class

                .getClassLoader(), RasterToolsSextanteLibrary.class.getClass().getName());

        registerGeoProcess(new LayerDatatypeSextanteAlgorithm());

    }

}

<?xml version="1.0" encoding="ISO-8859-1"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<artifactId>org.gvsig.raster.tools.toolbox.algorithm</artifactId>

	<packaging>jar</packaging>

	<name>org.gvsig.raster.tools.toolbox.algorithm</name>

	<parent>

		<groupId>org.gvsig</groupId>

		<artifactId>org.gvsig.raster.tools</artifactId>

		<version>2.2.10</version>

	</parent>

	<dependencies>

		<dependency>

		    <groupId>org.gvsig</groupId>

   			<artifactId>org.gvsig.raster.tools.algorithm.layerdatatype</artifactId>

            <scope>runtime</scope>

   		</dependency>

		<dependency>

		    <groupId>org.gvsig</groupId>

   			<artifactId>org.gvsig.raster.algorithm</artifactId>

            <scope>compile</scope>

   		</dependency>

		<dependency>

		    <groupId>org.gvsig</groupId>

   			<artifactId>org.gvsig.geoprocess.algorithm.base</artifactId>

            <scope>compile</scope>

   		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.geoprocess.lib.sextante</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.tools.lib</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.ui</artifactId>

			<scope>compile</scope>

		</dependency>

	    <dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.i18n</artifactId>

			<scope>compile</scope>

		</dependency>

		<dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.mapcontext.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.mapcontext.impl</artifactId>

            <scope>runtime</scope>

        </dependency>

		<dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.projection.api</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.projection.cresques.impl</artifactId>

            <scope>runtime</scope>

        </dependency>

   		<dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.metadata.lib.basic.api</artifactId>

            <scope>compile</scope>

        </dependency>

	</dependencies>

</project>

#Fri Jul 03 22:26:30 CEST 2015

buildNumber=61

<assembly>

  <id>gvsig-plugin-package</id>

  <formats>

    <format>zip</format>

  </formats>

  <baseDirectory>${project.artifactId}</baseDirectory>

  <includeBaseDirectory>true</includeBaseDirectory>

  <files>

    <file>

      <source>target/${project.artifactId}-${project.version}.jar</source>

      <outputDirectory>lib</outputDirectory>

    </file>

    <file>

      <source>target/package.info</source>

    </file>

  </files>

  <fileSets>

    <fileSet>

      <directory>src/main/resources-plugin</directory>

      <outputDirectory>.</outputDirectory>

    </fileSet>

  </fileSets>

  <dependencySets>

    <dependencySet>

      <useProjectArtifact>false</useProjectArtifact>

	  <useTransitiveDependencies>false</useTransitiveDependencies>

      <outputDirectory>lib</outputDirectory>

      <includes> 

				<include>org.gvsig:org.gvsig.raster.tools.app.basic:jar</include>

				<include>org.gvsig:org.gvsig.raster.tools.algorithm.layerdatatype:jar</include>

				<include>org.gvsig:org.gvsig.raster.tools.algorithm.saveraster:jar</include>

				<include>org.gvsig:org.gvsig.raster.tools.algorithm.swing.api:jar</include>

				<include>org.gvsig:org.gvsig.raster.tools.algorithm.swing.impl:jar</include>

				<include>org.gvsig:org.gvsig.raster.tools.toolbox.algorithm:jar</include>

	  </includes>

	</dependencySet>

  </dependencySets>

</assembly>

/* 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.tools.app.basic.raster.process;

import javax.swing.SwingUtilities;

import org.gvsig.andami.PluginServices;

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

import org.gvsig.fmap.dal.coverage.exception.HistogramException;

import org.gvsig.fmap.dal.coverage.exception.ProcessInterruptedException;

import org.gvsig.fmap.dal.coverage.store.props.HistogramComputer;

/**

* Process to calculate a Histogram using a Histogramable object. A Histogramable object

* has its own method to build an histogram an this process will call to this function. 

* 

* @author Nacho Brodin (nachobrodin@gmail.com)

*/

public class HistogramProcess extends RasterProcess {

	private BufferHistogram        lastHistogram  = null;

	private HistogramComputer      histogramable  = null;

	/*

	 * (non-Javadoc)

	 * @see org.gvsig.rastertools.RasterProcess#init()

	 */

	public void init() {

		histogramable = (HistogramComputer) getParam("histogramable");

	}

	/*

	 * (non-Javadoc)

	 * @see org.gvsig.rastertools.RasterProcess#process()

	 */

	public void process() throws ProcessInterruptedException, ProcessException {

		try {

			// Proceso duro de obtener un histograma. Puede durar bastante tiempo.

			lastHistogram = histogramable.getBufferHistogram();

			// Ya tenemos el histograma y lo representamos en la ventana

			SwingUtilities.invokeLater(new Runnable() {

				public void run() {

					if ((externalActions != null) && (lastHistogram != null))

						externalActions.end(lastHistogram);

				}

			});

		} catch (HistogramException e) {

			throw new ProcessException("Error calculando el histograma", e);

		} 

	}

	/*

	 * (non-Javadoc)

	 * @see org.gvsig.raster.RasterProcess#getResult()

	 */

	public Object getResult() {

		return lastHistogram;

	}

	/*

	 * (non-Javadoc)

	 * @see org.gvsig.rastertools.RasterProcess#getLog()

	 */

	public String getLog() {

		return PluginServices.getText(this, "calculando_histograma") + "...\n";

	}

	/*

	 * (non-Javadoc)

	 * @see org.gvsig.gui.beans.incrementabletask.IIncrementable#getPercent()

	 */

	public int getPercent() {

		if (histogramable != null)

			return histogramable.getPercent();

		return 0;

	}

	/*

	 * (non-Javadoc)

	 * @see org.gvsig.gui.beans.incrementabletask.IIncrementable#getTitle()

	 */

	public String getTitle() {

		return PluginServices.getText(this, "calculando_histograma");

	}

	/*

	 * (non-Javadoc)

	 * @see java.lang.Object#finalize()

	 */

	protected void finalize() throws Throwable {

		lastHistogram           = null;

		histogramable           = null;

		super.finalize();

	}

}

/* 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.tools.app.basic.raster.process;

/**

 * This exception is thrown when a problem inside a raster process

 * is detected. 

 * 

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

public class ProcessException extends Exception {

	private static final long serialVersionUID = 666908550965442025L;

	public ProcessException(String msg, Throwable e) {

		super(msg, e);

	}

	public ProcessException(String msg){

		super(msg);

	}

}

/* 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.tools.app.basic.raster.process;

import java.util.Hashtable;

import org.gvsig.fmap.dal.coverage.RasterLocator;

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

import org.gvsig.fmap.dal.coverage.exception.ProcessInterruptedException;

import org.gvsig.fmap.dal.coverage.process.CancelEvent;

import org.gvsig.fmap.dal.coverage.process.TaskEventManager;

import org.gvsig.gui.beans.buttonspanel.ButtonsPanel;

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

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

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

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

import org.gvsig.raster.fmap.layers.FLyrRaster;

import org.gvsig.raster.swing.RasterSwingLibrary;

import org.gvsig.tools.dispose.Disposable;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Clase base de todos los procesos raster. En ella se genstionan todas las

 * funciones comunes como incremento de la tarea, gesti?n de eventos a la tarea, 

 * par?metros de la tarea, etc ...

 * 

 * 18/12/2007

 * @author Nacho Brodin nachobrodin@gmail.com

 * @deprecated Use DataProcess in org.gvsig.raster.algorithm

 */

public abstract class RasterProcess implements IIncrementable, IncrementableListener, Runnable, Disposable {

	protected IncrementableTask incrementableTask = null;

	protected volatile Thread   blinker           = null;

	protected TaskEventManager  taskEventManager  = null;

	protected IProcessActions   externalActions   = null;

	protected Hashtable<String, Object>

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

	private String              log               = "";

	private String              lastLine          = "";

	private long                time              = 0;

	private boolean             progressActive    = true;

	private IProcessActions     queueActions      = null;

	private Logger              logger            = LoggerFactory.getLogger(RasterProcess.class.toString());

	/**

	 * Crea la ventana de IncrementableTask

	 */

	public IncrementableTask getIncrementableTask() {

		if (incrementableTask == null) {

			incrementableTask = new IncrementableTask(this);

			incrementableTask.addIncrementableListener(this);

		}

		return incrementableTask;

	}

	/**

	 * Define si se puede cancelar el proceso. Por defecto es true.

	 * @param enabled

	 */

	public void setCancelable(boolean enabled) {

		getIncrementableTask().getButtonsPanel().setEnabled(ButtonsPanel.BUTTON_CANCEL, enabled);

	}

	/**

	 * Muestra la ventana de IncrementableTask

	 */

	public void showIncrementableWindow() {

		if (progressActive) {

			getIncrementableTask().showWindow();

			getIncrementableTask().start();

		}

	}

	/**

	 * Arranca el proceso de recorte de un layer

	 */

	public void start() {

		showIncrementableWindow();

		if(blinker == null)

			blinker = new Thread(this);

		blinker.start();

	}

	/**

	 * Proceso de carga de par?metros. Puede no hacerse una carga de par?metros 

	 * explicita y obtenerlos directamente de la tabla Hash cuando vayan a usarse. 

	 * Esto queda a elecci?n del programador. En caso de hacerse una carga de par?metros

	 * explicita esta llamada deber?a hacerse justo despues del constructor de la clase

	 * que contendr? el proceso.

	 */

	public abstract void init();

	/**

	 * Proceso

	 * @throws InterruptedException

	 */

	public abstract void process() throws ProcessInterruptedException, ProcessException;

	/**

	 * Obtenci?n de un objeto de resultado. Este objeto deber? ser el mismo que el que se

	 * pasa por par?metro en el "end" de IProcessActions. Este m?todo es util cuando la tarea no se

	 * lanza en un Thread (ejecutamos process directamente) y queremos recoger el resultado

	 * sin registrarnos al evento de finalizaci?n de tarea.

	 * @return objeto resultado de la tarea

	 */

	public Object getResult() {

		return null;

	}

	/**

	 * Proceso

	 * @throws ProcessException 

	 */

	public void execute() throws ProcessInterruptedException, ProcessException {

		init();

		process();

	}

	/**

	 * M?todo donde se ejecutar? el Thread. Este har? las acciones globales para 

	 * cualquier tarea y llamar? al m?todo execute especifico de una tarea.

	 */

	public void run() {

		long t1 = new java.util.Date().getTime();

		try {

			taskEventManager = RasterLocator.getManager().createRasterTask(this);

			execute();

		} catch (ProcessInterruptedException e) {

			if (externalActions != null)

				externalActions.interrupted();

			Thread.currentThread().interrupt();

		} catch (ProcessException e) {

			if (progressActive) {

				if (incrementableTask != null) {

					getIncrementableTask().processFinalize();

					incrementableTask = null;

				}

			}

			logger.warn(RasterLocator.getManager().getRasterUtils().getTrace(e));

			if(e.getMessage() != null && e.getMessage().compareTo("") != 0)

				RasterSwingLibrary.messageBoxError(e.getMessage(), this);

			else

				RasterSwingLibrary.messageBoxError("error_processing", this);

			queueActions = null;

		} catch (Exception e) {

			if (progressActive) {

				if (incrementableTask != null) {

					getIncrementableTask().processFinalize();

					incrementableTask = null;

				}

			}

			logger.warn(RasterLocator.getManager().getRasterUtils().getTrace(e));

			if(e.getMessage() != null && e.getMessage().compareTo("") != 0)

				RasterSwingLibrary.messageBoxError(e.getMessage(), this);

			else

				RasterSwingLibrary.messageBoxError("error_processing", this);

			queueActions = null;

		} finally {

			taskEventManager.removeTask();

			if (progressActive) {

				if (incrementableTask != null)

					getIncrementableTask().processFinalize();

			}

			if (queueActions != null)

				queueActions.end(this);

			time = new java.util.Date().getTime() - t1;

			blinker = null;

		}

	}

	/**

	 * Activa o desactiva el interfaz de progreso en el lanzamiento de la tarea como un thread.

	 * @param active true para activarlo o false para desactivarlo

	 */

	public void setProgressActive(boolean active){

		this.progressActive = active;

	}

	/**

	 * Obtiene el tiempo que tard? en ejecutarse la tarea 

	 * la ?ltima vez que se proces?

	 */

	public long getTime() {

		return time;

	}

	/**

	 * Obtiene el objeto para ejecutar acciones externar.

	 * @param IProcessActions

	 */

	public IProcessActions getActions() {

		return externalActions;

	}

	/**

	 * Asigna el objeto para ejecutar acciones externar.

	 * @param IProcessActions

	 */

	public void setActions(IProcessActions actions) {

		this.externalActions = actions;

	}

	/**

	 * Obtiene el objeto para ejecutar acciones de la cola de procesos de ejecuci?n exclusiva.

	 * @param IProcessActions

	 */

	public IProcessActions getUniqueProcessActions() {

		return queueActions;

	}

	/**

	 * Asigna el objeto para ejecutar acciones externar.

	 * @param IProcessActions

	 */

	public void setUniqueProcessActions(IProcessActions actions) {

		this.queueActions = actions;

	}

	/**

	 * Inserta una nueva l?nea en el log del cuadro de incremento de tarea

	 * @param line

	 */

	protected void insertLineLog(String line) {

		lastLine = line;

		log = log + line + "\n";

	}

	/**

	 * Obtiene la ?ltima l?nea introducida en el log del cuadro de incremento.

	 */

	public String getLabel() {

		return lastLine;

	}

	/**

	 * Obtiene el texto de log del cuadro de incremento completo.

	 */

	public String getLog() {

		return log;

	}

	/**

	 * Un evento de cancelado es enviado a la tarea cuando actionCanceled es activado. Para

	 * ello se crear? un objeto CancelEvent y se asignar? a la tarea en ejecuci?n. Esta lo

	 * procesar? cuando pueda e interrumpir? el proceso.

	 */

	public void actionCanceled(IncrementableEvent e) {

		taskEventManager.setEvent(new CancelEvent(this));

	}

	/**

	 * A?ade un par?metro a la tarea

	 * @param name Clave del par?metro

	 * @param param Objeto pasado como par?metro

	 */

	public void addParam(String name, Object param) {

		if (param != null)

			taskParams.put(name, param);

		else

			taskParams.remove(name);

	}

	/**

	 * Elimina un par?metro de la tarea

	 * @param name Clave del par?metro a eliminar

	 */

	public void removeParam(String name) {

		taskParams.remove(name);

	}

	/**

	 * Obtiene un par?metro a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public Object getParam(String name) {

		return taskParams.get(name);

	}

	/**

	 * Obtiene un par?metro String a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public String getStringParam(String name) {

		Object value = taskParams.get(name);

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

	}

	/**

	 * Obtiene un par?metro byte a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public byte getByteParam(String name) {

		Object value = taskParams.get(name);

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

	}

	/**

	 * Obtiene un par?metro float a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public float getFloatParam(String name) {

		Object value = taskParams.get(name);

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

	}

	/**

	 * Obtiene un par?metro double a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public double getDoubleParam(String name) {

		Object value = taskParams.get(name);

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

	}

	/**

	 * Obtiene un par?metro entero a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public int getIntParam(String name) {

		Object value = taskParams.get(name);

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

	}

	/**

	 * Obtiene un par?metro boolean a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public boolean getBooleanParam(String name) {

		Object value = taskParams.get(name);

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

	}

	/**

	 * Obtiene un par?metro int[] a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public int[] getIntArrayParam(String name) {

		Object value = taskParams.get(name);

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

	}

	/**

	 * Obtiene un par?metro double[] a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public double[] getDoubleArrayParam(String name) {

		Object value = taskParams.get(name);

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

	}

	/**

	 * Obtiene un par?metro capa raster a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public FLyrRaster getLayerParam(String name) {

		Object value = taskParams.get(name);

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

	}

	/**

	 * Obtiene un par?metro extent a partir de la clave

	 * @param name Par?metro

	 * @return Par?metro

	 */

	public Extent getExtentParam(String name) {

		Object value = taskParams.get(name);

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

	}

	/*

	 * (non-Javadoc)

	 * @see org.gvsig.gui.beans.incrementabletask.IncrementableListener#actionResumed(org.gvsig.gui.beans.incrementabletask.IncrementableEvent)

	 */

	public void actionResumed(IncrementableEvent e) {	

	}

	/*

	 * (non-Javadoc)

	 * @see org.gvsig.gui.beans.incrementabletask.IncrementableListener#actionSuspended(org.gvsig.gui.beans.incrementabletask.IncrementableEvent)

	 */

	public void actionSuspended(IncrementableEvent e) {

	}