Application: gvSIG desktop » gvSIG legends: base legends

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

	<modelVersion>4.0.0</modelVersion>

	<artifactId>org.gvsig.legend.vectorfilterexpression.app.mainplugin</artifactId>

	<name>Vector legend: Filter by expression</name>

	<version>1.0.44</version>

  <parent>

      <groupId>org.gvsig</groupId>

      <artifactId>org.gvsig.desktop</artifactId>

      <version>2.0.184</version>

  </parent>

	<url>https://devel.gvsig.org/redmine/projects/gvsig-base-legends</url>

    <scm>

        <connection>scm:svn:https://devel.gvsig.org/svn/gvsig-base-legends/org.gvsig.legend.vectorfilterexpression.app.mainplugin/tags/org.gvsig.legend.vectorfilterexpression.app.mainplugin-1.0.44</connection>

        <developerConnection>scm:svn:https://devel.gvsig.org/svn/gvsig-base-legends/org.gvsig.legend.vectorfilterexpression.app.mainplugin/tags/org.gvsig.legend.vectorfilterexpression.app.mainplugin-1.0.44</developerConnection>

        <url>scm:svn:https://devel.gvsig.org/svn/gvsig-base-legends/org.gvsig.legend.vectorfilterexpression.app.mainplugin/tags/org.gvsig.legend.vectorfilterexpression.app.mainplugin-1.0.44</url>

    </scm>

    <repositories>

      <repository>

        <id>gvsig-public-http-repository</id>

        <name>gvSIG maven public HTTP repository</name>

        <url>http://devel.gvsig.org/m2repo/j2se</url>

        <releases>

          <enabled>true</enabled>

          <updatePolicy>daily</updatePolicy>

          <checksumPolicy>warn</checksumPolicy>

        </releases>

        <snapshots>

          <enabled>true</enabled>

          <updatePolicy>daily</updatePolicy>

          <checksumPolicy>warn</checksumPolicy>

        </snapshots>

      </repository>

    </repositories>

	<description>Vector legend: Filter by expression. For each feature, the symbol is only visible if the expression is evaluated to true.</description>

	<build>

        <plugins>

		    <plugin>

		      <artifactId>maven-release-plugin</artifactId>

		      <version>2.0</version>

		      <configuration>

		        <tagBase>https://devel.gvsig.org/svn/gvsig-base-legends/org.gvsig.legend.vectorfilterexpression.app.mainplugin/tags</tagBase>

		      </configuration>

		    </plugin>

        </plugins>

	</build>

	<dependencies>

		<dependency>

			<groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.app.mainplugin</artifactId>

		</dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.andami</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.symbology.lib.api</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.symbology.lib.impl</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.symbology.swing.api</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.mapcontext.api</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.utils</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.dal.api</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.i18n</artifactId>

        </dependency>

		<dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.fmap.geometry.api</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.lib</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.ui</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.projection.api</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.metadata.lib.basic.api</artifactId>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.compat.api</artifactId>

        </dependency>

		<dependency>

            <groupId>org.gvsig</groupId>

			<artifactId>org.gvsig.tools.evaluator.sqljep</artifactId>

		</dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.lib</artifactId>

            <scope>compile</scope>

        </dependency>

        <dependency>

            <groupId>org.gvsig</groupId>

            <artifactId>org.gvsig.tools.swing.api</artifactId>

        </dependency>

        <!--

		<dependency>

			<groupId>bsf</groupId>

			<artifactId>bsf</artifactId>

            <scope>compile</scope>

		</dependency>

		-->

	</dependencies>

	<properties>

	    <gvsig.package.info.categories>View,Vector,Symbology</gvsig.package.info.categories>

        <gvsig.package.info.official>true</gvsig.package.info.official>

        <gvsig.package.info.dependencies>required: org.gvsig.app.mainplugin -ge 2.1.0-A</gvsig.package.info.dependencies>

        <gvsig.package.info.state>testing</gvsig.package.info.state>

		<gvsig.package.info.poolURL>https://devel.gvsig.org/download/projects/gvsig-base-legends/pool</gvsig.package.info.poolURL>

	</properties>

