Application: gvSIG desktop » gvSIG geoprocess

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2012 gvSIG Association.

 *

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

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.geoprocess.algorithm.fusespatially;

import java.util.ArrayList;

import java.util.List;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.fmap.dal.feature.FeatureAttributeDescriptor;

import org.gvsig.fmap.dal.feature.FeatureSet;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.geoprocess.algorithm.dissolve.DissolveAlgorithm;

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

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

import org.gvsig.tools.dispose.DisposableIterator;

import org.gvsig.tools.task.SimpleTaskStatus;

import es.unex.sextante.core.Sextante;

import es.unex.sextante.dataObjects.IVectorLayer;

import es.unex.sextante.exceptions.GeoAlgorithmExecutionException;

import es.unex.sextante.exceptions.RepeatedParameterNameException;

import es.unex.sextante.exceptions.UnsupportedOutputChannelException;

import es.unex.sextante.outputs.OutputVectorLayer;

/**

 * Fuse spatially algorithm

 * @author <a href="mailto:nachobrodin@gmail.com">Nacho Brodin</a>

 */

public class FuseSpatiallyAlgorithm extends AbstractSextanteGeoProcess {

	public static final String         RESULT            = "RESULT";

	public static final String         RESULT_TABLE      = "RESULT_TABLE";

	public static final String         LAYER             = "LAYER";

	public static final String         SELECTED_GEOM     = "SELECTED_GEOM";

	private AbstractSextanteGeoProcess process           = null;

	private String                     fid               = "FID";

	/*

	 * (non-Javadoc)

	 * @see es.unex.sextante.core.GeoAlgorithm#defineCharacteristics()

	 */

	public void defineCharacteristics(){

        setName(getTranslation("fusespatially"));

        setGroup(getTranslation("basic_vect_algorithms"));

        // setGeneratesUserDefinedRasterOutput(false);

		try {

			m_Parameters.addInputVectorLayer(LAYER, getTranslation("Input_layer"), IVectorLayer.SHAPE_TYPE_WRONG, true);

			m_Parameters.addBoolean(SELECTED_GEOM, getTranslation("Selected_geometries_fuse"), false);

			addOutputVectorLayer(RESULT, getTranslation("fuse_spatially") + " ", OutputVectorLayer.SHAPE_TYPE_UNDEFINED);

			addOutputVectorLayer(RESULT_TABLE, getTranslation("fuse_spatially") + "_" + getTranslation("Table") + " ", OutputVectorLayer.SHAPE_TYPE_UNDEFINED);

		} catch (RepeatedParameterNameException e) {

			Sextante.addErrorToLog(e);

		}

	}

	public void setParentProcess(AbstractSextanteGeoProcess process) {

		this.process = process;

	}

	/*

	 * (non-Javadoc)

	 * @see es.unex.sextante.core.GeoAlgorithm#processAlgorithm()

	 */

	@SuppressWarnings("unchecked")

	public boolean processAlgorithm() throws GeoAlgorithmExecutionException {

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

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

    	}

		IVectorLayer layer = m_Parameters.getParameterValueAsVectorLayer(LAYER);

		boolean selectedGeom = m_Parameters.getParameterValueAsBoolean(SELECTED_GEOM);

		FeatureStore storeLayer = null;

		if(layer instanceof FlyrVectIVectorLayer)

			storeLayer = ((FlyrVectIVectorLayer)layer).getFeatureStore();

		else

			return false;

