Application: gvSIG desktop » gvSIG legends: base legends

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2020 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.symbology.gui.layerproperties;

import java.awt.BorderLayout;

import java.awt.Dimension;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.io.File;

import java.io.IOException;

import java.util.ArrayList;

import java.util.List;

import javax.swing.BoxLayout;

import javax.swing.ImageIcon;

import javax.swing.JButton;

import javax.swing.JCheckBox;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import org.apache.commons.lang3.StringUtils;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.andami.IconThemeHelper;

import org.gvsig.app.ApplicationLocator;

import org.gvsig.app.project.documents.view.legend.gui.Categories;

import org.gvsig.app.project.documents.view.legend.gui.ILegendPanel;

import org.gvsig.app.project.documents.view.legend.gui.JSymbolPreviewButton;

import org.gvsig.app.project.documents.view.legend.gui.SymbolTable;

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

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

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.mapcontext.layers.FLayer;

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

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

import org.gvsig.fmap.mapcontext.rendering.legend.ILegend;

import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol;

import org.gvsig.gui.beans.swing.GridBagLayoutPanel;

import org.gvsig.gui.beans.swing.JBlank;

import org.gvsig.i18n.Messages;

import org.gvsig.symbology.fmap.mapcontext.rendering.symbol.fill.impl.PictureFillSymbol;

import org.gvsig.symbology.fmap.mapcontext.rendering.symbol.style.IMarkerFillPropertiesStyle;

import org.gvsig.symbology.fmap.rendering.VectorFilterExpressionLegend;

import org.gvsig.symbology.swing.SymbologySwingLocator;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.i18n.I18nManager;

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

import org.gvsig.tools.swing.api.usability.UsabilitySwingManager;

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

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

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

/**

 * Implements the JPanel that shows the properties of a

 * VectorialFilterExpressionLegend

 * in order to allows the user to modify its characteristics

 *

 * @author gvSIG Team

 *

 */

public class VectorFilterExpressionPanel extends JPanel

