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.base.core;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.List;

import org.gvsig.fmap.dal.DataSet;

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

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

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

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

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

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

import org.gvsig.geoprocess.core.IProgressModel;

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

import org.gvsig.tools.dispose.DisposableIterator;

import org.gvsig.tools.task.SimpleTaskStatus;

/**

 * Each geometry operation have to inherit from this class.

 *  

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

 */

@SuppressWarnings("deprecation")

public abstract class GeometryOperation {

        protected DALFeaturePersister              persister          = null;

        protected FeatureStore                     inFeatureStore     = null;

        protected ArrayList<FeatureStore>          inFeatureStoreList = null;

        protected boolean                          selectedGeom       = false;

        protected int                              numberOfFeatures   = 0;

        protected EditableFeature                  lastEditFeature    = null;

    protected SimpleTaskStatus                 status             = null;

    protected AbstractSextanteGeoProcess       process            = null;

    protected int                              procesSize         = 0;

    public GeometryOperation(AbstractSextanteGeoProcess process) {

            this.process = process;

    }

        /**

         * Invokes this operation and returns an EditableFeature

         * @param g

         * @param featureInput

         * @return

         */

        public abstract EditableFeature invoke(org.gvsig.fmap.geom.Geometry g, Feature featureInput);

        /**

         * Invokes this operation

         * @param g

         * @param featureInput

         */

        public abstract void invoke(org.gvsig.fmap.geom.Geometry g, EditableFeature featureInput);

        /**

         * Sets the output FeatureType and the input attributes for this feature

         * @param out

         * @throws DataException 

         */

        public void setFeatureStore(FeatureStore out, String[] attrNames) throws DataException {

                persister = new DALFeaturePersister(out, attrNames);

        }

        /**

         * Gets the last result of this operation

         * @return

         */

        public Object getResult() {

                return lastEditFeature;

        }

        /**

         * 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

         * @throws DataException

         */

        @SuppressWarnings({ "unchecked" })

        public void computesGeometryOperation(FeatureStore inFeatStore,

                                                                        FeatureStore outFeatStore,

                                                                        String[] attrNames,

                                                                        boolean selectedGeom,

                                                                        boolean closeOutStore) throws DataException {

                this.inFeatureStore = inFeatStore;

                this.selectedGeom = selectedGeom;

                FeatureSet featuresSet = null;

                if(outFeatStore != null)

                        setFeatureStore(outFeatStore, attrNames);

                DisposableIterator it = null;

                if(selectedGeom) {

                        featuresSet = (FeatureSet)inFeatStore.getSelection();

                } else {

                        featuresSet = inFeatStore.getFeatureSet();

                }

                it = featuresSet.iterator();

                numberOfFeatures = (int)featuresSet.getSize();

        if (status != null && process != null) {

            status.setRangeOfValues(0, numberOfFeatures);

            process.setProgress(0, numberOfFeatures);

        }

                int iCount = 0;

                while( it.hasNext() && !process.getTaskMonitor().isCanceled()) {

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

                        List geomList = feature.getGeometries();

            if (status != null && process != null) {

                status.setCurValue(iCount);

                process.setProgress(iCount, numberOfFeatures);

            }

                        iCount ++;

                        if(geomList == null) {

                                org.gvsig.fmap.geom.Geometry geom = feature.getDefaultGeometry();

                                invoke(geom, feature);

                                continue;

                        }

                        Iterator<org.gvsig.fmap.geom.Geometry> itGeom = geomList.iterator();

                        boolean first = true;

                        EditableFeature editFeat = null;

                        while(itGeom.hasNext() && !process.getTaskMonitor().isCanceled()) {

                                org.gvsig.fmap.geom.Geometry g = itGeom.next();

                                if(first) {

                                        editFeat = invoke(g, feature);

                                        first = false;

                                } else

                                        invoke(g, editFeat);

                        }

                }

                if(closeOutStore && persister != null)

                        persister.end();

        }

        /**

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

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

         * @throws DataException

         */

        public void computesFeatureOperation(FeatureStore inFeatStore,

                                                                        FeatureStore outFeatStore,

                                                                        String[] attrNames,

                                                                        boolean selectedGeom,

                                                                        boolean closeOutStore) throws DataException {

                this.inFeatureStore = inFeatStore;

                this.selectedGeom = selectedGeom;

                FeatureSet featuresSet = null;

                featuresSet = inFeatStore.getFeatureSet();

                if(outFeatStore != null)

                        setFeatureStore(outFeatStore, attrNames);

                DisposableIterator it = null;

                if(selectedGeom) {

                        DataSet ds = inFeatStore.getSelection();

            it = ((FeatureSelection) ds).fastIterator();

                } else

                        it = featuresSet.fastIterator();

                numberOfFeatures = (int)featuresSet.getSize();

                if (status != null && process != null) {

            status.setRangeOfValues(0, numberOfFeatures);

            process.setProgress(0, numberOfFeatures);

        }

                int iCount = 0;

                while( it.hasNext() && !process.getTaskMonitor().isCanceled()) {

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

                        invoke(null, feature);

                        if (status != null && process != null) {

                                status.setCurValue(iCount);

                                process.setProgress(iCount, numberOfFeatures);

                        }

                        iCount ++;

                }

                if(closeOutStore && persister != null)

                        persister.end();

        }

        /**

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

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

         * @param inFeatStoreList

         *        Input FeatureStore list

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

         * @throws DataException

         */

        public void computesGeometryOperationInAList(ArrayList<FeatureStore> inFeatStoreList,

                                                                        FeatureStore outFeatStore,

                                                                        String[] attrNames,

                                                                        boolean selectedGeom,

                                                                        boolean closeOutStore) throws DataException {

                this.inFeatureStoreList = inFeatStoreList;

                if (status != null && process != null) {

            status.setRangeOfValues(0, inFeatStoreList.size());

            process.setProgress(0, inFeatStoreList.size());

        }

                int iCount = 0;

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

                        if (status != null && process != null) {

                                status.setCurValue(iCount);

                                process.setProgress(iCount, numberOfFeatures);

                        }

                        iCount ++;

                        computesGeometryOperation(inFeatStoreList.get(i), 

                                                                                i == 0 ? outFeatStore : null, 

                                                                                attrNames, 

                                                                                selectedGeom, 

                                                                                false);

                        if(process.getTaskMonitor().isCanceled())

                                return;

                }

        if (closeOutStore && persister != null) {

                        persister.end();

        }

        }

        /**

         * Ends the edition and closes the FeatureStore

         * @deprecated

         */

        public void end() {

                persister.end();

        }

    /**

     * @deprecated use {@link #setTaskStatus(SimpleTaskStatus)} instead.

     */

        public void setProgressModel(IProgressModel pModel) {

        // Ignore

        }

    public void setTaskStatus(SimpleTaskStatus status) {

        this.status = status;

    }

    public void setGeoProcess(AbstractSextanteGeoProcess geoprocess, int size) {

                this.process = geoprocess;

                this.procesSize = size;

        }

}