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.gui.filter;

import java.awt.event.MouseAdapter;

import java.awt.event.MouseEvent;

import java.text.NumberFormat;

import java.text.ParseException;

import java.util.ArrayList;

import java.util.Collection;

import java.util.Comparator;

import java.util.Date;

import java.util.Iterator;

import java.util.List;

import java.util.TreeSet;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

import javax.swing.JOptionPane;

import javax.swing.tree.DefaultMutableTreeNode;

import javax.swing.tree.DefaultTreeModel;

import org.apache.commons.lang.StringEscapeUtils;

import org.apache.commons.lang3.StringUtils;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.ui.mdiManager.IWindow;

import org.gvsig.andami.ui.mdiManager.IWindowListener;

import org.gvsig.andami.ui.mdiManager.WindowInfo;

import org.gvsig.app.ApplicationLocator;

import org.gvsig.app.ApplicationManager;

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.FeatureQuery;

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

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

import org.gvsig.gui.beans.filterPanel.tableFilterQueryPanel.TableFilterQueryJPanel;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dispose.DisposableIterator;

import org.gvsig.tools.dispose.DisposeUtils;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.utils.DefaultCharSet;

import org.gvsig.utils.StringUtilities;

import org.gvsig.utils.exceptionHandling.ExceptionHandlingSupport;

import org.gvsig.utils.exceptionHandling.ExceptionListener;

/**

 * This class substitutes the old "FilterDialog" class made by

 * "Fernando Gonz?lez Cort?s"

 * The functionality is the same, but now the class is made from separately (and

 * reusable) components

 * 

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

 */

