Application: gvSIG desktop » gvSIG legends: base legends

<!--

    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.

-->

<assembly>

  <id>gvsig-plugin-package</id>

  <formats>

    <format>zip</format>

  </formats>

  <baseDirectory>${project.artifactId}</baseDirectory>

  <includeBaseDirectory>true</includeBaseDirectory>

  <files>

    <file>

      <source>target/${project.artifactId}-${project.version}.jar</source>

      <outputDirectory>lib</outputDirectory>

    </file>

    <file>

      <source>target/package.info</source>

    </file>

  </files>

  <fileSets>

    <fileSet>

      <directory>src/main/resources-plugin</directory>

      <outputDirectory>.</outputDirectory>

    </fileSet>

  </fileSets>

<!-- No dependencies

  <dependencySets>

    <dependencySet>

      <useProjectArtifact>false</useProjectArtifact>

      <useTransitiveDependencies>false</useTransitiveDependencies>

      <outputDirectory>lib</outputDirectory>

      <includes>

		<include>...</include>

      </includes>

    </dependencySet>

  </dependencySets>

-->

</assembly>

/* gvSIG. Sistema de Informaci�n Geogr�fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib��ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

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.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.andami.IconThemeHelper;

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

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.fmap.rendering.filterexpression.EvaluatorCreator;

import org.gvsig.tools.evaluator.EvaluatorWithDescriptions;

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

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

/**

 * Implements the JPanel that shows the properties of a

 * VectorialFilterExpressionLegend

 * in order to allows the user to modify its characteristics

 *

 * @author Pepe Vidal Salvador - jose.vidal.salvador@iver.es

 *

 */

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("new_filter_expression"));

		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("delete_filter_expression"));

		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);

		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;

		    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;

		    }

		    EvaluatorWithDescriptions evalu = EvaluatorCreator.getEvaluator("");

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

		    ExpressionSymbolPanel esp = new ExpressionSymbolPanel(

		        dummyFeat, evalu, shptype, null);

		    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);

            auxLegend.addSymbol(expr, sym);

            symbolTable.removeAllItems();

            fillTableSkipDefault(auxLegend);

			repaint();

		}

		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]));

	}

    /**

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

    }

}

/* gvSIG. Sistema de Informaci�n Geogr�fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib��ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package org.gvsig.symbology.gui.layerproperties;

import java.awt.Component;

import java.util.EventObject;

import javax.swing.JTable;

import javax.swing.JTextField;

import javax.swing.event.CellEditorListener;

import javax.swing.table.TableCellEditor;

/**

 * Cell Editor for expressions. It controls the edition events in an expression

 * column of the table

 *

 * @author pepe vidal salvador - jose.vidal.salvador@iver.es

 */

public class ExpressionFieldCellEditor extends JTextField implements TableCellEditor {

	private static final long serialVersionUID = 1L;

	public ExpressionFieldCellEditor() {

	}

	public Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column) {

		return null;

	}

	public void addCellEditorListener(CellEditorListener l) {

		throw new RuntimeException("Not yet implemented");

	}

	public void cancelCellEditing() {

		throw new RuntimeException("Not yet implemented");

	}

	public Object getCellEditorValue() {

		return null;

	}

	public boolean isCellEditable(EventObject anEvent) {

		return false;

	}

	public void removeCellEditorListener(CellEditorListener l) {

		throw new RuntimeException("Not yet implemented");

	}

	public boolean shouldSelectCell(EventObject anEvent) {

		return false;

	}

	public boolean stopCellEditing() {

		return false;

	}

}

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 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 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.symbology.gui.layerproperties;

import java.awt.Dimension;

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.Insets;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import javax.swing.BorderFactory;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.JTextArea;

import javax.swing.ScrollPaneConstants;

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

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

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

import org.gvsig.app.ApplicationLocator;

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

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

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.mapcontext.MapContextLocator;

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

import org.gvsig.gui.beans.AcceptCancelPanel;

import org.gvsig.i18n.Messages;

import org.gvsig.symbology.fmap.rendering.filterexpression.EvaluatorCreator;

import org.gvsig.tools.evaluator.EvaluatorException;

import org.gvsig.tools.evaluator.EvaluatorWithDescriptions;

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

import org.gvsig.tools.swing.api.evaluator.ComponentSwingManager;

import org.gvsig.tools.swing.api.evaluator.EvaluatorPanel;

/**

 * This panel shows an expression creation panel (from the Tools

 * library) and shows a symbol preview panel with a description

 * so the user can associate a symbol to the expression (symbol

 * will be used if expression evaluates to TRUE)

 *

 * @see EvaluatorPanel

 *

 *

 * @author jldominguez

 *

 */

