Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.symbology.fmap.mapcontext.rendering.symbol.impl;

import java.awt.Color;

import java.awt.Graphics2D;

import java.awt.Rectangle;

import java.awt.geom.AffineTransform;

import org.gvsig.compat.print.PrintAttributes;

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

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

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

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.mapcontext.MapContext;

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

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

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

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

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.PersistentState;

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

import org.gvsig.tools.task.Cancellable;

import org.gvsig.tools.util.Callable;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Abstract class that implements the interface the interface for symbols.It is

 * considered as the father of all XXXSymbols and will implement all the methods

 * that these classes had not developed (and correspond with one of the methods

 * of AbstractSymbol class)

 *

 * @author gvSIG Team

 */

public abstract class AbstractSymbol extends AbstractCartographicSupport implements ISymbol_v2, CartographicSupport {

    protected static final Logger LOGGER = LoggerFactory.getLogger(AbstractSymbol.class);

    public static final String SYMBOL_PERSISTENCE_DEFINITION_NAME = "Symbol";

    private static final String FIELD_UNIT = "unit";

    private static final String FIELD_REFERENCE_SYSTEM = "referenceSystem";

    private static final String FIELD_IS_SHAPE_VISIBLE = "isShapeVisible";

    private static final String FIELD_DESCRIPTION = "description";

    private String desc;

    private String id;

    private boolean isShapeVisible = true;

    private transient Feature feature;

    public AbstractSymbol() {

        super();

    }

    @Override

    public Feature getFeature() {

        return this.feature;

    }

    @Override

    public void setFeature(Feature feature) {

        this.feature = feature;

    }

    @Override

    public final void setDescription(String desc) {

        this.desc = desc;

    }

    @Override

    public final String getDescription() {

        return desc;

    }

    @Override

    public final void setID(String id) {

        this.id = id;

    }

    @Override

    public final String getID() {

        return id;

    }

    @Override

    public boolean isShapeVisible() {

        return isShapeVisible;

    }

    /**

     * Sets this symbol to visible

     *

     * @param isShapeVisible

     */

    public final void setIsShapeVisible(boolean isShapeVisible) {

        this.isShapeVisible = isShapeVisible;

    }

    private boolean areEquals(Object a, Object b) {

        if (a == null) {

            if (b == null) {

                return true;

            }

            return false;

        } else {

            if (b == null) {

                return false;

            }

        }

        return a.equals(b);

    }

    @Override

    @SuppressWarnings("UnusedAssignment")

    public boolean equals(Object obj) {

        ISymbol other = null;

        if (!(obj instanceof ISymbol)) {

            return false;

        }

        other = (ISymbol) obj;

        if (!areEquals(other.getClass(), this.getClass())) {

            return false;

        }

        if (!areEquals(other.getColor(), this.getColor())) {

            return false;

        }

        if (!areEquals(other.getDescription(), this.getDescription())) {

            return false;

        }

        return true;

    }

    @Override

    public Object clone() throws CloneNotSupportedException {

        return super.clone();

    }

    protected ISymbol cloneForSelection() {

        return cloneForSelection(MapContext.DEFAULT_SELECTION_COLOR);

    }

    protected ISymbol cloneForSelection(Color selectionColor) {

        try {

            ISymbol selectionSymbol = (ISymbol) clone();

            selectionSymbol.setColor(selectionColor);

            if (getDescription() != null) {

                selectionSymbol.setDescription(getDescription().concat(

                        " version for selection"));

            } else {

                selectionSymbol.setDescription("version for selection");

            }

            return selectionSymbol;

        } catch (CloneNotSupportedException e) {

            LOGGER.error(

                    "Error creating the selection symbol for the symbol "

                    + this, e);

        }

        return null;

    }

    @Override

    public void loadFromState(PersistentState state)

            throws PersistenceException {

        setDescription(state.getString(FIELD_DESCRIPTION));

        setIsShapeVisible(state.getBoolean(FIELD_IS_SHAPE_VISIBLE));

        setReferenceSystem(state.getInt(FIELD_REFERENCE_SYSTEM));

        setUnit(state.getInt(FIELD_UNIT));

    }

    @Override

    public void saveToState(PersistentState state) throws PersistenceException {

        state.set(FIELD_DESCRIPTION, getDescription());

        state.set(FIELD_IS_SHAPE_VISIBLE, isShapeVisible());

        state.set(FIELD_REFERENCE_SYSTEM, getReferenceSystem());

        state.set(FIELD_UNIT, getUnit());

    }

    public static class RegisterPersistence implements Callable {

        @Override

        public Object call() throws Exception {

            PersistenceManager manager = ToolsLocator.getPersistenceManager();

            if (manager.getDefinition(SYMBOL_PERSISTENCE_DEFINITION_NAME) == null) {

                DynStruct definition = manager.addDefinition(

                        AbstractSymbol.class,

                        SYMBOL_PERSISTENCE_DEFINITION_NAME,

                        SYMBOL_PERSISTENCE_DEFINITION_NAME + " persistence definition",

                        null,

                        null

                );

                // Description

                definition.addDynFieldString(FIELD_DESCRIPTION);

                // Is Shape Visible

                definition.addDynFieldBoolean(FIELD_IS_SHAPE_VISIBLE).setMandatory(true);

                // Reference system

                definition.addDynFieldInt(FIELD_REFERENCE_SYSTEM).setMandatory(true);

                // Unit

                definition.addDynFieldInt(FIELD_UNIT).setMandatory(true);

            }

            return Boolean.TRUE;

        }

    }

    public String[] getRequiredFeatureAttributeNames(FeatureStore featureStore) throws DataException {

        // By default only need the default Geometry

        return new String[]{featureStore.getDefaultFeatureType().getDefaultGeometryAttributeName()};

    }

    @Override

    public void draw(Graphics2D g, AffineTransform affineTransform, Geometry geom, Feature f, Cancellable cancel) {

        draw(g, affineTransform, geom, f, cancel, null);

    }

    @Override

    public void drawInsideRectangle(Graphics2D g, AffineTransform affineTransform, Rectangle r) throws SymbolDrawingException {

        draw(g, affineTransform, null, null, null, r);

    }

    @Override

    public void print(Graphics2D g, AffineTransform affineTransform, Geometry geom, PrintAttributes properties) {

        draw(g, affineTransform, geom, null, null, null);

    }

    @Override

    public ISymbol getSymbolForSelection() {

        return this.getSymbolForSelection(MapContext.DEFAULT_SELECTION_COLOR);

    }

    @Override

    public ISymbol getSymbolForSelection(Color selectionColor) {

        //Only for compatibility purposes

        return this.getSymbolForSelection();

    }

}