		try {

			String[] attrNames = new String[]{"FID"};

			Class[] types = new Class[] {Integer.class};

			FeatureStore outFeatStore = buildFuseSpatiallyOutPutStore(attrNames, types,

					layer.getShapeType(), getTranslation("fusespatially"), RESULT);

			return execute(storeLayer, outFeatStore, layer.getShapeType(), selectedGeom, getStatus(), "FID", true);

		} catch (DataException e) {

			Sextante.addErrorToLog(e);

			return false;

		}

	}

	public boolean execute(FeatureStore inputStoreLayer, 

			FeatureStore outFeatStore,

			int shapeType, 

			boolean selectedGeom, 

			SimpleTaskStatus status, 

			String idField,

			boolean createTable) throws DataException {

		FeatureStore outFeatStoreTable = null;

		String[] attrNamesTable = null;

		if(createTable) {

			attrNamesTable = new String[inputStoreLayer.getDefaultFeatureType().size() + 1];

			Class[] typesTable = new Class[inputStoreLayer.getDefaultFeatureType().size() + 1];

			attrNamesTable[0] = fid;

			typesTable[0] = Integer.class;

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

				FeatureAttributeDescriptor attrDesc = inputStoreLayer.getDefaultFeatureType().getAttributeDescriptor(i);

				attrNamesTable[i + 1] = attrDesc.getName();

				typesTable[i + 1] = attrDesc.getDataType().getDefaultClass();

			}

			attrNamesTable = checkFields(attrNamesTable);

			outFeatStoreTable = buildFuseSpatiallyOutPutStore(attrNamesTable, typesTable,

				shapeType, getTranslation("fusespatially") + "_Table", RESULT_TABLE);

		}

		FuseSpatiallyOperationFast2 operation = new FuseSpatiallyOperationFast2(this);

		operation.setTaskStatus(getStatus());

		operation.computesGeometryOperation(inputStoreLayer, 

				outFeatStore, 

				outFeatStoreTable,

				new String[]{fid}, 

				attrNamesTable,

				selectedGeom,

				false,

				idField);

		if(getTaskMonitor().isCanceled())

			return false;

		/*computesGeometryOperation(inputStoreLayer, outFeatStore, outFeatStoreTable, 

				attrNames, attrNamesTable, selectedGeom, status, idField);*/

		return true;

	}

	/**

	 * Removes duplicate fields

	 * @param names

	 * @return

	 */

	public String[] checkFields(String[] names) {

		if(names.length <= 1)

			return names;

		int cont = 0;

		int i = 1;

		while(i < names.length) {

			if(names[0].compareTo(names[i]) == 0) {

				names[0] = "FID_" + cont;

				i = 0;

				cont ++;

			}

			i ++;

		}

		return names;

	}

	/**

	 * Computes a complete operation over the input FeatureStore. The result of this operation

	 * is stored in the output FeatureStore. This method will call once for each geometry.

	 * @param inFeatStore

	 *        Input FeatureStore

	 * @param outFeatStore

	 *        Output FeatureStore

	 * @param attrNames

	 *        List of attributes to build the output feature store

	 * @param selectedGeom

	 *        If it is true only the selected geometries will be processed

	 * @deprecated This method uses FuseSpatiallyOperation which is deprecated

	 * @throws DataException

	 */

	@SuppressWarnings("deprecation")

	public void computesGeometryOperation(FeatureStore inFeatStore,

									FeatureStore outFeatStore,

									FeatureStore outFeatStoreTable,

									String[] attrNames,

									String[] attrNamesTable,

									boolean selectedGeom,

									SimpleTaskStatus status,

									String idField) throws DataException {

		FeatureSet featuresSet = null;

		DisposableIterator it = null;

		if(selectedGeom) {

			featuresSet = (FeatureSet)inFeatStore.getSelection();

		} else {

			featuresSet = inFeatStore.getFeatureSet();

		}

		it = featuresSet.iterator();

		int numberOfFeatures = (int)featuresSet.getSize();

        if (status != null) {

            status.setRangeOfValues(0, numberOfFeatures);

        }

        //Stack<Feature> featList = new Stack<Feature>();

        List<Feature> featList = new ArrayList<Feature>();

		while( it.hasNext() ) {

			Feature feature = (Feature)it.next();

			featList.add(feature);

		}

		FuseSpatiallyOperation operation = new FuseSpatiallyOperation(featList, 

				outFeatStoreTable, 

				attrNamesTable, 

				idField, 

				this);

		operation.setFeatureStore(outFeatStore, attrNames);

		int size = featList.size();

		operation.setGeoProcess(this, size);

		while (featList.size() > 0 && !m_Task.isCanceled()) {

			Feature f = featList.remove(featList.size() - 1);	

			operation.invoke(f.getDefaultGeometry(), f);

			setProgress(size - featList.size(), size);

		}

		if(operation.getWriter() != null)

			operation.getWriter().end();

	}

	public boolean setProgress(int step, int size) {

		if(process != null)

			return process.setProgress(step, size);

		else

			return super.setProgress(step, size);

	}

	/**

	 * Builds the output FeatureStore 

	 * @param featureType

	 * @return FeatureStore

	 */

	@SuppressWarnings("unchecked")

	protected FeatureStore buildFuseSpatiallyOutPutStore(String[] attrNames,

											Class[] types,

											int shapeType,

											String sextanteLayerName, 

											String sextanteLayerLabel) {

		try {

			IVectorLayer output = getNewVectorLayer(sextanteLayerLabel,

													sextanteLayerName,

													shapeType, types, attrNames);

			return ((FlyrVectIVectorLayer)output).getFeatureStore();

		} catch (UnsupportedOutputChannelException e) {

			Sextante.addErrorToLog(e);

        } catch (GeoAlgorithmExecutionException e) {

            Sextante.addErrorToLog(e);

        }

		return null;

	}

}