public class ExpressionSymbolPanel extends JPanel

implements ActionListener, IWindow {

    /**

     *

     */

    private static final long serialVersionUID = 6299256060002740452L;

    private Feature dummyFeature = null;

    private EvaluatorWithDescriptions evald = null;

    private int shptype = Geometry.TYPES.GEOMETRY;

    private JPanel symPanel = null;

    private JSymbolPreviewButton templateButton = null;

    private JTextArea descArea = null;

    private AcceptCancelPanel acPanel;

    private boolean okPressed = false;

    private WindowInfo winfo = null;

    private EvaluatorPanel evapa = null;

    public ExpressionSymbolPanel(

        Feature dummy_feat, EvaluatorWithDescriptions ed, int st, ISymbol sym) {

        dummyFeature = dummy_feat;

        evald = ed;

        shptype = st;

        initialize(sym);

    }

    private EvaluatorPanel getEvaluatorPanel() {

        if (evapa == null) {

            ComponentSwingManager esm =

                ToolsSwingLocator.getComponentSwingManager();

            evapa = esm.getEvaluatorPanel(

                dummyFeature.getType(),

                evald);

        }

        return evapa;

    }

    public String getExpression() {

        return getEvaluatorPanel().getExpression();

    }

    public ISymbol getSymbol() {

        ISymbol resp = getTemplateButton(null).getSymbol();

        resp.setDescription(this.getDescArea(null).getText());

        return resp;

    }

    /**

     *

     */

    private void initialize(ISymbol sym) {

        this.setLayout(new GridBagLayout());

        GridBagConstraints gbc = new GridBagConstraints();

        gbc.gridx = 0;

        gbc.gridy = 0;

        gbc.anchor = GridBagConstraints.CENTER;

        gbc.fill = GridBagConstraints.BOTH;

        gbc.weightx = 1;

        gbc.weighty = 1;

        this.add(getEvaluatorPanel(), gbc);

        gbc.gridy = 1;

        gbc.weighty = 0;

        this.add(getSymbolPanel(sym), gbc);

        gbc.gridy = 2;

        this.add(getAcceptCancel(), gbc);

    }

    /**

     * @return

     */

    private JPanel getAcceptCancel() {

        if (acPanel == null) {

            acPanel = new AcceptCancelPanel(this, this);

        }

        return acPanel;

    }

    /**

     * @return

     */

    private JPanel getSymbolPanel(ISymbol sym) {

        if (symPanel == null) {

            symPanel = new JPanel();

            symPanel.setLayout(new GridBagLayout());

            symPanel.setBorder(BorderFactory.createTitledBorder(

                Messages.getText("_Symbol_and_description")));

            GridBagConstraints gbc = new GridBagConstraints();

            gbc.fill = GridBagConstraints.BOTH;

            gbc.anchor = GridBagConstraints.NORTHWEST;

            gbc.gridx = 0;

            gbc.gridy = 0;

            gbc.weightx = 0.2;

            gbc.weighty = 0;

            gbc.insets = new Insets(7, 7, 7, 7);

            symPanel.add(getTemplateButton(sym), gbc);

            gbc.gridx = 1;

            gbc.weightx = 0.8;

            JScrollPane scroll = new JScrollPane(getDescArea(sym));

            scroll.setHorizontalScrollBarPolicy(

                ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED);

            scroll.setVerticalScrollBarPolicy(

                ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED);

            symPanel.add(scroll, gbc);

        }

        return symPanel;

    }

    /**

     * @return

     */

    private JTextArea getDescArea(ISymbol sym) {

        if (descArea == null) {

            descArea = new JTextArea();

            descArea.setWrapStyleWord(true);

            descArea.setLineWrap(true);

            if (sym != null) {

                descArea.setText(sym.getDescription());

            }

        }

        return descArea;

    }

    /**

     * @return

     */

    private JSymbolPreviewButton getTemplateButton(ISymbol sym) {

        if (templateButton == null) {

            ISymbol inisym = sym;

            if (inisym == null) {

                inisym = MapContextLocator.getSymbolManager().

                    createSymbol(shptype);

            }

            templateButton = new JSymbolPreviewButton(inisym, shptype);

            templateButton.setPreferredSize(new Dimension(100, 35));

            templateButton.setMinimumSize(new Dimension(100, 35));

        }

        return templateButton;

    }

    /* (non-Javadoc)

     * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)

     */

    public void actionPerformed(ActionEvent e) {

        if (e.getActionCommand().compareToIgnoreCase("ok") == 0) {

            Class<?> return_class = null;

            try {

                return_class = validateExpression();

            } catch (EvaluatorException epe) {

                if (epe.getCause() instanceof ArithmeticException) {

                    if (!userTolerates(epe)) {

                        okPressed = false;

                        return;

                    } else {

                        // User said ok

                        okPressed = true;

                        closeThis();

                        return;

                    }

                } else {

                    String detail = epe.getMessageStack();

                    ApplicationLocator.getManager().messageDialog(

                        Messages.getText("incorrect_expression")

                        + "\n\n" + detail,

                        Messages.getText("error"),

                        JOptionPane.ERROR_MESSAGE);

                    okPressed = false;

                    return;

                }

            }

            if (return_class != Boolean.class) {

                int usr_opt = JOptionPane.showConfirmDialog(

                    this,

                    Messages.getText("_Result_not_boolean_so_zero_empty_string_null_are_false_Continue_question"),

                    Messages.getText("confirmation_dialog"),

                    JOptionPane.YES_NO_OPTION);

                if (usr_opt == JOptionPane.NO_OPTION) {

                    okPressed = false;

                    return;

                }

            }

            okPressed = true;

            closeThis();

        } else {

            if (e.getActionCommand().compareToIgnoreCase("cancel") == 0) {

                okPressed = false;

                closeThis();

            }

        }

    }

    /**

     * @param epe

     * @return

     */

    private boolean userTolerates(EvaluatorException epe) {

        String detail = Messages.getText(

            "_Expression_can_cause_arithmetic_issues_Continue_question");

        detail = detail + "\n\nMessage: ";

        detail = detail + epe.getMessageStack();

        int usr_opt = JOptionPane.showConfirmDialog(

            this,

            detail,

            Messages.getText("confirmation_dialog"),

            JOptionPane.YES_NO_OPTION);

        return usr_opt == JOptionPane.YES_OPTION;

    }

    /**

     * @return class of the return value

     */

    private Class<? extends Object> validateExpression() throws EvaluatorException {

        String expr = this.getExpression();

        EvaluatorWithDescriptions evde = EvaluatorCreator.getEvaluator(expr);

        Object resp_class = null;

        try {

            /*

             * Try evaluate feature with default values

             */

            resp_class = evde.evaluate(dummyFeature.getEvaluatorData());

        } catch (EvaluatorException e) {

            /*

             * Parse exception or field not found or

             * divison by zero, etc.

             * Malformed expression, not valid

             */

            throw e;

        } catch (Exception e) {

            /*

             * All other exceptions.

             * Should not happen often.

             * We assume a strange

             * exception (NPE, etc) and decide it's not a valid

             * expression

             *

             */

            throw new EvaluatorException(e);

        }

        if (resp_class == null) {

            return null;

        } else {

            return resp_class.getClass();

        }

    }

    private void closeThis() {

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

        mm.closeWindow(this);

    }

    public boolean isOkPressed() {

        return okPressed;

    }

    /* (non-Javadoc)

     * @see org.gvsig.andami.ui.mdiManager.IWindow#getWindowInfo()

     */

    public WindowInfo getWindowInfo() {

        if (winfo == null) {

            winfo = new WindowInfo(

                WindowInfo.MODALDIALOG |

                WindowInfo.RESIZABLE);

            winfo.setTitle(Messages.getText("expression_creator"));

            winfo.setWidth(675);

            winfo.setHeight(400);

        }

        return winfo;

    }

    /* (non-Javadoc)

     * @see org.gvsig.andami.ui.mdiManager.IWindow#getWindowProfile()

     */

    public Object getWindowProfile() {

        return WindowInfo.DIALOG_PROFILE;

    }

}

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 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 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.symbology.library;

