Application: gvSIG desktop » gvSIG Linear Reference System

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2015 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.lrs.swing.impl;

import java.awt.Component;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.ItemEvent;

import java.awt.event.ItemListener;

import java.io.File;

import java.util.Locale;

import javax.swing.ComboBoxModel;

import javax.swing.DefaultComboBoxModel;

import javax.swing.DefaultListCellRenderer;

import javax.swing.JComponent;

import javax.swing.JLabel;

import javax.swing.JList;

import javax.swing.JOptionPane;

import javax.swing.ListCellRenderer;

import org.apache.commons.io.FileUtils;

import org.apache.commons.lang3.StringUtils;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.DataParameters;

import org.gvsig.fmap.dal.DataServerExplorer;

import org.gvsig.fmap.dal.DataServerExplorerParameters;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.NewDataStoreParameters;

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

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

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

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

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

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

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

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.dal.feature.NewFeatureStoreParameters;

import org.gvsig.fmap.dal.serverexplorer.filesystem.spi.FilesystemServerExplorerProvider;

import org.gvsig.fmap.dal.store.shp.SHPNewStoreParameters;

import org.gvsig.fmap.geom.DataTypes;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.Geometry.SUBTYPES;

import org.gvsig.fmap.geom.Geometry.TYPES;

import org.gvsig.fmap.geom.GeometryException;

import org.gvsig.fmap.geom.GeometryLocator;

import org.gvsig.fmap.mapcontext.layers.FLayer;

//import org.gvsig.fmap.mapcontext.layers.FLayers;

import org.gvsig.fmap.mapcontext.layers.operations.LayerCollection;

import org.gvsig.fmap.mapcontext.layers.vectorial.FLyrVect;

import org.gvsig.lrs.lib.api.LrsAlgorithmParams;

import org.gvsig.lrs.lib.api.LrsAlgorithmsLocator;

import org.gvsig.lrs.lib.api.LrsAlgorithmsManager;

import org.gvsig.lrs.lib.api.LrsCalibrateRouteAlgorithmParams;

import org.gvsig.lrs.lib.api.LrsCoordinatesPriority;

import org.gvsig.lrs.lib.api.LrsCreateRouteAlgorithmParams;

import org.gvsig.lrs.lib.api.LrsSourceOfMeasures;

import org.gvsig.lrs.lib.api.exceptions.LrsGettingParametersException;

import org.gvsig.lrs.lib.api.exceptions.LrsNeededParameterException;

import org.gvsig.lrs.swing.api.JLrsAlgorithmParams;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynClass;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.exception.DynFieldNotFoundException;

import org.gvsig.tools.dynobject.exception.DynMethodException;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.locator.LocatorException;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.case1.model.Projection;

import org.gvsig.tools.persistence.exception.PersistenceException;

import org.gvsig.tools.swing.api.ActionListenerSupport;

import org.gvsig.tools.swing.api.ToolsSwingLocator;

import org.gvsig.tools.swing.api.threadsafedialogs.ThreadSafeDialogsManager;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * @author fdiaz

 *

 */

public class JLrsCreateRouteParamsController extends JLrsCreateRouteParamsView implements JLrsAlgorithmParams {

    /**

     *

     */

    private static final long serialVersionUID = 273909136196706713L;

    private static final Logger logger = LoggerFactory.getLogger(JLrsCreateRouteParamsController.class);

    private boolean canceled;

    private ActionListenerSupport listeners = ToolsSwingLocator.getToolsSwingManager().createActionListenerSupport();

    private LayerCollection layers;

    /**

     * @param layers

     * @throws LrsNeededParameterException

     *

     */

    public JLrsCreateRouteParamsController(LayerCollection layers, LrsAlgorithmParams params) throws LrsNeededParameterException {

        super();

        this.layers = layers;

        initComponents();

        translate();

        setParams(params);

    }

    public void addActionListener(ActionListener listener) {

        listeners.addActionListener(listener);

    }

    public void removeActionListener(ActionListener listener) {

        listeners.removeActionListener(listener);

    }

