Application: gvSIG desktop » gvSIG geoprocess

/* 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.geoprocess.lib.sextante;

import java.util.HashMap;

import java.util.Iterator;

import es.unex.sextante.core.GeoAlgorithm;

import es.unex.sextante.core.ITaskMonitor;

import es.unex.sextante.core.OutputFactory;

import es.unex.sextante.core.Sextante;

import es.unex.sextante.dataObjects.IVectorLayer;

import es.unex.sextante.exceptions.GeoAlgorithmExecutionException;

import es.unex.sextante.exceptions.UnsupportedOutputChannelException;

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

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

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

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

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

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.geoprocess.lib.api.GeoProcess;

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

/**

 * Base implementation for Sextante based {@link GeoProcess} objects.

 * 

 * @author gvSIG Team

 * @version $Id$

 */

public abstract class AbstractSextanteGeoProcess extends GeoAlgorithm implements

    GeoProcess {

    protected String[] attrNames = null;

    private SimpleTaskStatusDelegated status;

    @Override

    public boolean execute(ITaskMonitor task, OutputFactory outputFactory,

        HashMap<String, String> outputMap)

        throws GeoAlgorithmExecutionException {

        status = new SimpleTaskStatusDelegated(m_Task, getGeoProcessName());

        status.add();

        boolean result = false;

        try {

            result = super.execute(task, outputFactory, outputMap);

        } finally {

            status.remove();

        }

        return result;

    }

    /**

     * Builds the output FeatureStore

     * 

     * @param featureType

     * @return FeatureStore

     */

    protected FeatureStore buildOutPutStore(FeatureType featureType,

        int shapeType, String sextanteLayerName, String sextanteLayerLabel) {

        Class<?>[] types = null;

        if (featureType.getDefaultGeometryAttribute() != null) {

            // Tiene campo GEOMETRY.

            // Hay que quitarlo

            attrNames = new String[featureType.size() - 1];

            types = new Class[featureType.size() - 1];

        } else {

            attrNames = new String[featureType.size()];

            types = new Class[featureType.size()];

        }

        int i = 0;

        @SuppressWarnings("unchecked")

        Iterator<FeatureAttributeDescriptor> it = featureType.iterator();

        while (it.hasNext()) {

            FeatureAttributeDescriptor attribute = it.next();

            if (attribute.getName().compareTo("GEOMETRY") != 0) {

                attrNames[i] = attribute.getName();

                types[i] = attribute.getObjectClass();

                i++;

            }

        }

        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;

    }

    /**

     * Builds the output FeatureStore

     * 

     * @param featureType

     * @return FeatureStore

     */

    protected FeatureStore buildOutPutStoreFromUnion(FeatureType featureType1,

        FeatureType featureType2, int shapeType, String sextanteLayerName,

        String sextanteLayerLabel) {

        return buildOutPutStoreFromUnion(featureType1, featureType2, shapeType,

            sextanteLayerName, sextanteLayerLabel, null, null);

    }

    /**

     * Builds the output FeatureStore

     * 

     * @param featureType

     * @return FeatureStore

     */

    protected FeatureStore buildOutPutStoreFromUnion(FeatureType featureType1,

        FeatureType featureType2, int shapeType, String sextanteLayerName,

        String sextanteLayerLabel, String newField, Class<?> newFieldType) {

        int sizeAux = 0;

        if (newField != null && newFieldType != null)

            sizeAux = 1;

        Class<?>[] types = null;

        // Tiene campo GEOMETRY. Hay que quitarlo

        if (featureType1.getDefaultGeometryAttribute() != null) {

            attrNames =

                new String[featureType1.size() + featureType2.size() - 2

                    + sizeAux];

            types =

                new Class[featureType1.size() + featureType2.size() - 2

                    + sizeAux];

        } else {

            attrNames =

                new String[featureType1.size() + featureType2.size() + sizeAux];

            types =

                new Class[featureType1.size() + featureType2.size() + sizeAux];

        }

        int i = 0;

        @SuppressWarnings("unchecked")

        Iterator<FeatureAttributeDescriptor> it = featureType1.iterator();

        while (it.hasNext()) {

            FeatureAttributeDescriptor attribute =

                (FeatureAttributeDescriptor) it.next();

            if (attribute.getName().compareTo("GEOMETRY") != 0) {

                attrNames[i] = attribute.getName();

                types[i] = attribute.getObjectClass();

                i++;

            }

        }

        @SuppressWarnings("unchecked")

        Iterator<FeatureAttributeDescriptor> it2 = featureType2.iterator();

        while (it2.hasNext()) {

            FeatureAttributeDescriptor attribute = it2.next();

            if (attribute.getName().compareTo("GEOMETRY") != 0) {

                String attrName =

                    checkAttrName(attribute.getName(), featureType1.size() - 1);

                attrNames[i] = attrName;

                types[i] = attribute.getObjectClass();

                i++;

            }

        }

        if (newField != null && newFieldType != null) {

            attrNames[attrNames.length - 1] = newField;

            types[types.length - 1] = newFieldType;

        }

        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;

    }

    /**

     * Changes the attribute name if this name is in the list.

     * 

     * @param name

     * @return

     */

    protected String checkAttrName(String name, int size) {

        String newName = name;

        for (int i = 0; i < size; i++)

            if (attrNames[i].compareTo(newName) == 0)

                newName = newName + "I";

        return newName;

    }

    /**

     * Gets the shape type of the selected feature store

     * 

     * @param FeatureStore

     *            source

     * @return shape type

     * @throws ReadException

     */

    protected int getShapeType(FeatureStore storeLayer1) throws ReadException {

        FeatureType featureType;

        try {

            featureType = storeLayer1.getDefaultFeatureType();

        } catch (DataException e) {

            throw new ReadException(storeLayer1.getName(), e);

        }

        int indexGeom = featureType.getDefaultGeometryAttributeIndex();

        return featureType.getAttributeDescriptor(indexGeom).getGeomType()

            .getType();

    }

    /**

     * Returns true if it is a point layer

     * 

     * @param store

     * @return

     * @throws ReadException

     */

    protected boolean isPoint(FeatureStore store) throws ReadException {

        return (getShapeType(store) == Geometry.TYPES.POINT || getShapeType(store) == Geometry.TYPES.MULTIPOINT);

    }

    /**

     * Returns true if it is a polygon layer

     * 

     * @param store

     * @return

     * @throws ReadException

     */

    protected boolean isPolygon(FeatureStore store) throws ReadException {

        return (getShapeType(store) == Geometry.TYPES.SURFACE || getShapeType(store) == Geometry.TYPES.MULTISURFACE);

    }

    /**

     * Returns true if it is a line layer

     * 

     * @param store

     * @return

     * @throws ReadException

     */

    protected boolean isLine(FeatureStore store) throws ReadException {

        return (getShapeType(store) == Geometry.TYPES.CURVE || getShapeType(store) == Geometry.TYPES.MULTICURVE);

    }

    public String getGeoProcessName() {

        return getName();

    }

    @Override

    protected void setProgressText(String sText) {

        getStatus().message(sText);

    }

    @Override

    protected boolean setProgress(int iStep, int iTotalNumberOfSteps) {

        SimpleTaskStatusDelegated status = getStatus();

        status.setRangeOfValues(0, iTotalNumberOfSteps);

        status.setCurValue(iStep);

        return status.isCancelled();

    }

    protected SimpleTaskStatusDelegated getStatus() {

        return status;

    }

}