import org.gvsig.andami.IconThemeHelper;

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

import org.gvsig.fmap.mapcontext.MapContextLocator;

import org.gvsig.fmap.mapcontext.MapContextManager;

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

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

import org.gvsig.symbology.SymbologyLibrary;

import org.gvsig.symbology.fmap.mapcontext.rendering.legend.driver.impl.PersistenceBasedLegendReader;

import org.gvsig.symbology.fmap.mapcontext.rendering.legend.driver.impl.PersistenceBasedLegendWriter;

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

import org.gvsig.symbology.gui.layerproperties.ExpressionFieldCellEditor;

import org.gvsig.symbology.gui.layerproperties.VectorFilterExpressionPanel;

import org.gvsig.symbology.swing.SymbologySwingLocator;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.persistence.xml.XMLPersistenceLibrary;

import org.gvsig.tools.util.Caller;

import org.gvsig.tools.util.impl.DefaultCaller;

/**

 * Simple library to register vector filter expression legend

 *

 * @author jldominguez

 *

 */

public class VectorFilterExpressionLibrary extends AbstractLibrary {

    public void doRegistration() {

        registerAsImplementationOf(VectorFilterExpressionLibrary.class);

        /*

         * This checks map context library registration

         */

        require(SymbologyLibrary.class);

        /*

         * This is because we need to use persistence manager

         */

        require(XMLPersistenceLibrary.class);

    }