implements ILegendPanel, ActionListener {

    private static final Logger logger = LoggerFactory.getLogger(

        VectorFilterExpressionPanel.class);

        private static final long serialVersionUID = -7187473609965942511L;

        private VectorFilterExpressionLegend theLegend;

        private VectorFilterExpressionLegend auxLegend;

        private ClassifiableVectorial layer;

        private PictureFillSymbol previewSymbol;

        private JPanel pnlCenter;

        private JPanel pnlMovBut;

        private SymbolTable symbolTable;

        private JButton btnAddExpression;

//        private JButton btnModExpression;

        private JButton btnRemoveExpression;

        private JButton moveUp;

        private JButton moveDown;

        private int shapeType;

        protected JCheckBox chkdefaultvalues = null;

        protected JSymbolPreviewButton defaultSymbolPrev;

        private GridBagLayoutPanel defaultSymbolPanel = new GridBagLayoutPanel();

        private UsabilitySwingManager usabilitySwingManager = ToolsSwingLocator.getUsabilitySwingManager();

        /**

         * This is the default constructor

         */

        public VectorFilterExpressionPanel() {

                super();

                initialize();

        }

        /**

         * This method initializes this

         */

        private void initialize() {

                pnlCenter = new JPanel();

                pnlCenter.setLayout(new BorderLayout());

                JPanel pnlButtons = new JPanel();

                btnAddExpression = usabilitySwingManager.createJButton(

                    Messages.getText("Anadir"));

                btnAddExpression.setActionCommand("NEW_EXPRESSION");

                btnAddExpression.addActionListener(this);

                pnlButtons.add(btnAddExpression);

//                btnModExpression = usabilitySwingManager.createJButton(

//                    Messages.getText("modify_filter_expression"));

//                btnModExpression.setActionCommand("MODIFY_EXPRESSION");

//                btnModExpression.addActionListener(this);

//                pnlButtons.add(btnModExpression);

                btnRemoveExpression = usabilitySwingManager.createJButton(

                    Messages.getText("Quitar"));

                btnRemoveExpression.setActionCommand("REMOVE");

                btnRemoveExpression.addActionListener(this);

                pnlButtons.add(btnRemoveExpression);

                defaultSymbolPanel.add(getChkDefaultvalues());

                pnlCenter.add(defaultSymbolPanel,BorderLayout.NORTH);

                this.setLayout(new BorderLayout());

                this.add(pnlCenter, BorderLayout.CENTER);

                this.add(pnlButtons, BorderLayout.SOUTH);

        }

        public void getDefaultSymbolPrev(int shapeType) {

                if(defaultSymbolPrev == null){

                        defaultSymbolPrev = new JSymbolPreviewButton(shapeType);

                        defaultSymbolPrev.setPreferredSize(new Dimension(110,20));

                        defaultSymbolPanel.add(defaultSymbolPrev,null);

                }

        }

        public String getDescription() {

                return Messages.getText(

                    "shows_the_elements_of_the_layer_depending_on_the_value_of_a_filter_expression") + ".";

        }

        public ISymbol getIconSymbol() {

                if (previewSymbol == null) {

                        try {

                                previewSymbol = new PictureFillSymbol();

                                previewSymbol.setImage( new File(

                                                this.getClass().getClassLoader().

                                                getResource("images" + File.separator

                                                    + "legend" + File.separator

                                                    + "legend-overview-vectorial-unique-value.png").

                                                getFile()).toURI().toURL());

                                previewSymbol.getMarkerFillProperties().

                                setFillStyle(

                                                IMarkerFillPropertiesStyle.SINGLE_CENTERED_SYMBOL);

                        } catch (IOException e) {

                                return null;

                        }

                }

                return previewSymbol;

        }

        public ILegend getLegend() {

                auxLegend.clear();

                fillSymbolListFromTable();

                theLegend = (VectorFilterExpressionLegend) auxLegend.cloneLegend();

                if(defaultSymbolPrev.getSymbol() != null)

                        theLegend.setDefaultSymbol(defaultSymbolPrev.getSymbol());

                theLegend.useDefaultSymbol(chkdefaultvalues.isSelected());

                return theLegend;

        }

        /**

         * Fills the list of symbols of the legend

         *

         */

        private void fillSymbolListFromTable() {

                Object clave;

                ISymbol theSymbol;

                FLyrVect m = (FLyrVect) layer;

                try {

                        if(auxLegend.getClassifyingFieldNames() != null) {

                                String[] fNames= auxLegend.getClassifyingFieldNames();

                                int[] fieldTypes  = new int[auxLegend.getClassifyingFieldNames().length];

                                FeatureStore fsto = (FeatureStore) m.getDataStore();

                                FeatureType fty = fsto.getDefaultFeatureType();

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

                                        fieldTypes[i] = fty.getAttributeDescriptor(fNames[i]).getType();

                                }

                                auxLegend.setClassifyingFieldTypes(fieldTypes);

                        }

                } catch (Exception e) {

                }

                auxLegend.useDefaultSymbol(chkdefaultvalues.isSelected());

                for (int row = 0; row < symbolTable.getRowCount(); row++) {

                        clave =  symbolTable.getFieldValue(row, 1);

                        theSymbol = (ISymbol) symbolTable.getFieldValue(row, 0);

                        theSymbol.setDescription((String) symbolTable.getFieldValue(row, 2));

                        auxLegend.addSymbol(clave, theSymbol);

                }

                if(chkdefaultvalues.isSelected()){

                        if(defaultSymbolPrev.getSymbol() != null){

                                String description = VectorFilterExpressionLegend.I18N_DEFAULT;

                                defaultSymbolPrev.getSymbol().setDescription(description);

                                auxLegend.addSymbol(

                                    description, defaultSymbolPrev.getSymbol());

                        }

                }

        }

        public Class<VectorFilterExpressionLegend> getLegendClass() {

                return VectorFilterExpressionLegend.class;

        }

        public JPanel getPanel() {

                return this;

        }

        public Class<Categories> getParentClass() {

                return Categories.class;

        }

        public String getTitle() {

                return Messages.getText("expressions");

        }

        public boolean isSuitableFor(FLayer layer) {

                FLyrVect lVect = (FLyrVect) layer;

                try {

                        return

                            VectorFilterExpressionLegend.isPoint(lVect.getShapeType())

                            ||

                VectorFilterExpressionLegend.isLinear(lVect.getShapeType())

                ||

                VectorFilterExpressionLegend.isPolygonal(lVect.getShapeType());

                } catch (Exception e) {

                        return false;

                }

        }

        public void setData(FLayer lyr, ILegend legend) {

                this.layer = (ClassifiableVectorial) lyr;

                shapeType = 0;

                try {

                        shapeType = this.layer.getGeometryType().getType();

                } catch (ReadException e) {

                    logger.info("Error while getting layer shp type", e);

                    ApplicationLocator.getManager().message(

                        Messages.getText("generating_intervals"),

                        JOptionPane.ERROR_MESSAGE);

                }

                if (symbolTable != null)

                        pnlCenter.remove(symbolTable);

                if (pnlMovBut != null)

                        pnlCenter.remove(pnlMovBut);

                getDefaultSymbolPrev(shapeType);

                symbolTable = new SymbolTable(this, "expressions", shapeType);

    try {

      ExpressionFieldCellEditor cellEditor = new ExpressionFieldCellEditor(

              ((FLyrVect)layer).getFeatureStore()

      );

      symbolTable.setCellEditor(cellEditor);

    } catch(Exception ex) {

    }

                pnlCenter.add(symbolTable, BorderLayout.CENTER);

                pnlCenter.add(getPnlMovBut(),BorderLayout.EAST);

                if (legend instanceof VectorFilterExpressionLegend) {

            auxLegend = (VectorFilterExpressionLegend) legend.cloneLegend();

            if (auxLegend.isUseDefaultSymbol()) {

                // Default must not be in table

                fillTableSkipDefault(auxLegend);

            } else {

                symbolTable.fillTableFromSymbolList(

                    auxLegend.getSymbols(),

                    auxLegend.getValues(),

                    auxLegend.getDescriptions());

            }

                } else {

                        auxLegend = new VectorFilterExpressionLegend();

                        auxLegend.setShapeType(shapeType);

                }

                defaultSymbolPrev.setSymbol(auxLegend.getDefaultSymbol());

                getChkDefaultvalues().setSelected(auxLegend.isUseDefaultSymbol());

        }

        private JPanel getPnlMovBut() {

                if(pnlMovBut == null){

                        pnlMovBut = new JPanel();

                        pnlMovBut.setLayout(new BoxLayout(pnlMovBut, BoxLayout.Y_AXIS));

                        pnlMovBut.add(new JBlank(1, 70));

                        ImageIcon ico = IconThemeHelper.getImageIcon(

                            "symbol-layer-move-up");

                        moveUp = usabilitySwingManager.createJButton(ico);

                        pnlMovBut.add(moveUp);

                        moveUp.setSize(new Dimension(15,15));

                        pnlMovBut.add(new JBlank(1,10));

                        ico = IconThemeHelper.getImageIcon(

                "symbol-layer-move-down");

                        moveDown = usabilitySwingManager.createJButton(ico);

                        pnlMovBut.add(moveDown);

                        pnlMovBut.add(new JBlank(1, 70));

                        moveDown.setActionCommand("MOVE-DOWN");

                        moveUp.setActionCommand("MOVE-UP");

                        moveDown.addActionListener(this);

                        moveUp.addActionListener(this);

                }

                return pnlMovBut;

        }

        public void actionPerformed(ActionEvent e) {

                int[] indices = null;

                Feature dummyFeat = null;

                if(e.getActionCommand() == "MOVE-UP" || e.getActionCommand() == "MOVE-DOWN"){

                        indices = symbolTable.getSelectedRows();

                }

                if(e.getActionCommand() == "MOVE-UP"){

                        if (indices.length>0) {

                                int classIndex = indices[0];

                                int targetPos = Math.max(0, classIndex-1);

                                symbolTable.moveUpRows(classIndex, targetPos,indices.length);

                        }

                }

                if(e.getActionCommand() == "MOVE-DOWN"){

                        if (indices.length>0) {

                                int classIndex = indices[indices.length-1];

                                int targetPos = Math.min(symbolTable.getRowCount()-1, classIndex+1);

                                symbolTable.moveDownRows(classIndex, targetPos,indices.length);

                        }

                }

                if(e.getActionCommand() == "MOVE-UP" || e.getActionCommand() == "MOVE-DOWN"){

                        ArrayList<String> orders = new ArrayList<String>();

                        for (int i = 0; i < symbolTable.getRowCount(); i++) {

                                orders.add(symbolTable.getFieldValue(i,1).toString());

                        }

                } if (e.getActionCommand() == "NEW_EXPRESSION") {

                    FLyrVect vect = (FLyrVect) layer;

                    final FeatureStore fsto = vect.getFeatureStore();

                    final FeatureType fty = fsto.getDefaultFeatureTypeQuietly();

                    final int shptype = fty.getDefaultGeometryAttribute().getGeomType().getType();

        final I18nManager i18n = ToolsLocator.getI18nManager();

        final ExpressionSymbolPanel esp = new ExpressionSymbolPanel(fsto, shptype, previewSymbol);

        final WindowManager_v2 windowManager = (WindowManager_v2) ToolsSwingLocator.getWindowManager();

        final Dialog dialog = windowManager.createDialog(

              esp,

              i18n.getTranslation("expression_creator"),

              "",

              WindowManager_v2.BUTTONS_OK_CANCEL

        );

        dialog.addActionListener((ActionEvent e1) -> {

          if( dialog.getAction()!=WindowManager_v2.BUTTON_OK ) {

            return;

          }

          String expr = esp.getExpression();

          if ( StringUtils.isBlank(expr) ) {

              ApplicationLocator.getManager().messageDialog(

                  Messages.getText("error_validating_filter_query"),

                  Messages.getText("error"),

                  JOptionPane.ERROR_MESSAGE);

              return;

          }

          ISymbol sym = esp.getSymbol();

          this.addClassFieldNames(fty);

          auxLegend.addSymbol(expr, sym);

          symbolTable.removeAllItems();

          fillTableSkipDefault(auxLegend);

          repaint();

        });

        dialog.show(WindowManager.MODE.DIALOG);

//

//    }

//                else if (e.getActionCommand() == "MODIFY_EXPRESSION") {

//

//                        if(symbolTable.getSelectedRowElements() == null) {

//                                JOptionPane.showMessageDialog(this,

//                                    Messages.getText("select_one_row")+".\n");

//                        } else {

//

//                         FLyrVect vect = (FLyrVect) layer;

//                         FeatureStore fsto = (FeatureStore) vect.getDataStore();

//                         FeatureType fty = null;

//                         int shptype = 0;

//                         try {

//                             fty = fsto.getDefaultFeatureType();

//                             shptype = vect.getGeometryType().getType();

//                             dummyFeat = fsto.createNewFeature(true);

//                         } catch (Exception exc) {

//                             logger.error(Messages.getText(

//                                 "error_trying_to_access_to_the_layer"), exc);

//                             return;

//                         }

//

//                        ISymbol mySymbol = (ISymbol) symbolTable.getSelectedRowElements()[0];

//                String expression = (String) symbolTable.getSelectedRowElements()[1];

//

//                EvaluatorWithDescriptions evalu =

//                    EvaluatorCreator.getEvaluator(expression);

//

//                MDIManager mm = ApplicationLocator.getManager().getUIManager();

//                ExpressionSymbolPanel esp = new ExpressionSymbolPanel(

//                    dummyFeat, evalu, shptype, mySymbol);

//                mm.addCentredWindow(esp);

//                    /*

//                     * esp is modal

//                     */

//                    if (!esp.isOkPressed()) {

//                        return;

//                    }

//

//                    String expr = esp.getExpression();

//                    if (expr == null || expr.length() == 0) {

//                        ApplicationLocator.getManager().messageDialog(

//                            Messages.getText("error_validating_filter_query"),

//                            Messages.getText("error"),

//                            JOptionPane.ERROR_MESSAGE);

//                        return;

//                    }

//

//                    ISymbol sym = esp.getSymbol();

////                    evalu = EvaluatorCreator.getEvaluator(expr);

//                    // Add all fields in the feature type

//                    this.addClassFieldNames(fty);

//

//                    // Remove old

//                                auxLegend.delSymbol(expression);

//                                auxLegend.addSymbol(expr, sym);

//                                symbolTable.removeAllItems();

//                                this.fillTableSkipDefault(auxLegend);

//

//                                repaint();

//                        }

    } else if (e.getActionCommand() == "REMOVE") {

                        if(symbolTable.getSelectedRowElements() == null) {

                                JOptionPane.showMessageDialog(this,

                                    Messages.getText("select_one_row"));

                        } else{

                                String my_expr = (String) symbolTable.getSelectedRowElements()[1];

                                auxLegend.delSymbol(my_expr);

                                symbolTable.removeAllItems();

                                fillTableSkipDefault(auxLegend);

                                repaint();

                        }

                }

        }

        private void addClassFieldNames(FeatureType ft) {

            FeatureAttributeDescriptor[] atts = ft.getAttributeDescriptors();

            String[] nn = new String[atts.length];

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

                nn[i] = atts[i].getName();

            }

            addClassFieldNames(nn);

        }

        /**

         * Adds new classifying field names to the legend when a new expression is

         * created or an existing one is modified

         * @param fieldNamesExpression

         */

        private void addClassFieldNames(String[] fieldNamesExpression) {

                boolean appears = false;

                ArrayList<String> myFieldNames = new ArrayList<String>();

                if (auxLegend.getClassifyingFieldNames() != null) {

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

                                myFieldNames.add(auxLegend.getClassifyingFieldNames()[i]);

                        }

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

                                appears = false;

                                for (int j = 0; j < auxLegend.getClassifyingFieldNames().length; j++) {

                                        if (auxLegend.getClassifyingFieldNames()[j].compareTo((String) fieldNamesExpression[i]) == 0)

                                                appears = true;

                                }

                                if(!appears) {

                                        myFieldNames.add((String) fieldNamesExpression[i]);

                                }

                        }

                        auxLegend.setClassifyingFieldNames((String[])myFieldNames.toArray(new

                                        String[myFieldNames.size()]));

                }

                else {

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

                                myFieldNames.add((String) fieldNamesExpression[i]);

                        }

                        auxLegend.setClassifyingFieldNames((String[])myFieldNames.toArray(new

                                        String[myFieldNames.size()]));

                }

        }

        public ImageIcon getIcon() {

            ImageIcon ii = IconThemeHelper.getImageIcon(

                "legend-overview-vector-filter-expression");

            return ii;

        }

        /**

         * This method initializes chkdefaultvalues

         *

         * @return javax.swing.JCheckBox

         */

        protected JCheckBox getChkDefaultvalues() {

                if (chkdefaultvalues == null) {

                        chkdefaultvalues = new JCheckBox();

                        chkdefaultvalues.setText(Messages.getText("resto_valores")+": ");

                        chkdefaultvalues.setBounds(new java.awt.Rectangle(342, 26, 141, 20));

                        chkdefaultvalues.setSelected(false);

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

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

                                        if (chkdefaultvalues.isSelected()) {

                                                auxLegend.useDefaultSymbol(true);

                                        } else {

                                                auxLegend.useDefaultSymbol(false);

                                        }

                                }

                        });

                }

                return chkdefaultvalues;

        }

        private void fillTableSkipDefault(VectorFilterExpressionLegend leg) {

            Object[] src_expr = leg.getValues();

            List<Integer> rem_ind = new ArrayList<Integer>();

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

                if (VectorFilterExpressionLegend.I18N_DEFAULT.

                    compareToIgnoreCase((String) src_expr[i]) == 0) {

                    rem_ind.add(new Integer(i));

                }

            }

        ISymbol[] src_syms = leg.getSymbols();

        String[] src_descs = leg.getDescriptions();

        // Object[] src_expr

        List<ISymbol> syms = new ArrayList<ISymbol>();

        List<Object> vals = new ArrayList<Object>();

        List<String> descs = new ArrayList<String>();

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

            if (!isIn(i, rem_ind)) {

                syms.add(src_syms[i]);

                vals.add(src_expr[i]);

                descs.add(src_descs[i]);

            }

        }

            symbolTable.fillTableFromSymbolList(

                (ISymbol[]) syms.toArray(new ISymbol[0]),

            (Object[]) vals.toArray(new Object[0]),

            (String[]) descs.toArray(new String[0]));

      doUpdateCellEditor();

        }

  private void doUpdateCellEditor() {

      try {

        ExpressionFieldCellEditor cellEditor = new ExpressionFieldCellEditor(

                ((FLyrVect)layer).getFeatureStore()

        );

        symbolTable.setCellEditor(cellEditor);

      } catch(Exception ex) {

        logger.debug("Can't update cell editors",ex);

      }    

  }

    /**

     * @param i

     * @param rem_ind

     * @return

     */

    private boolean isIn(int n, List<Integer> int_list) {

        if (int_list == null || int_list.size() == 0) {

            return false;

        }

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

            if (int_list.get(i) instanceof Integer) {

                Integer item = (Integer) int_list.get(i);

                if (item.intValue() == n) {

                    return true;

                }

            }

        }

        return false;

    }

    public static void selfRegister() {

        IconThemeHelper.registerIcon("legend","legend-overview-vector-filter-expression", VectorFilterExpressionPanel.class);

        IconThemeHelper.registerIcon("legend","legend-overview-vectorial-unique-value", VectorFilterExpressionPanel.class);

        IconThemeHelper.registerIcon("symbol","symbol-layer-move-down", VectorFilterExpressionPanel.class);

        IconThemeHelper.registerIcon("symbol","symbol-layer-move-up", VectorFilterExpressionPanel.class);

        SymbologySwingLocator.getSwingManager().registerLegendEditor(VectorFilterExpressionPanel.class);

//        SymbologySwingLocator.getSwingManager().registerLegendEditor(VectorFilterExpressionPanel2.class);

        SymbolTable.addNewCellEditor("expressions",

            new ExpressionFieldCellEditor(null));

    }

}