    private void translate() {

        I18nManager i18nManager = ToolsLocator.getI18nManager();

        lblInputLayer.setText(i18nManager.getTranslation(lblInputLayer.getText()));

        lblIdRouteField.setText(i18nManager.getTranslation(lblIdRouteField.getText()));

        lblOutputFile.setText(i18nManager.getTranslation(lblOutputFile.getText()));

        lblMeasureSource.setText(i18nManager.getTranslation(lblMeasureSource.getText()));

        lblFromMeasureField.setText(i18nManager.getTranslation(lblFromMeasureField.getText()));

        lblToMeasureField.setText(i18nManager.getTranslation(lblToMeasureField.getText()));

        lblCoordinatesPriority.setText(i18nManager.getTranslation(lblCoordinatesPriority.getText()));

        lblMeasureFactor.setText(i18nManager.getTranslation(lblMeasureFactor.getText()));

        lblMeasureOffset.setText(i18nManager.getTranslation(lblMeasureOffset.getText()));

        chkIgnoreSpatialGaps.setText(i18nManager.getTranslation(chkIgnoreSpatialGaps.getText()));

        btnBrowser.setText("\u2026");

        btnAccept.setText(i18nManager.getTranslation(btnAccept.getText()));

        btnCancel.setText(i18nManager.getTranslation(btnCancel.getText()));

    }

    /**

     *

     */

    public void setLocate(Locale locale) {

        Locale l = super.getLocale();

        if (!l.equals(locale)) {

            translate();

        }

        super.setLocale(locale);

    }

    /**

     * Validates the layers:

     *  - At least 1 curve layer with at least 1 non-geometrical field

     *  if they are not correct throws an exception

     * @throws LrsNeededParameterException

     */

    public static void validateLayers(LayerCollection layers)throws LrsNeededParameterException {

        logger.debug("Validating layers for Create Route");

        if (layers==null||layers.getLayersCount()<1){

            logger.error("Al least one layer is needed");

            throw new LrsNeededParameterException("at_least_one_layer_needed", null);

        }

        if (!JLrsUtilsController.validateOneCurveLyrOneNonGeomField(layers)){

            logger.error("Impossible to find the layer needed");

            throw new LrsNeededParameterException("impossible_to_find_needed_layer",null);

        }

    }

    /**

     * @throws LrsNeededParameterException

     */

