Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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 3 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.app.extension;

import java.awt.BorderLayout;

import java.awt.FlowLayout;

import java.awt.event.ActionEvent;

import java.util.Iterator;

import javax.swing.AbstractAction;

import javax.swing.JButton;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import org.gvsig.andami.IconThemeHelper;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.messages.NotificationManager;

import org.gvsig.andami.plugins.Extension;

import org.gvsig.app.ApplicationLocator;

import org.gvsig.app.ApplicationManager;

import org.gvsig.app.gui.filter.ExpressionListener;

import org.gvsig.app.gui.filter.FilterDialog;

import org.gvsig.app.project.documents.view.ViewDocument;

import org.gvsig.app.project.documents.view.gui.IView;

import org.gvsig.expressionevaluator.Expression;

import org.gvsig.expressionevaluator.swing.ExpressionEvaluatorSwingLocator;

import org.gvsig.expressionevaluator.swing.ExpressionEvaluatorSwingManager;

import org.gvsig.expressionevaluator.swing.JExpressionBuilder;

import org.gvsig.expressionevaluator.swing.Element;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

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

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

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

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

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

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

import org.gvsig.fmap.dal.swing.DataSwingManager;

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

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

import org.gvsig.i18n.Messages;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.i18n.I18nManager;

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

import org.gvsig.tools.swing.api.windowmanager.WindowManager;

import org.gvsig.utils.exceptionHandling.ExceptionListener;

/**

 * Extensi?n que abre un di?logo para poder hacer un filtro de una capa o tabla.

 *

 * @author Vicente Caballero Navarro

 */

@SuppressWarnings("UseSpecificCatch")

public class SelectByAttributesExtension extends Extension implements ExpressionListener {

    protected FeatureStore featureStore = null;

    private String filterTitle;

    @Override

    public void initialize() {

        IconThemeHelper.registerIcon("action", "selection-by-attributes", this);

    }

    @Override

    public void execute(String actionCommand) {

        ApplicationManager application = ApplicationLocator.getManager();

        IView view = (IView) application.getActiveComponent(ViewDocument.class);

        if (view == null) {

            return;

        }

        if ("selection-by-attributes-layer2".equals(actionCommand)) {

            ViewDocument document = view.getViewDocument();

            FLayer layer = document.getMapContext().getLayers().getActives()[0];

            filterTitle = layer.getName();

            featureStore = ((FLyrVect) layer).getFeatureStore();

            document.setModified(true);

            doSelectByAttributes2(filterTitle, featureStore);

        } else if ("selection-by-attributes-layer".equals(actionCommand)) {

            ViewDocument document = view.getViewDocument();

            FLayer layer = document.getMapContext().getLayers().getActives()[0];

            filterTitle = layer.getName();

            featureStore = ((FLyrVect) layer).getFeatureStore();

            document.setModified(true);

            doExecute();

        }

    }

    /**

     * "execute" method action.

     *

     */

    protected void doExecute() {

        FilterDialog dlg = new FilterDialog(filterTitle);

        dlg.addExpressionListener(this);

        dlg.addExceptionListener(new ExceptionListener() {

            @Override

            public void exceptionThrown(Throwable t) {

                NotificationManager.addError(t.getMessage(), t);

            }

        });

        dlg.setModel(featureStore);

        PluginServices.getMDIManager().addWindow(dlg);

    }

    @Override

    public boolean isEnabled() {

        return true;

    }

    @Override

    public boolean isVisible() {

        ApplicationManager application = ApplicationLocator.getManager();

        IView view = (IView) application.getActiveComponent(ViewDocument.class);

        if (view == null) {

            return false;

        }

        ViewDocument document = view.getViewDocument();

        return document.getMapContext().hasActiveVectorLayers();

    }

    // By Pablo: if no filter expression -> no element selected

    @Override

    public void newSet(String expression) throws DataException {

        if (!this.filterExpressionFromWhereIsEmpty(expression)) {

            FeatureSet set = null;

            try {

                set = doSet(expression);

                if (set == null) {

                    // throw new RuntimeException("Not a 'where' clause?");

                    return;

                }

                featureStore.setSelection(set);

            } catch (Exception e) {

                JOptionPane.showMessageDialog(

                        ApplicationLocator.getManager().getRootComponent(),

                        Messages.getText("expresion_error") + ":\n"

                        + getLastMessage(e),

                        Messages.getText("expresion_error"),

                        JOptionPane.ERROR_MESSAGE);

            } finally {

                if (set != null) {

                    set.dispose();

                }

            }

        } else {

            // By Pablo: if no expression -> no element selected

            featureStore.getFeatureSelection().deselectAll();

        }

    }

    private FeatureSet doSet(String expression) throws DataException {

        FeatureQuery query = featureStore.createFeatureQuery();

        DataManager manager = DALLocator.getDataManager();

        query.setFilter(manager.createExpresion(expression));

        return featureStore.getFeatureSet(query);

    }

    @Override

    public void addToSet(String expression) throws DataException {

        // By Pablo: if no filter expression -> don't add more elements to set

        if (!this.filterExpressionFromWhereIsEmpty(expression)) {

            FeatureSet set = null;

            try {

                set = doSet(expression);

                if (set == null) {

                    // throw new RuntimeException("Not a 'where' clause?");

                    return;

                }

                featureStore.getFeatureSelection().select(set);

            } finally {

                if (set != null) {

                    set.dispose();

                }

            }

        }

    }

    @Override