public class FilterDialog extends TableFilterQueryJPanel implements IWindow,

    IWindowListener {

    /**

     * 

     */

    private static final long serialVersionUID = -149317534873551735L;

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

    private FeatureStore model = null;

    private final List<ExpressionListener> expressionListeners = new ArrayList<>();

    private final ExceptionHandlingSupport exceptionHandlingSupport = new ExceptionHandlingSupport();

    private final NumberFormat nf = NumberFormat.getNumberInstance();

    private String title;

    private final int filterDialog_Width = 500;

    private final int filterDialog_Height = 362;

    private final int widthIncrementForAndami = 20; // This is necessary because

                                                    // when the panel is sent to

                                                    // Andami, that needs a bit

                                                    // more width-space to show

                                                    // that panel.

    /**

     * This is the default constructor

     * @param _title

     */

    public FilterDialog(String _title) {

        super();

        title = _title;

        defaultTreeModel = (DefaultTreeModel) fieldsJTree.getModel();

    }

    /**

     * This is the default constructor

     */

    public FilterDialog() {

        super();

        defaultTreeModel = (DefaultTreeModel) fieldsJTree.getModel();

    }

    /*

     * (non-Javadoc)

     * 

     * @see

     * org.gvsig.gui.beans.filterPanel.AbstractFilterQueryJPanel#initialize()

     */

    @Override

    protected void initialize() {

        super.initialize();

        super.resizeHeight(filterDialog_Height);

        super.resizeWidth(filterDialog_Width - widthIncrementForAndami);

        this.addNewListeners();

    }

    /**

     * Adds some listeners

     */

    private void addNewListeners() {

        // Listener for "btnAdd"

        // Adds more elements to the current set

        getBtnAddToCurrentSet().addActionListener(

                new java.awt.event.ActionListener() {

                    @Override

                    public void actionPerformed(java.awt.event.ActionEvent e) {

                        final String expr = getTxtExpression().getText();

                        if (!validateQuotes(expr) || !validateLike(expr)) {

                            return;

                        }

                        PluginServices.backgroundExecution(new Runnable() {

                            @Override

                            public void run() {

                                for (ExpressionListener l : expressionListeners) {

                                    try {

                                        l.addToSet(expr);

                                    } catch (DataException e) {

                                        logger.warn("Can't add expression '"+expr+"' to set.", e);

                                    }

                                }

                            }

                        });

                    }

                });

        // Listener for "btnNuevo"

        // Adds a new set

        getBtnNewSet().addActionListener(new java.awt.event.ActionListener() {

            @Override

            public void actionPerformed(java.awt.event.ActionEvent e) {

                final String expr = getTxtExpression().getText();

                if (!validateQuotes(expr) || !validateLike(expr)) {

                    return;

                }

                PluginServices.backgroundExecution(new Runnable() {

                    @Override

                    public void run() {

                        for (ExpressionListener l : expressionListeners) {

                            try {

                                l.newSet(expr);

                            } catch (DataException e) {

                                logger.warn("Can't create set with expression '"+expr+"'.", e);

                            }

                        }

                    }

                });

            }

        });

        // Listener for "btnFromSet"

        // Selects elements from the current filtered selection

        getBtnFromSet().addActionListener(new java.awt.event.ActionListener() {

            @Override

            public void actionPerformed(java.awt.event.ActionEvent e) {

                final String expr = getTxtExpression().getText();

                if (!validateQuotes(expr) || !validateLike(expr) ) {

                    return;

                }

                PluginServices.backgroundExecution(new Runnable() {

                    @Override

                    public void run() {

                        for (ExpressionListener l : expressionListeners) {

                            try {

                                l.fromSet(expr);

                            } catch (DataException e) {

                                logger.warn("Can't create expression '"+expr+"' from set.", e);

                            }

                        }

                    }

                });

            }

        });

        // Listener for "fieldsJTree"

        getFieldsJTree().addMouseListener(new MouseAdapter() {

            @Override

            public void mouseClicked(MouseEvent e) {

                int row = fieldsJTree.getRowForLocation(e.getX(), e.getY());

                if (row > -1) {

                    switch (e.getClickCount()) {

                        case 1:

                            fillValues(row);

                            break;

                        case 2:

                            putSymbol(jtreeRoot.getChildAt(row).toString());

                            break;

                    }

                }

            }

        });

        // Listener for "valuesJList"

        getValuesJList().addMouseListener(new MouseAdapter() {

            @Override

            public void mouseClicked(MouseEvent e) {

                if (e.getClickCount() == 2) {

                    Object valor = valuesListModel.getElementAt(getValuesJList()

                            .getSelectedIndex());

                    if (valor == null) {

                        putSymbol("null");

                    } else if (valor instanceof Date) {

                        putSymbol("date('" + valor + "')");

                    } else if (valor instanceof Boolean) {

                        putSymbol(valor.toString());

                    } else if (valor instanceof String) {

                        // putSymbol("'" + StringEscapeUtils.escapeSql((String) valor) + "'");

                        putSymbol("'" + ((String)valor).replace('\'', '?') + "'");

                    } else {

                        putSymbol(StringEscapeUtils.escapeSql(valor.toString()));

                    }

                }

            }

        });

    }

    private boolean validateQuotes(String expr) {

        if ((StringUtils.countMatches(expr, "'") % 2) != 0) {

            ApplicationManager application = ApplicationLocator.getManager();

            I18nManager i18n = ToolsLocator.getI18nManager();

            String msg = i18n.getTranslation("_The_number_of_quotes_is_doubtful_It_could_be_that_some_of_them_should_escape_Do_you_want_to_continue_the_operation_anyway");

            int resp = application.confirmDialog(

                    msg,

                    i18n.getTranslation("_Caution"),

                    JOptionPane.YES_NO_OPTION,

                    JOptionPane.QUESTION_MESSAGE,

                    "Doubtless number of quotes in the filter dialog"

            );

            if (resp == JOptionPane.NO_OPTION) {

                return false;

            }

        }

        return true;

    }

    private boolean validateLike(String expr) {

        if( (expr.toLowerCase().contains("?") || 

                expr.toLowerCase().contains("%")) && 

                !expr.toLowerCase().contains("like") ) 

            {

            ApplicationManager application = ApplicationLocator.getManager();

            I18nManager i18n = ToolsLocator.getI18nManager();

            String msg = i18n.getTranslation("_It_looks_like_youre_using_percent_o_question_and_the_like_operator_is_not_being_used_I_should_probably_keep_the_equal_operator_by_like_Do_you_want_to_continue_anyway");

            int resp = application.confirmDialog(

                    msg,

                    i18n.getTranslation("_Caution"),

                    JOptionPane.YES_NO_OPTION,

                    JOptionPane.QUESTION_MESSAGE,

                    "You may need the like operator in the filter dialog"

            );

            if (resp == JOptionPane.NO_OPTION) {

                return false;

            }

        }

        return true;

    }

    /**

     * Rellena la lista con los valores del campo seleccionado

     */

    private void fillValues(int row) {

        // int index = lstCampos.getSelectedIndex();

        // Index es ahora el ?ndice del campo seleccionado

        // Se eliminan los duplicados

        Collection conjunto = new TreeSet(new Comparator() {

            public int compare(Object o1, Object o2) {

                return ((Comparable) o1).compareTo(o2);

            }

        }); // Para poder ordenar

        valuesListModel.clear();

        FeatureSet fs = null;

        DisposableIterator iterator = null;

        try {

            String[] fieldName =

                new String[] { ((FeatureAttributeDescriptor) model

                    .getDefaultFeatureType().get(row)).getName() };

            FeatureQuery query = model.createFeatureQuery();

            query.setAttributeNames(fieldName);

            fs = model.getFeatureSet(query);

            iterator = fs.fastIterator();

            while (iterator.hasNext()) {

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

                Object value = feature.get(fieldName[0]);

                if (value == null) {

                    continue;

                }

                conjunto.add(value);

            }

            Iterator it = conjunto.iterator();

            while (it.hasNext()) {

                valuesListModel.addElement(it.next());

            }

        } catch (DataException e) {

            throwException(e);

        } finally {

            DisposeUtils.dispose(iterator);

            DisposeUtils.dispose(fs);

        }

    }

    /**

     * DOCUMENT ME!

     * 

     * @param t

     *            DOCUMENT ME!

     */

    public void setModel(FeatureStore t) {

        // try {

        model = t;

        // model.start();

        // } catch (ReadException e1) {

        // NotificationManager.addError(e1.getMessage(), e1);

        // }

        jtreeRoot.removeAllChildren();

        try {

            Iterator attributes = model.getDefaultFeatureType().iterator();

            while (attributes.hasNext()) {

                FeatureAttributeDescriptor descriptor =

                    (FeatureAttributeDescriptor) attributes.next();

                Object field = descriptor.getName();

                if (field != null) {

                    jtreeRoot.add(new DefaultMutableTreeNode(field.toString()));

                }

            }

            // for (int i = 0; i < model.getFieldCount(); i++) {

            // Object field = model.getFieldName(i);

            //

            // if (field != null) {

            // jtreeRoot.add(new DefaultMutableTreeNode(field.toString()));

            // }

            // }

            defaultTreeModel.setRoot(jtreeRoot);

        } catch (DataException e) {

            throwException(e);

        }

    }

    /**

     * DOCUMENT ME!

     * 

     * @return DOCUMENT ME!

     * 

     * @throws ParseException

     *             DOCUMENT ME!

     */

    private String validateExpression() throws ParseException {

        String expression = txtExpression.getText();

        // HashSet variablesIndexes = new HashSet();

        //

        // StringBuffer traducida = new StringBuffer();

        // Se transforman los nombres de los campos en las variables xix que

        // analizar?n

        // Se quitan los Date(fecha) y se mete la fecha correspondiente

        expression = translateDates(expression);

        expression = translateNumber(expression);

        expression = translateWord(expression, "true", "1");

        expression = translateWord(expression, "false", "0");

        String replacement;

        Pattern patron = Pattern.compile("[^<>!]=");

        Matcher m = patron.matcher(expression);

        int index = 0;

        while (m.find(index)) {

            index = m.start();

            replacement = expression.charAt(index) + "==";

            m.replaceFirst(replacement);

            index++;

        }

        expression = expression.replaceAll("[^<>!]=", "==");

        logger.debug(expression);

        return expression;

    }

    /**

     * Redefinition of the 'putSymbol' method of AbstractFilterQueryJPanel

     * (I've made this redefinition for write the same code as the 'putSymbol'

     * code of the original class (FilterDialog) that was in this project

     * (appgvSIG) and didn't has path troubles to find 'StringUtilities').

     * 

     * Sets a symbol on the filter expression (JTextArea that stores and shows

     * the current filter expression)

     * 

     * @param symbol

     *            A symbol: character, characters, number, ...

     */

    @Override

    protected void putSymbol(String symbol) {

        int position = txtExpression.getCaretPosition();

        txtExpression.setText(StringUtilities.insert(txtExpression.getText(),

            position, symbol));

        if (symbol.equals(" () ")) {

            position = position + 2;

        } else {

            position = position + symbol.length();

        }

        txtExpression.setCaretPosition(position);

    }

    /**

     * DOCUMENT ME!

     * 

     * @param expresion

     *            DOCUMENT ME!

     * @param substring

     *            DOCUMENT ME!

     * @param startingPos

     *            DOCUMENT ME!

     * 

     * @return DOCUMENT ME!

     */

    private int getIndex(String expresion, String substring, int startingPos) {

        int index = startingPos;

        do {

            index = expresion.indexOf(substring, index);

        } while ((StringUtilities.isBetweenSymbols(expresion, index, "\""))

            && (index != -1));

        return index;

    }

    /**

     * DOCUMENT ME!

     * 

     * @param expresion

     *            DOCUMENT ME!

     * @param word

     *            DOCUMENT ME!

     * @param translation

     *            DOCUMENT ME!

     * 

     * @return DOCUMENT ME!

     * 

     * @throws ParseException

     *             DOCUMENT ME!

     */

    private String translateWord(String expresion, String word,

        String translation) throws ParseException {

        int booleanIndex = 0;

        int endIndex = 0;

        StringBuffer res = new StringBuffer();

        while ((booleanIndex = getIndex(expresion, word, booleanIndex)) != -1) {

            res.append(expresion.substring(endIndex, booleanIndex));

            endIndex = booleanIndex + word.length();

            booleanIndex++;

            res.append(translation);

        }

        if (endIndex < expresion.length()) {

            res.append(expresion.substring(endIndex));

        }

        return res.toString();

    }

    /**

     * DOCUMENT ME!

     * 

     * @param expresion

     *            DOCUMENT ME!

     * 

     * @return DOCUMENT ME!

     * 

     * @throws ParseException

     *             DOCUMENT ME!

     */

    private String translateDates(String expresion) throws ParseException {

        // Se obtiene el valor de la fecha

        String date =

            StringUtilities.substringDelimited(expresion, "Date(", ")", 0);

        if (date == null) {

            return expresion;

        }

        // Se comprueba que no est? entre comillas

        int startIndex = expresion.indexOf(date);

        while (startIndex != -1) {

            if (!StringUtilities.isBetweenSymbols(expresion, startIndex, "\"")) {

                // Se sustituye por el valor ordinal de la fecha

                expresion =

                    expresion.substring(0, startIndex - 5)

                        + expresion.substring(startIndex).replaceFirst(

                            date + "\\)",

                            new Long((filterButtonsJPanel.getDateFormat()

                                .parse(date)).getTime()).toString());

                ;

            } else {

                startIndex += date.length();

            }

            // Se obtiene el valor de la fecha

            /*

             * date = StringUtilities.substringDelimited(expresion, "Date(",

             * ")",

             * startIndex);

             */

            if (date == null) {

                return expresion;

            }

            startIndex = expresion.indexOf(date, startIndex);

        }

        return expresion;

    }

    /**

     * DOCUMENT ME!

     * 

     * @param expresion

     *            DOCUMENT ME!

     * 

     * @return DOCUMENT ME!

     * 

     * @throws ParseException

     *             DOCUMENT ME!

     */

    public String translateNumber(String expresion) throws ParseException {

        DefaultCharSet ss = new DefaultCharSet();

        ss.addInterval('0', '9');

        ss.addCharacter(',');

        ss.addCharacter('.');

        String number = StringUtilities.substringWithSymbols(expresion, ss, 0);

        if (number == null) {

            return expresion;

        }

        int startIndex = expresion.indexOf(number);

        while (startIndex != -1) {

            Number n = nf.parse(number);

            if (!StringUtilities.isBetweenSymbols(expresion, startIndex, "\"")) {

                // Se sustituye por el valor ordinal de la fecha

                expresion =

                    expresion.substring(0, startIndex)

                        + expresion.substring(startIndex).replaceFirst(number,

                            n.toString());

            } else {

                startIndex += n.toString().length();

            }

            number =

                StringUtilities.substringWithSymbols(expresion, ss, startIndex);

            if (number == null) {

                return expresion;

            }

            startIndex = expresion.indexOf(number, startIndex);

        }

        return expresion;

    }

    /**

     * DOCUMENT ME!

     * 

     * @param arg0

     * 

     * @return

     */

    public boolean addExpressionListener(ExpressionListener arg0) {

        return expressionListeners.add(arg0);

    }

    /**

     * DOCUMENT ME!

     * 

     * @param arg0

     * 

     * @return

     */

    public boolean removeExpressionListener(ExpressionListener arg0) {

        return expressionListeners.remove(arg0);

    }

    /**

     * @see com.iver.mdiApp.ui.MDIManager.IWindow#getWindowInfo()

     */

    public WindowInfo getWindowInfo() {

        WindowInfo vi = new WindowInfo(WindowInfo.ICONIFIABLE);

        // if (System.getProperty("os.name")co.compareTo(arg0))

        vi.setHeight(this.filterDialog_Height);

        vi.setWidth(this.filterDialog_Width);

        // Old instructions

        // vi.setWidth(480);

        // vi.setHeight(362);

        vi

            .setTitle(PluginServices.getText(this, "_Selection_by_attributes") + " (" + title

                + ")");

        return vi;

    }

    /**

     * DOCUMENT ME!

     * 

     * @param o

     *            DOCUMENT ME!

     */

    public void addExceptionListener(ExceptionListener o) {

        exceptionHandlingSupport.addExceptionListener(o);

    }

    /**

     * DOCUMENT ME!

     * 

     * @param o

     *            DOCUMENT ME!

     * 

     * @return DOCUMENT ME!

     */

    public boolean removeExceptionListener(ExceptionListener o) {

        return exceptionHandlingSupport.removeExceptionListener(o);

    }

    /**

     * DOCUMENT ME!

     * 

     * @param t

     *            DOCUMENT ME!

     */

    private void throwException(Throwable t) {

        exceptionHandlingSupport.throwException(t);

    }

    /*

     * (non-Javadoc)

     * 

     * @see com.iver.andami.ui.mdiManager.ViewListener#viewActivated()

     */

    public void windowActivated() {

    }

    /*

     * (non-Javadoc)

     * 

     * @see com.iver.andami.ui.mdiManager.ViewListener#viewClosed()

     */

    public void windowClosed() {

        // try {

        // model.stop();

        // } catch (ReadDriverException e) {

        // NotificationManager.addError(e.getMessage(), e);

        // }

    }

    public Object getWindowProfile() {

        return WindowInfo.TOOL_PROFILE;

    }

}