    private void initComponents() throws LrsNeededParameterException {

        validateLayers(layers);

        // Modelos de los combos

        FLayersComboBoxModel inputLayerModel = new FLayersComboBoxModel(this.layers);

        FeatureAttributeDescriptorsComboBoxModel idRouteFieldComboBoxModel =

            new FeatureAttributeDescriptorsComboBoxModel();

        FeatureAttributeDescriptorsComboBoxModel fromMeasureFieldComboBoxModel =

            new FeatureAttributeDescriptorsComboBoxModel();

        FeatureAttributeDescriptorsComboBoxModel toMeasureFieldComboBoxModel =

            new FeatureAttributeDescriptorsComboBoxModel();

        // Renderer para los combos de attributeDescriptors

        ListCellRenderer featureAttributeDescriptorCellRenderer = new FLayersAttributeDescriptorCellRenderer();

        // asignaci?n de renderers y modelos

        cmbIdRouteField.setRenderer(featureAttributeDescriptorCellRenderer);

        cmbFromMeasureField.setRenderer(featureAttributeDescriptorCellRenderer);

        cmbToMeasureField.setRenderer(featureAttributeDescriptorCellRenderer);

        cmbIdRouteField.setModel(idRouteFieldComboBoxModel);

        cmbFromMeasureField.setModel(fromMeasureFieldComboBoxModel);

        cmbToMeasureField.setModel(toMeasureFieldComboBoxModel);

        // renderer para el combo de capas

        ListCellRenderer layerNameCellRenderer=new FLayersLayerNameCellRenderer();

        // renderer para el combo de capas

        cmbInputLayer.setRenderer(layerNameCellRenderer);

        // asignaci?n modelo al combo de capas

        cmbInputLayer.setModel(inputLayerModel);

        // listener del combo de capas para que actualice el resto de

        // componentes

        cmbInputLayer.addItemListener(new ItemListener() {

            public void itemStateChanged(ItemEvent e) {

                Object item = e.getItem();

                if (item instanceof FLyrVect) {

                    FLyrVect layer = (FLyrVect) item;

                    updateLayer(layer);

                }

            }

        });

        ComboBoxModel<LrsSourceOfMeasures> measureSourceModel =

            new DefaultComboBoxModel<LrsSourceOfMeasures>(LrsSourceOfMeasures.values());

        cmbMeasureSource.setModel(measureSourceModel);

        cmbMeasureSource.addItemListener(new ItemListener() {

            public void itemStateChanged(ItemEvent event) {

                if (event.getStateChange() == ItemEvent.SELECTED) {

                    LrsSourceOfMeasures item = (LrsSourceOfMeasures) event.getItem();

                    updateSourceOfMeasures(item);

                }

            }

        });

        ComboBoxModel<LrsCoordinatesPriority> coordinatePriorityModel =

            new DefaultComboBoxModel<LrsCoordinatesPriority>(LrsCoordinatesPriority.values());

        cmbCoordinatePriority.setModel(coordinatePriorityModel);

        txtMeasureFactor.setValue(new Double(1));

        txtMeasureOffset.setValue(new Double(0));

        this.btnBrowser.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent e) {

                doSelectOuputFile();

            }

        });

        this.btnAccept.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent e) {

                canceled = false;

                doClose();

                listeners.fireActionEvent(new ActionEvent(JLrsCreateRouteParamsController.this, 0, "accept"));

            }

        });

        this.btnCancel.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent e) {

                canceled = true;

                doClose();

                listeners.fireActionEvent(new ActionEvent(JLrsCreateRouteParamsController.this, 0, "cancel"));

            }

        });

        setVisibleAceptCancel(false);

        canceled = false;

    }

    private void doSelectOuputFile() {

        final I18nManager i18nManager = ToolsLocator.getI18nManager();

        ThreadSafeDialogsManager manager = ToolsSwingLocator.getThreadSafeDialogsManager();

        File[] files = manager.showSaveFileDialog(i18nManager.getTranslation("output_file"), null);

        if (files != null && files.length > 0) {

            File file = files[0];

            String absolutePath = file.getAbsolutePath();

            if(!StringUtils.endsWithIgnoreCase(absolutePath, ".shp")){

                absolutePath = new StringBuilder().append(absolutePath).append(".shp").toString();

            }

            File outputFile = FileUtils.getFile(absolutePath);

            if(outputFile.exists()) {

                int resp = JOptionPane.showOptionDialog(

                    this.asJComponent(),

                    i18nManager.getTranslation("file_already_exists_do_you_want_overwrite_it"),

                    i18nManager.getTranslation("output_file"),

                    JOptionPane.OK_CANCEL_OPTION,

                    JOptionPane.QUESTION_MESSAGE,

                    null,

                    null,

                    JOptionPane.OK_OPTION);

                if (resp == JOptionPane.OK_OPTION){

                    this.txtOutputFile.setText(absolutePath);

                } else {

                    doSelectOuputFile();

                }

            } else {

                this.txtOutputFile.setText(absolutePath);

            }

        }

    }

    private void doClose() {

        this.setVisible(false);

    }

    public boolean isCanceled() {

        return this.canceled;

    }

    public void setVisibleAceptCancel(boolean visible) {

        this.btnAccept.setVisible(visible);

        this.btnCancel.setVisible(visible);

    }

    public boolean getVisibleAceptCancel() {

        return this.btnAccept.isVisible();

    }

    public JComponent asJComponent() {

        return this;

    }

    public LrsAlgorithmParams getParams() throws LrsGettingParametersException, LrsNeededParameterException {

        LrsAlgorithmsManager manager = LrsAlgorithmsLocator.getLrsAlgorithmsManager();

        LrsCreateRouteAlgorithmParams params = manager.createLrsCreateRouteAlgorithmParams();

        // Recorrer todo del interfaz y rellenar los parametros

      //cmbInputLayer

        if (!(this.cmbInputLayer.getSelectedItem() instanceof FLyrVect)){

            logger.error("Error getting selected item from cmbInputLayer");

            throw new LrsGettingParametersException("error_getting_selected_item_from_cmbInputLayer", null);

        }

        FLyrVect fLyrVect = (FLyrVect) this.cmbInputLayer.getSelectedItem();

        IProjection projection= fLyrVect.getProjection();

        if (!(fLyrVect.getFeatureStore() instanceof FeatureStore)){

            logger.error("Error getting selected item from cmbInputLayer");

            throw new LrsGettingParametersException("error_getting_selected_item_from_cmbInputLayer", null);

        }

        FeatureStore sourceFeatureStore = (FeatureStore)fLyrVect.getFeatureStore();

        if (sourceFeatureStore == null) {

            throw new LrsNeededParameterException("need_to_select_a_source_layer", null);

        }

        params.setSourceFeatureStore(sourceFeatureStore);

        //cmbIdRouteField

        if (!(this.cmbIdRouteField.getSelectedItem() instanceof FeatureAttributeDescriptor)){

            logger.error("Error getting selected item from cmbIdRouteField");

            throw new LrsGettingParametersException("error_getting_selected_item_from_cmbIdRouteField", null);

        }

        FeatureAttributeDescriptor idRouteField = (FeatureAttributeDescriptor) this.cmbIdRouteField.getSelectedItem();

        if (idRouteField == null) {

            throw new LrsNeededParameterException("need_to_select_a_route_identifier_field", null);

        }

        params.setIdRouteField(idRouteField);

        //OutputStore

        String outputLayerPathFile = this.txtOutputFile.getText();

        if(StringUtils.isEmpty(outputLayerPathFile)){

            throw new LrsNeededParameterException("need_to_fill_the_target_path", null);

        }

        try {

            NewFeatureStoreParameters newFeatureStoreParams=JLrsUtilsController.createFeatureStoreParams(outputLayerPathFile, projection);

            params.setNewFeatureStoreParameters(newFeatureStoreParams);

        } catch (Exception e) {

            throw new LrsNeededParameterException("error_creating_outputStore", e);

        }

        LrsSourceOfMeasures measureSources = (LrsSourceOfMeasures) this.cmbMeasureSource.getSelectedItem();

        FeatureAttributeDescriptor fromMeasureField = (FeatureAttributeDescriptor) this.cmbFromMeasureField.getSelectedItem();

        FeatureAttributeDescriptor toMeasureField = (FeatureAttributeDescriptor) this.cmbToMeasureField.getSelectedItem();

        params.setSourceOfMeasures(measureSources);

        switch (measureSources) {

        case ONE_FIELD:

            if (fromMeasureField == null) {

                throw new LrsNeededParameterException("need_to_select_a_length_measure_field", null);

            }

            params.setFromMeasureField((FeatureAttributeDescriptor) this.cmbFromMeasureField.getSelectedItem());

            params.setToMeasureField(null);

            break;

        case TWO_FIELDS:

            if (fromMeasureField == null) {

                throw new LrsNeededParameterException("need_to_select_a_from_measure_field", null);

            }

            params.setFromMeasureField((FeatureAttributeDescriptor) this.cmbFromMeasureField.getSelectedItem());

            if (toMeasureField == null) {

                throw new LrsNeededParameterException("need_to_select_a_to_measure_field", null);

            }

            params.setToMeasureField((FeatureAttributeDescriptor) this.cmbToMeasureField.getSelectedItem());

            break;

        case LENGTH:

        default:

            params.setFromMeasureField(null);

            params.setToMeasureField(null);

            break;

        }

        params.setCoordinatePriority((LrsCoordinatesPriority) this.cmbCoordinatePriority.getSelectedItem());

        Object measureFactor = this.txtMeasureFactor.getValue();

        if (measureFactor!=null && measureFactor instanceof Double){

            params.setMeasureFactor((Double)measureFactor);

        }else {

            params.setMeasureFactor(0);

        }

        Object measureOffset = this.txtMeasureOffset.getValue();

        if (measureOffset!=null && measureOffset instanceof Double){

            params.setMeasureOffset((Double)measureOffset);

        }else {

            params.setMeasureOffset(0);

        }

        params.setIgnoreSpatialGaps(this.chkIgnoreSpatialGaps.isSelected());

        return params;

    }

    public void setParams(LrsAlgorithmParams params) {

        if (params == null) {

            clear();

            return;

        }

        // Rellena los campos con los valores de params

        LrsCreateRouteAlgorithmParams parameters = (LrsCreateRouteAlgorithmParams) params;

        this.cmbMeasureSource.setSelectedItem(parameters.getSourceOfMeasures());

        this.cmbCoordinatePriority.setSelectedItem(parameters.getCoordinatePriority());

        FeatureStore sourceFeatureStore = parameters.getSourceFeatureStore();

        if(layers!=null && sourceFeatureStore!=null){

            FLayer layer = layers.getLayer(sourceFeatureStore.getName());

            this.cmbInputLayer.setSelectedItem(layer);

        }

        NewFeatureStoreParameters newFeatureStoreParameters = parameters.getNewFeatureStoreParameters();

        if(newFeatureStoreParameters instanceof SHPNewStoreParameters){

            this.txtOutputFile.setText(((SHPNewStoreParameters)newFeatureStoreParameters).getSHPFile().getAbsolutePath());

        }

        this.cmbIdRouteField.setSelectedItem(parameters.getIdRouteField());

        this.cmbFromMeasureField.setSelectedItem(parameters.getFromMeasureField());

        this.cmbToMeasureField.setSelectedItem(parameters.getToMeasureField());

        this.txtMeasureFactor.setValue(parameters.getMeasureFactor());

        this.txtMeasureOffset.setValue(parameters.getMeasureOffset());

    }

    public void clear() {

        this.txtOutputFile.setText("");

        this.txtMeasureFactor.setValue(1.0);

        this.txtMeasureOffset.setValue(0.0);

        this.cmbMeasureSource.setSelectedIndex(0);

        this.cmbFromMeasureField.setEnabled(false);

        this.cmbToMeasureField.setEnabled(false);

        this.cmbCoordinatePriority.setSelectedIndex(0);

        Object inputLayerSelected = this.cmbInputLayer.getSelectedItem();

        if (inputLayerSelected != null) {

            this.updateLayer((FLyrVect) inputLayerSelected);

        }

        Object measureSourceSelected = this.cmbMeasureSource.getSelectedItem();

        if (measureSourceSelected != null) {

            this.updateSourceOfMeasures((LrsSourceOfMeasures) measureSourceSelected);

        }

    }

    private void updateLayer(FLyrVect layer) {

        logger.info(new StringBuilder().append("Setting layer ").append(layer.getName()).toString());

        FeatureStore featureStore = layer.getFeatureStore();

        try {

            FeatureType type = featureStore.getDefaultFeatureType();

            // Se renuevan los combos de attributeDescriptors

            FeatureAttributeDescriptorsComboBoxModel idRouteFieldComboBoxModel =

                new FeatureAttributeDescriptorsComboBoxModel();

            FeatureAttributeDescriptorsComboBoxModel fromMeasureFieldComboBoxModel =

                new FeatureAttributeDescriptorsComboBoxModel();

            FeatureAttributeDescriptorsComboBoxModel toMeasureFieldComboBoxModel =

                new FeatureAttributeDescriptorsComboBoxModel();

            this.cmbIdRouteField.setModel(idRouteFieldComboBoxModel);

            this.cmbFromMeasureField.setModel(fromMeasureFieldComboBoxModel);

            this.cmbToMeasureField.setModel(toMeasureFieldComboBoxModel);

            FeatureAttributeDescriptor[] attributeDescriptors = type.getAttributeDescriptors();

            for (int i = 0; i < attributeDescriptors.length; i++) {

                FeatureAttributeDescriptor featureAttributeDescriptor = attributeDescriptors[i];

                if (featureAttributeDescriptor.getDataType().getType() != DataTypes.GEOMETRY) {

                    logger.info(new StringBuilder().append("Adding field ")

                        .append(featureAttributeDescriptor.getName()).toString());

                    JLrsCreateRouteParamsController.this.cmbIdRouteField.addItem(featureAttributeDescriptor);

                    if (featureAttributeDescriptor.getDataType().isNumeric()) {

                        JLrsCreateRouteParamsController.this.cmbFromMeasureField.addItem(featureAttributeDescriptor);

                        JLrsCreateRouteParamsController.this.cmbToMeasureField.addItem(featureAttributeDescriptor);

                    }

                }

            }

            this.cmbIdRouteField.invalidate();

            this.cmbFromMeasureField.invalidate();

            this.cmbToMeasureField.invalidate();

        } catch (DataException e1) {

            logger.warn(

                new StringBuilder().append("Error getting default feature type from layer ").append(layer.getName())

                    .toString(), e1);

        }

    }

    private void updateSourceOfMeasures(LrsSourceOfMeasures item) {

        switch (item) {

        case LENGTH:

            cmbFromMeasureField.setEnabled(false);

            cmbToMeasureField.setEnabled(false);

            chkIgnoreSpatialGaps.setEnabled(true);

            break;

        case ONE_FIELD:

            cmbFromMeasureField.setEnabled(true);

            cmbToMeasureField.setEnabled(false);

            chkIgnoreSpatialGaps.setEnabled(true);

            break;

        case TWO_FIELDS:

            cmbFromMeasureField.setEnabled(true);

            cmbToMeasureField.setEnabled(true);

            chkIgnoreSpatialGaps.setEnabled(false);

            break;

        default:

            break;

        }

    }

}