    public void fromSet(String expression) throws DataException {

        // By Pablo: if no filter expression -> no element selected

        try {

            if (!this.filterExpressionFromWhereIsEmpty(expression)) {

                // NotificationManager.showMessageInfo("Falta por implementar",

                // null);

                FeatureSet set;

                set = doSet(expression);

                if (set == null) {

                    throw new RuntimeException("Not a 'where' clause?");

                }

                FeatureSelection oldSelection

                        = featureStore.getFeatureSelection();

                FeatureSelection newSelection

                        = featureStore.createFeatureSelection();

                Iterator iterator = set.iterator();

                while (iterator.hasNext()) {

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

                    if (oldSelection.isSelected(feature)) {

                        newSelection.select(feature);

                    }

                }

                featureStore.setSelection(newSelection);

                set.dispose();

            } else {

                // By Pablo: if no expression -> no element selected

                featureStore.getFeatureSelection().deselectAll();

            }

        } catch (DataException e) {

            NotificationManager.addError(e);

        }

    }

    /**

     * Returns true if the WHERE subconsultation of the filterExpression is

     * empty ("")

     *

     * @author Pablo Piqueras Bartolom? (p_queras@hotmail.com)

     * @param expression An string

     * @return A boolean value

     */

    private boolean filterExpressionFromWhereIsEmpty(String expression) {

        if (expression == null) {

            return true;

        }

        String subExpression = expression.trim();

        if (subExpression.length() == 0) {

            return true;

        }

        int pos;

        // Remove last ';' if exists

        if (subExpression.charAt(subExpression.length() - 1) == ';') {

            subExpression

                    = subExpression.substring(0, subExpression.length() - 1).trim();

        }

        // If there is no 'where' clause

        if ((pos = subExpression.indexOf("where")) == -1) {

            return false;

        }

        // If there is no subexpression in the WHERE clause -> true

        // + 5 is the length of 'where'

        subExpression = subExpression.substring(pos + 5, subExpression.length()).trim();

        if (subExpression.length() == 0) {

            return true;

        } else {

            return false;

        }

    }

    private String getLastMessage(Throwable ex) {

        Throwable p = ex;

        while (p.getCause() != null && p.getCause() != p) {

            p = p.getCause();

        }

        return p.getMessage();

    }

    private void doSelectByAttributes2(String title, final FeatureStore store) {

        I18nManager i18n = ToolsLocator.getI18nManager();

        WindowManager windowManager = ToolsSwingLocator.getWindowManager();

        ExpressionEvaluatorSwingManager swingManager = ExpressionEvaluatorSwingLocator.getManager();

        final JPanel panel = new JPanel();

        panel.setLayout(new BorderLayout());

        final JExpressionBuilder builder = swingManager.createJExpressionBuilder();

        builder.addSymbolTable(DataManager.FEATURE_SYMBOL_TABLE);

        Element element = swingManager.createElement(

                DataSwingManager.FEATURE_STORE_EXPRESSION_ELEMENT,

                builder,

                store

        );

        if (element != null) {

            builder.getElements().add(element);

        }

        panel.add(builder.asJComponent(), BorderLayout.CENTER);

        JPanel buttons = new JPanel();

        buttons.setLayout(new FlowLayout(FlowLayout.RIGHT, 4, 4));

        buttons.add(new JButton(new AbstractAction(i18n.getTranslation("_Set_selection")) {

            @Override

            public void actionPerformed(ActionEvent e) {

                doSetSelection(store, builder.getExpression());

            }

        }));

        buttons.add(new JButton(new AbstractAction(i18n.getTranslation("_Add_to_selection")) {

            @Override

            public void actionPerformed(ActionEvent e) {

                doAddToSelection(store, builder.getExpression());

            }

        }));

        buttons.add(new JButton(new AbstractAction(i18n.getTranslation("_Filter_selection")) {

            @Override

            public void actionPerformed(ActionEvent e) {

                doFilterSelection(store, builder.getExpression());

            }

        }));

        buttons.add(new JButton(new AbstractAction(i18n.getTranslation("_Close")) {

            @Override

            public void actionPerformed(ActionEvent e) {

                panel.setVisible(false);

            }

        }));

        panel.add(buttons, BorderLayout.SOUTH);

        windowManager.showWindow(

                panel,

                title,

                WindowManager.MODE.WINDOW

        );

    }

    private void doSetSelection(FeatureStore store, Expression expression) {

        try {

            DataManager manager = DALLocator.getDataManager();

            FeatureSelection currentSelection = store.getFeatureSelection();

            FeatureQuery query = store.createFeatureQuery();

            query.setFilter(manager.createExpresion(expression));

            FeatureSet selection = store.getFeatureSet(query);

            currentSelection.deselectAll();

            currentSelection.select(selection);

        } catch (Exception ex) {

            logger.warn("Can't build selecction from filter expression.", ex);

        }

    }

    private void doAddToSelection(FeatureStore store, Expression expression) {

        try {

            DataManager manager = DALLocator.getDataManager();

            FeatureSelection currentSelection = store.getFeatureSelection();

            FeatureQuery query = store.createFeatureQuery();

            query.setFilter(manager.createExpresion(expression));

            FeatureSet selection = store.getFeatureSet(query);

            currentSelection.select(selection);

        } catch (Exception ex) {

            logger.warn("Can't build selecction from filter expression.", ex);

        }

    }

    private void doFilterSelection(FeatureStore store, Expression expression) {

        try {

            DataManager manager = DALLocator.getDataManager();

            FeatureSelection currentSelection = store.getFeatureSelection();

            FeatureQuery query = store.createFeatureQuery();

            query.setFilter(manager.createExpresion(expression));

            FeatureSet set = store.getFeatureSet(query);

            FeatureSelection newSelection = store.createFeatureSelection();

            for (Feature feature : set) {

                if( currentSelection.isSelected(feature) ) {

                    newSelection.select(feature);

                }

            }

            store.setSelection(newSelection);

        } catch (Exception ex) {

            logger.warn("Can't build selecction from filter expression.", ex);

        }

    }

}