Application: gvSIG desktop » gvSIG legends: base legends

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

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

        GeometryManager geomManager = GeometryLocator.getGeometryManager();

        return geomManager.isSubtype(Geometry.TYPES.MULTISURFACE, ty) ||

            geomManager.isSubtype(Geometry.TYPES.SURFACE, ty);

    }

    public static boolean isLinear(int ty) {

        GeometryManager geomManager = GeometryLocator.getGeometryManager();

        return geomManager.isSubtype(Geometry.TYPES.MULTICURVE, ty) ||

            geomManager.isSubtype(Geometry.TYPES.CURVE, ty);

    }

    public static boolean isPoint(int ty) {

        GeometryManager geomManager = GeometryLocator.getGeometryManager();

        return geomManager.isSubtype(Geometry.TYPES.MULTIPOINT, ty) ||

            geomManager.isSubtype(Geometry.TYPES.POINT, ty);

    }

    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;

    }

}