    protected void doInitialize() throws LibraryException {

    }

    protected void doPostInitialize() throws LibraryException {

        IconThemeHelper.registerIcon("legend",

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

        IconThemeHelper.registerIcon("legend",

            "legend-overview-vectorial-unique-value", this);

        IconThemeHelper.registerIcon("symbol",

            "symbol-layer-move-down", this);

        IconThemeHelper.registerIcon("symbol",

            "symbol-layer-move-up", this);

        Caller caller = new DefaultCaller();

        caller.add(new VectorFilterExpressionLegend.RegisterLegend());

        caller.add(new VectorFilterExpressionLegend.RegisterPersistence());

        /*

         * Do register of all

         */

        if( !caller.call() ) {

            throw new LibraryException(

                VectorFilterExpressionLibrary.class,

                caller.getExceptions());

        }

        MapContextManager mcoman = MapContextLocator.getMapContextManager();

        mcoman.registerLegendWriter(

        		VectorFilterExpressionLegend.class,

                SymbolManager.LEGEND_FILE_EXTENSION.substring(1),

                PersistenceBasedLegendWriter.class);

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

        SymbolTable.addNewCellEditor("expressions",

            new ExpressionFieldCellEditor());

    }

}

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 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 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.symbology.fmap.rendering.filterexpression;

import org.gvsig.tools.evaluator.EvaluatorWithDescriptions;

import org.gvsig.tools.evaluator.sqljep.SQLJEPEvaluator;

/**

 * 

 * Utility class to centralize the creation of an

 * @link {@link EvaluatorWithDescriptions}

 * 

 * TODO Perhaps create a manager in Tools to perform this operation

 * 

 * @author jldominguez

 *

 */

public class EvaluatorCreator {

    /**

     * Create an {@link EvaluatorWithDescriptions} that uses

     * the string expression provided

     * 

     * @param expr

     * @return

     */

    public static EvaluatorWithDescriptions getEvaluator(String expr) {

        return new SQLJEPEvaluator(expr);

    }

}

/* gvSIG. Sistema de Informaci�n Geogr�fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib��ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package org.gvsig.symbology.fmap.rendering;

import java.util.ArrayList;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

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

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.GeometryLocator;

import org.gvsig.fmap.geom.GeometryManager;

import org.gvsig.fmap.mapcontext.MapContextLocator;

import org.gvsig.fmap.mapcontext.MapContextManager;

import org.gvsig.fmap.mapcontext.rendering.legend.events.SymbolLegendEvent;

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

import org.gvsig.i18n.Messages;

import org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend;

import org.gvsig.symbology.fmap.rendering.filterexpression.EvaluatorCreator;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.evaluator.Evaluator;

import org.gvsig.tools.evaluator.EvaluatorData;

import org.gvsig.tools.evaluator.EvaluatorWithDescriptions;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.PersistentState;

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

import org.gvsig.tools.util.Callable;

/**

 *

 * Implements a vector legend which represents the elements of a layer

 * depending on the value of an expression. That is, if the expression is

 * evaluated to true, then the symbol associated to the expression is painted.

 * In other case it is not showed.

 *

 * If the expression result is a string, it is considered false if

 * it is the empty string "", true otherwise.

 *

 * If the expression result is numeric, it is considered false

 * if it is zero, and true otherwise.

 *

 * In other cases, it is considered false if the result is null and true

 * otherwise.

 *

 * @author Pepe Vidal Salvador - jose.vidal.salvador@iver.es

 * @author jldominguez

 */

public class VectorFilterExpressionLegend

extends AbstractClassifiedVectorLegend  {

    private static final Logger logger = LoggerFactory.getLogger(

        VectorFilterExpressionLegend.class);

    public static final String

    FILTER_EXPRESSION_LEGEND_PERSISTENCE_DEFINITION_NAME =

    "FILTER_EXPRESSION_LEGEND_PERSISTENCE_DEFINITION_NAME";

    public static final String

    FILTER_EXPRESSION_LEGEND_NAME = "FILTER_EXPRESSION_LEGEND_NAME";

    public static final String I18N_DEFAULT = Messages.getText("default_value");

    public static final String NON_I18N_DEFAULT = Messages.getText("Default");

	private int shapeType;

	private ISymbol defaultSymbol;

	private boolean useDefaultSymbol = false;