</project>

#Wed May 31 09:25:19 CEST 2017

buildNumber=47

org.gvsig.symbology.library.VectorFilterExpressionLibrary

<!--

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

	private long error_msg_count = 0;

	private ArrayList<Item> newSymbols = new ArrayList<Item>() {

		private static final long serialVersionUID = 1L;

		public int indexOf(String expr) {

			return super.indexOf(new Item(expr, null));

		}

	};

	private class Item implements Cloneable {

		private ISymbol sym;

		// get it with getSql()

		// private String expression;

		private EvaluatorWithDescriptions evaluator;

		public Item(String expression, ISymbol sym) {

			this.sym = sym;

			evaluator = EvaluatorCreator.getEvaluator(expression);

		}

		public boolean equals(Object obj) {

			if (obj == null) return false;

			if (!obj.getClass().equals(Item.class)) return false;

			return this.evaluator.getSQL().equals(

			    ((Item) obj).evaluator.getSQL()

			    );

		}

		public String getStringExpression() {

			return evaluator.getSQL();

		}

		public Evaluator getEvaluator() {

			return evaluator;

		}

		public Object clone() {

		    ISymbol clonesym = null;

		    try {

                clonesym = (ISymbol) this.sym.clone();

            } catch (CloneNotSupportedException e) {

                logger.info("Error: unable to clone symbol.", e);

                clonesym = this.sym;

            }

		    return new Item(getStringExpression(), clonesym);

		}

	}

    public VectorFilterExpressionLegend() {

        this.setClassifyingFieldNames(new String[0]);

        this.setClassifyingFieldTypes(new int[0]);

    }

	public ISymbol getSymbolByFeature(Feature featu) {

	    EvaluatorData evda = featu.getEvaluatorData();

		ISymbol returnSymbol = null;

		Object result = null;

		String expr = null;

		try {

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

				Evaluator eval = newSymbols.get(i).getEvaluator();

				expr = eval.getSQL();

                if (expr.equalsIgnoreCase(VectorFilterExpressionLegend.I18N_DEFAULT)){

                    /*

                     * Skip default item

                     */

                    continue;

                }

				result = eval.evaluate(evda);

				if (isConsideredTrue(result)) {

                    returnSymbol = newSymbols.get(i).sym;

                    if (returnSymbol != null) {

                        return returnSymbol;

                    }

				}

			}

		} catch (Exception e) {

		    if (error_msg_count % 1000 == 0) {

		        logger.info("Error (msg every 1000 occurrences) while getting symbol in VectorFilterExpressionLegend", e);

		        error_msg_count = 0;

		    }

		    error_msg_count++;

		}

		if (useDefaultSymbol)

			return getDefaultSymbol();

		return null;

	}

	/**

	 * Tells whether the input object is considered true.

	 * Basically, it is false if it has an empty value

	 * (FALSE, null, 0, "")

	 *

     * @param result

     * @return

     */

    private boolean isConsideredTrue(Object res) {

        if (res == null) {

            return false;

        }

        if (res instanceof Boolean) {

            return ((Boolean) res).booleanValue();

        }

        if (res instanceof Number) {

            return ((Number) res).doubleValue() != 0d;

        }

        if (res instanceof String) {

            return ((String) res).length() > 0;

        }

        // Because it is not null

        return true;

    }

	public void addSymbol(Object key, ISymbol symbol) {

		newSymbols.add(new Item((String)key.toString(),

				symbol));

	}

	public void clear() {

		newSymbols.clear();

	}

	public void resetItems() {

	    newSymbols = new ArrayList<Item>() {

            private static final long serialVersionUID = 1L;

            public int indexOf(String expr) {

                return super.indexOf(new Item(expr, null));

            }

	    };

	}

	public void delSymbol(Object key) {

		ISymbol mySymbol = null;

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

			if (newSymbols.get(i).evaluator.getSQL().equals(key))

				newSymbols.remove(i);

		}

		fireClassifiedSymbolChangeEvent(new SymbolLegendEvent(mySymbol,null));

	}

	public void replace(ISymbol oldSymbol, ISymbol newSymbol) {

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

			if (newSymbols.get(i).sym.equals(oldSymbol))

				newSymbols.get(i).sym = newSymbol;

		}

		fireClassifiedSymbolChangeEvent(new SymbolLegendEvent(oldSymbol,newSymbol));

	}

	public String[] getDescriptions() {

		String[] descriptions = new String[newSymbols.size()];

		ISymbol[] auxSym = getSymbols();

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

			descriptions[i] = auxSym[i].getDescription();

		return descriptions;

	}

	public ISymbol[] getSymbols() {

		if (newSymbols != null) {

			ISymbol[] mySymbols = new ISymbol[newSymbols.size()];

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

				mySymbols[i] = newSymbols.get(i).sym;

			}

			return mySymbols;

		}

		return null;

	}

	public ISymbol getDefaultSymbol() {

		if(defaultSymbol==null) {

		    defaultSymbol = MapContextLocator.getSymbolManager(

		        ).createSymbol(shapeType);

			fireDefaultSymbolChangedEvent(new SymbolLegendEvent(null, defaultSymbol));

		}

		return defaultSymbol;

	}

	public String getClassName() {

		return getClass().getName();

	}

	public int getShapeType() {

		return shapeType;

	}

	public boolean isUseDefaultSymbol() {

		return useDefaultSymbol;

	}

	public void setDefaultSymbol(ISymbol s) throws IllegalArgumentException {

		if (s == null) throw new NullPointerException("Default symbol cannot be null");

		ISymbol old = defaultSymbol;

		defaultSymbol = s;

		fireDefaultSymbolChangedEvent(new SymbolLegendEvent(old, defaultSymbol));

	}

	public void setShapeType(int shapeType) {

		if (this.shapeType != shapeType) {

		    ISymbol sym = MapContextLocator.getSymbolManager(

		        ).createSymbol(shapeType);

			setDefaultSymbol(sym);

			this.shapeType = shapeType;

		}

	}

	public void useDefaultSymbol(boolean b) {

		useDefaultSymbol = b;

	}

	public Object[] getValues() {

		if (newSymbols != null) {

			Object[] myObjects = new Object[newSymbols.size()];

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

				myObjects[i] = newSymbols.get(i).getStringExpression();

			}

			return myObjects;

		}

		return null;

	}

    public static boolean isPolygonal(int ty) {

        if (ty == Geometry.TYPES.MULTISURFACE

            || ty == Geometry.TYPES.SURFACE

            ) {

            return true;

        } else {

            return false;

        }

    }

    public static boolean isLinear(int ty) {

        if (ty == Geometry.TYPES.CIRCLE

            || ty == Geometry.TYPES.ARC

            || ty == Geometry.TYPES.CURVE

            || ty == Geometry.TYPES.ELLIPSE

            || ty == Geometry.TYPES.ELLIPTICARC

            || ty == Geometry.TYPES.SPLINE

            || ty == Geometry.TYPES.MULTICURVE

            ) {

            return true;

        } else {

            return false;

        }

    }

    public static boolean isPoint(int ty) {

        if (ty == Geometry.TYPES.POINT

            || ty == Geometry.TYPES.MULTIPOINT

            ) {

            return true;

        } else {

            return false;

        }

    }

    public void removeDefaultSymbol() {

    }

    // =============================

    public static class RegisterPersistence implements Callable {

        public Object call() throws Exception {

            PersistenceManager manager = ToolsLocator.getPersistenceManager();

            if (manager.getDefinition(

                FILTER_EXPRESSION_LEGEND_PERSISTENCE_DEFINITION_NAME) == null) {

                DynStruct definition = manager

                    .addDefinition(VectorFilterExpressionLegend.class,

                        FILTER_EXPRESSION_LEGEND_PERSISTENCE_DEFINITION_NAME,

                        FILTER_EXPRESSION_LEGEND_PERSISTENCE_DEFINITION_NAME

                        + " Persistence definition", null, null);

                definition.extend(manager.getDefinition(

                    AbstractClassifiedVectorLegend

                    .CLASSIFIED_VECTOR_LEGEND_PERSISTENCE_DEFINITION_NAME));

                definition.addDynFieldBoolean("useDefaultSymbol")

                .setMandatory(true);

                definition.addDynFieldObject("defaultSymbol")

                .setClassOfValue(ISymbol.class).setMandatory(true);

                definition.addDynFieldInt("shapeType")

                .setMandatory(true);

                definition.addDynFieldArray("itemSymbolArray")

                .setClassOfItems(ISymbol.class);

                definition.addDynFieldArray("itemStringArray")

                .setClassOfItems(String.class);

            }

            return Boolean.TRUE;

        }

    }

    public static class RegisterLegend implements Callable {

        public Object call() throws Exception {

            MapContextManager manager =

                MapContextLocator.getMapContextManager();

            manager.registerLegend(

                FILTER_EXPRESSION_LEGEND_NAME,

                VectorFilterExpressionLegend.class);

            return Boolean.TRUE;

        }

    }

    public void saveToState(PersistentState state) throws PersistenceException {

        super.saveToState(state);

        state.set("useDefaultSymbol", this.isUseDefaultSymbol());

        state.set("defaultSymbol", this.getDefaultSymbol());

        state.set("shapeType", this.getShapeType());

        ISymbol[] syms = this.getSymbols();

        if (syms == null) {

            syms = new ISymbol[0];

        }

        Object[] vals = this.getValues();

        String[] vals_str = null;

        if (vals == null) {

            vals_str = new String[0];

        } else {

            vals_str = new String[vals.length];

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

                String aux = ((vals[i] == null) ? null : vals[i].toString());

                // Prevents saving localized version of 'Default'

                aux = translateDefault(aux, false);

                vals_str[i] = aux;

            }

        }

        state.set("itemSymbolArray", syms);

        state.set("itemStringArray", vals_str);

    }

    public void loadFromState(PersistentState state)

        throws PersistenceException {

        super.loadFromState(state);

        this.setShapeType(state.getInt("shapeType"));

        Boolean b = state.getBoolean("useDefaultSymbol");

        this.useDefaultSymbol(b);

        ISymbol defsym = (ISymbol) state.get("defaultSymbol");

        this.setDefaultSymbol(defsym);

        String[] strs = state.getStringArray("itemStringArray");

        ISymbol[] syms = (ISymbol[]) state.getArray("itemSymbolArray",

            ISymbol.class);

        if (strs.length != syms.length) {

            logger.info("VectorFilterExpressionLegend - load state - Different size in arrays: " + strs.length + ", " + syms.length);

        }

        int nmin = Math.min(strs.length, syms.length);

        for (int i=0; i<nmin; i++) {

            String aux = strs[i];

            aux = translateDefault(aux, true);

            this.addSymbol(aux, syms[i]);

        }

    }

    /**

     * Utility method to (un)translate the word 'Default'

     * @param aux

     * @param forward

     * If TRUE, then translate (Default -> Por defecto)

     * If FALSE then untranslate (Por defecto -> Default)

     * @return

     */

    private String translateDefault(String aux, boolean forward) {

        if (aux == null) {

            return null;

        }

        if (forward && aux.compareTo(NON_I18N_DEFAULT) == 0) {

            return I18N_DEFAULT;

        }

        if (!forward && aux.compareTo(I18N_DEFAULT) == 0) {

            return NON_I18N_DEFAULT;

        }

        return aux;

    }

    public Object clone() throws CloneNotSupportedException {

        VectorFilterExpressionLegend resp =

            (VectorFilterExpressionLegend) super.clone();

        Object[] vals = this.getValues();

        ISymbol[] syms = this.getSymbols();

        if (vals != null && syms != null) {

            resp.resetItems();

            int n = Math.min(vals.length, syms.length);

            for (int i=0; i<n; i++) {

                resp.addSymbol(

                    vals[i],

                    (ISymbol) syms[i].clone());

            }

        }

        ISymbol sym = this.getDefaultSymbol();

        sym = (ISymbol) sym.clone();

        resp.setDefaultSymbol(sym);

        return resp;

    }

}

/* 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. 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());