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

import java.awt.Color;

import java.awt.Graphics;

import java.awt.Graphics2D;

import java.awt.geom.Rectangle2D;

import java.awt.image.BufferedImage;

import java.util.ArrayList;

import java.util.Collection;

import java.util.HashSet;

import java.util.Iterator;

import java.util.LinkedHashMap;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.function.Predicate;

import org.apache.commons.lang3.ArrayUtils;

import org.cresques.cts.ICoordTrans;

import org.cresques.cts.IProjection;

import org.cresques.geo.Projected;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.compat.CompatLocator;

import org.gvsig.compat.print.PrintAttributes;

import org.gvsig.fmap.dal.DataStore;

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

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

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.Geometry.SUBTYPES;

import org.gvsig.fmap.geom.GeometryLocator;

import org.gvsig.fmap.geom.GeometryManager;

import org.gvsig.fmap.geom.GeometryUtils;

import org.gvsig.fmap.geom.exception.CreateEnvelopeException;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.fmap.geom.primitive.Point;

import org.gvsig.fmap.mapcontext.events.ErrorEvent;

import org.gvsig.fmap.mapcontext.events.listeners.AtomicEventListener;

import org.gvsig.fmap.mapcontext.events.listeners.ErrorListener;

import org.gvsig.fmap.mapcontext.events.listeners.EventBuffer;

import org.gvsig.fmap.mapcontext.exceptions.LoadLayerException;

import org.gvsig.fmap.mapcontext.impl.DefaultMapContextManager;

import org.gvsig.fmap.mapcontext.layers.BaseLayerCollectionListener;

import org.gvsig.fmap.mapcontext.layers.FLayer;

import org.gvsig.fmap.mapcontext.layers.FLayers;

import org.gvsig.fmap.mapcontext.layers.LayerCollectionEvent;

import org.gvsig.fmap.mapcontext.layers.LayerCollectionListener;

import org.gvsig.fmap.mapcontext.layers.LayerDrawEvent;

import org.gvsig.fmap.mapcontext.layers.LayerDrawingListener;

import org.gvsig.fmap.mapcontext.layers.LayerPositionEvent;

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

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

import org.gvsig.fmap.mapcontext.layers.order.LayerOrderManager;

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

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

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

import org.gvsig.fmap.mapcontext.rendering.legend.events.listeners.LegendListener;

import org.gvsig.fmap.mapcontext.rendering.strategies.SelectedEnvelopeVisitor;

import org.gvsig.timesupport.AbsoluteInstant;

import org.gvsig.timesupport.AbsoluteIntervalTypeNotRegisteredException;

import org.gvsig.timesupport.Instant;

import org.gvsig.timesupport.Interval;

import org.gvsig.timesupport.RelativeInstant;

import org.gvsig.timesupport.TimeSupportLocator;

import org.gvsig.timesupport.TimeSupportManager;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.dispose.DisposeUtils;

import org.gvsig.tools.dispose.impl.AbstractDisposable;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.observer.Observer;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.Persistent;

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.gvsig.tools.visitor.Visitor;

/**

 * <p>

 * The <code>MapContext</code> class represents the model and a part of the

 * control and view around graphical layers used by

 * {@link MapControl MapControl}.</p>

 *

 * <p>

 * An instance of <code>MapContext</code> is made up with:

 * <ul>

 * <li>a hierarchy of {@link FLayers FLayers} nodes

 * <li>a {@link GraphicLayer GraphicLayer} layer

 * <li>a {@link ViewPort ViewPort}

 * <li>an {@link EventBuffer EventButter}

 * <li>some

 * {@link com.iver.cit.gvsig.fmap.layers.LegendListener LegendListener}s

 * <li>some {@link LayerDrawingListener LayerDrawingListener}s

 * <li>some {@link ErrorListener ErrorListener}s

 * </ul>

 * </p>

 */

public class MapContext extends AbstractDisposable implements Projected,

        Persistent, Observer, Iterable<FLayer> {

    public interface MapTimeContext {

        public Interval getInterval();

        public List<Instant> getTimes();

    }    

    /**

     * @deprecated use getDistanceTrans2Meter()

     */

    public static final double[] CHANGEM = {1000, 1, 0.01, 0.001, 1609.344,

        0.9144, 0.3048, 0.0254, 1 / 8.983152841195214E-6};

    public static ArrayList AREANAMES = new ArrayList();

    public static ArrayList AREAABBR = new ArrayList();

    public static ArrayList AREATRANS2METER = new ArrayList();

    public static ArrayList DISTANCENAMES = new ArrayList();

    public static ArrayList DISTANCEABBR = new ArrayList();

    public static ArrayList DISTANCETRANS2METER = new ArrayList();

    static {

        MapContext.addDistanceUnit("Kilometros", "Km", 1000);

        MapContext.addDistanceUnit("Metros", "m", 1);

        MapContext.addDistanceUnit("Centimetros", "cm", 0.01);

        MapContext.addDistanceUnit("Milimetros", "mm", 0.001);

        MapContext.addDistanceUnit("Millas", "mi", 1609.344);

        MapContext.addDistanceUnit("Yardas", "Ya", 0.9144);

        MapContext.addDistanceUnit("Pies", "ft", 0.3048);

        MapContext.addDistanceUnit("Pulgadas", "inche", 0.0254);

        MapContext.addDistanceUnit("Grados", "?", 1 / 8.983152841195214E-6);

        MapContext.addAreaUnit("Kilometros", "Km", true, 1000);

        MapContext.addAreaUnit("Metros", "m", true, 1);

        MapContext.addAreaUnit("Centimetros", "cm", true, 0.01);

        MapContext.addAreaUnit("Milimetros", "mm", true, 0.001);

        MapContext.addAreaUnit("Millas", "mi", true, 1609.344);

        MapContext.addAreaUnit("Yardas", "Ya", true, 0.9144);

        MapContext.addAreaUnit("Pies", "ft", true, 0.3048);

        MapContext.addAreaUnit("Pulgadas", "inche", true, 0.0254);

        MapContext.addAreaUnit("Grados", "?", true, 1 / 8.983152841195214E-6);

    }

    private static final GeometryManager GEOM_MANAGER = GeometryLocator.getGeometryManager();

    private static final MapContextManager MAPCONTEXT_MANAGER = MapContextLocator.getMapContextManager();

    private static final Logger LOGGER = LoggerFactory.getLogger(MapContext.class);

    private long scaleToUseWhenEnvelopeCollapse = 10000000;

    private boolean printGraphicsLayer;

    /**

     * <p>

     * Determines the number of frames.</p>

     *

     * <p>

     * Number of updates per second that the timer will invoke repaint this

     * component.</p>

     */

    private static int drawFrameRate = 3;

    /**

     * <p>

     * Returns the draw frame rate.</p>

     *

     * <p>

     * Draw frame rate is the number of repaints of this <code>MapControl</code>

     * instance that timer invokes per second.</p>

     *

     * @return number of repaints of this <code>MapControl</code> instance that

     * timer invokes per second

     *

     * @see #applyFrameRate()

     * @see #setDrawFrameRate(int)

     */

    public static int getDrawFrameRate() {

        return drawFrameRate;

    }

    /**

     * <p>

     * Sets the draw frame rate.</p>

     *

     * <p>

     * Draw frame rate is the number of repaints of this <code>MapControl</code>

     * instance that timer invokes per second.</p>

     *

     * @param theDrawFrameRate number of repaints of this <code>MapControl</code>

     * instance that timer invokes per second

     *

     * @see #applyFrameRate()

     * @see #getDrawFrameRate()

     */

    public static void setDrawFrameRate(int theDrawFrameRate) {

        drawFrameRate = theDrawFrameRate;

    }

    public static void addAreaUnit(String name, String abbr, boolean isLinear, double trans2meter) {

        if (!AREANAMES.contains(name)) {

            AREANAMES.add(name);

            String pow = "";

            if (isLinear) {

                pow = String.valueOf((char) 178);

            }

            AREAABBR.add(abbr + pow);

            AREATRANS2METER.add(trans2meter);

        }

    }

    public static String[] getAreaNames() {

        return (String[]) AREANAMES.toArray(new String[0]);

    }

    public static String[] getAreaAbbr() {

        return (String[]) AREAABBR.toArray(new String[0]);

    }

    public static double[] getAreaTrans2Meter() {

        int size = AREATRANS2METER.size();

        double[] trans2meters = new double[size];

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

            trans2meters[i] = ((Double) AREATRANS2METER.get(i));

        }

        return trans2meters;

    }

    public static String getOfLinear(int i) {

        if (((String) AREAABBR.get(i)).toLowerCase().endsWith(String.valueOf((char) 178))) {

            return String.valueOf((char) 178);

        }

        return "";

    }

    public static void addDistanceUnit(String name, String abbr, double trans2meter) {

        if (!DISTANCENAMES.contains(name)) {

            DISTANCENAMES.add(name);

            DISTANCEABBR.add(abbr);

            DISTANCETRANS2METER.add(trans2meter);

        }

    }

    public static String[] getDistanceNames() {

        return (String[]) DISTANCENAMES.toArray(new String[0]);

    }

    public String getDistanceName() {

        return (String) DISTANCENAMES.get(this.getViewPort().getDistanceUnits());

    }

    public static String[] getDistanceAbbr() {

        return (String[]) DISTANCEABBR.toArray(new String[0]);

    }

    public static double[] getDistanceTrans2Meter() {

        int size = DISTANCETRANS2METER.size();

        double[] trans2meters = new double[size];

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

            trans2meters[i] = ((Double) DISTANCETRANS2METER.get(i));

        }

        return trans2meters;

    }

    public static int getDistancePosition(String s) {

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

            if (DISTANCENAMES.get(i).equals(s)) {

                return i;

            }

        }

        return 0;

    }

    /**

     * <p>

     * Defines the value which a unit of a distance measurement must be divided

     * to obtain its equivalent <b>in centimeters</b>.</p>

     *

     * <p>

     * <b><i>Conversion values of distance measurements:</i></b>

     * <ul>

     * <li><code>MapContext.CHANGE[0]</code>: kilometer

     * <li><code>MapContext.CHANGE[1]</code>: meter

     * <li><code>MapContext.CHANGE[2]</code>: centimeter

     * <li><code>MapContext.CHANGE[3]</code>: millimeter

     * <li><code>MapContext.CHANGE[4]</code>: international statute mile

     * <li><code>MapContext.CHANGE[5]</code>: yard

     * <li><code>MapContext.CHANGE[6]</code>: foot

     * <li><code>MapContext.CHANGE[7]</code>: inch

     * <li><code>MapContext.CHANGE[8]</code>: grade

     * </ul>

     *

     * <p>

     * <h3>Examples:</h3>

     * <pre>1 international statute mile / MapContext.CHANGE[4] = X centimeters</pre>

     * <pre>1 kilometer / MapContext.CHANGE[0] = X centimeters</pre>

     * <pre>1 grade / MapContext.CHANGE[8] = X centimeters</pre>

     * </p>

     *

     * <p>

     * <h3>Grade conversion value: <code>MapContext.CHANGE[8]</code></h3>

     * The value of <code>MapContext.CHANGE[8]</code> represents the centimeters

     * of a straight line between two points on the Earth surface that are 1

     * grade far each other of the center of the Earth. This value has been

     * calculated using a radius approximated of

     * R<sub>Earth</sub>=6.37846082678100774672e6 meters, according these

     * equations:

     * <pre>D = 2 * (sin (1)) * R<sub>Earth</sub></pre>

     * <pre>MapContext.CHANGE[8] = 1 / D</pre>

     * <h4>Explanation:</h4>

     * We get an isosceles triangle with the center of the Earth and the 2

     * points on the surface. This triangle can be divided into two rectangle

     * triangles. We know two values, the angle of 1 grade, that will be 0.50

     * grades in each triangle, and the Earth radius that is the hypotenuse.

     * Then we apply trigonometry and get the distance <i>D</i> between both

     * points on the Earth surface.</p>

     * <p>

     * Now we only must invert that value to obtain

     * <code>MapContext.CHANGE[8]</code>.</p>

     *

     * @deprecated use getDistanceTrans2Meter() * 100

     */

    public static final double[] CHANGE = {100000, 100, 1, 0.1, 160934.4,

        91.44, 30.48, 2.54, 1 / 8.983152841195214E-4};

    public static final int EQUALS = 0;

    public static final int DISJOINT = 1;

    public static final int INTERSECTS = 2;

    public static final int TOUCHES = 3;

    public static final int CROSSES = 4;

    public static final int WITHIN = 5;

    public static final int CONTAINS = 6;

    public static final int OVERLAPS = 7;

    /**

     * A hierarchy of {@link FLayers FLayers} nodes.

     */

    protected FLayers layers;

    /**

     * A List of layers with graphical items: geometries and symbols.

     */

    private static final String DEFAULT_TRACTLAYER = "Default";

    private Map<String, VectorLayer> tracLayers;

    /**

     * Information for draw layers in a view.

     *

     * @see #getViewPort()

     * @see #setViewPort(ViewPort)

     */

    private ViewPort viewPort;

    // private ArrayList invalidationListeners = new ArrayList();

    /**

     * Array list with all {@link LegendListener LegendListener} registered to

     * this map.

     *

     * @see #addLayerListener(LegendListener)

     * @see #removeLayerListener(LegendListener)

     * @see #callLegendChanged()

     */

    private List legendListeners;

    /**

     * Array list with all {@link LayerDrawingListener LayerDrawingListener}

     * registered to this map.

     *

     * @see #addLayerDrawingListener(LayerDrawingListener)

     * @see #removeLayerDrawListener(LayerDrawingListener)

     * @see #fireLayerDrawingEvent(LayerDrawEvent)

     */

    private ArrayList layerDrawingListeners = new ArrayList();

    /**

     * <p>

     * Buffer that is used to store and eject events produced on this map:

     * <ul>

     * <li>Layer collection events.

     * <li>View port events.

     * <li>Atomic events.

     * <li>Layer events.

     * <li>Legend events on a {@link Classificable Classificable} layer.

     * <li>Selection events on an {@link AlphanumericData AlphanumericData} data

     * layer.

     * </ul>

     * </p>

     *

     * @see #addAtomicEventListener(AtomicEventListener)

     * @see #removeAtomicEventListener(AtomicEventListener)

     * @see #beginAtomicEvent()

     * @see #endAtomicEvent()

     */

    private EventBuffer eventBuffer = new EventBuffer();

    /**

     * Event listener for the collection of layers of this map.

     */

    private LayerEventListener layerEventListener = null;

    /**

     * List with information of all errors produced on all layers.

     *

     * @see #addLayerError(String)

     * @see #getLayersError()

     * @see #clearErrors()

     */

    private ArrayList layersError = new ArrayList();

    /**

     * Array list with all {@link ErrorListener ErrorListener} registered to

     * this map.

     *

     * @see #addErrorListener(ErrorListener)

     * @see #removeErrorListener(LegendListener)

     * @see #reportDriverExceptions(String, List)

     */

    private ArrayList errorListeners = new ArrayList();

    /**

     * Layer order manager decides position of layers added to this map context.

     */

    private LayerOrderManager orderManager = null;

        // public static ResourceBundle myResourceBundle =

    // ResourceBundle.getBundle("FMap");

    /**

     * <p>

     * Default <i>zoom in</i> factor.</p>

     * <p>

     * Doing a <i>zoom in</i> operation, decreases the focal distance and

     * increases the eyesight angle to the surface. This allows view an smaller

     * area but with the items bigger.</p>

     */

    public static double ZOOMINFACTOR = 2;

    /**

     * <p>

     * Default <i>zoom out</i> factor.</p>

     * <p>

     * Doing a <i>zoom out</i> operation, increases the focal distance and

     * decreases the eyesight angle to the surface. This allows view a bigger

     * area but with the items smaller.</p>

     */

    public static double ZOOMOUTFACTOR = 0.5;

    /**

     *          * Draw version of the context. It's used for know when de componend has

     * changed any visualization property

     *

     * @see getDrawVersion

     * @see updateDrawVersion

     */

    private long drawVersion = 0L;

    private long layersVersion = 0L;

    private long viewPortVersion = 0L;

    private long graphicsLayerVersion = 0L;

    /**

     * Object to Manage Draw of MapContext

     */

    private MapContextDrawer mapContextDrawer = null;

    /**

     * Object to Manage Draw of MapContext

     */

    private Class mapContextDrawerClass = null;

    /**

     * <p>

     * Color used to represent the selections.</p>

     */

    private static Color selectionColor = new Color(Color.YELLOW.getRed(), Color.YELLOW.getGreen(), Color.YELLOW.getBlue(), 127);

    private Set<FLyrVect> layersToSnap = new LayersToSnap();

    /**

     * <p>

     * Gets the color used to represent the selections.</p>

     *

     * @return color used to represent the selections

     */

    public static Color getSelectionColor() {

        return selectionColor;

    }

    /**

     * <p>

     * Sets the color used to represent the selections.</p>

     *

     * @param selectionColor color used to represent the selections

     */

    public static void setSelectionColor(Color selectionColor) {

        MapContext.selectionColor = selectionColor;

    }

    /**

     * <p>

     * Creates a new map context with the drawing information defined in the

     * view port argument, and without layers.</p>

     *

     * @param vp information for drawing the layers of this map in the available

     * rectangular area according a projection

     */

    public MapContext(ViewPort vp) {

        this(new FLayers(), vp);

    }

    public MapContext() {

        this.legendListeners = new ArrayList();

        this.tracLayers = new LinkedHashMap<>();

        this.layerEventListener = new LayerEventListener();

    }

    /**

     * <p>

     * Creates a new map context with the layers and the drawing information

     * defined in the view port arguments.</p>

     *

     * @param fLayers the initial hierarchy of nodes of layers that this map

     * will have

     * @param vp information for drawing the layers of this map in the available

     * rectangular area according a projection

     */

    public MapContext(FLayers fLayers, ViewPort vp) {

        this();

        this.layers = fLayers;

        if (layers != null) {

            layers.setMapContext(this);

            layers.addLayerCollectionListener(layerEventListener);

            layers.addLayerCollectionListener(eventBuffer);

        }

        setViewPort(vp);

    }

    /**

     * <p>

     * Reports to all driver error listeners registered of a bundle of driver

     * exceptions caused in the same map atomic transaction.</p>

     *

     * @param introductoryText introductory text specified by developer. If

     * <code>null</code>, use ""

     * @param driverExceptions list with a bundle of driver exceptions caught

     * during an atomic event

     *

     * @see #addErrorListener(ErrorListener)

     * @see #removeErrorListener(LegendListener)

     */

    public synchronized void reportDriverExceptions(String introductoryText,

            List driverExceptions) {

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

            ((ErrorListener) errorListeners.get(i)).

                    reportDriverExceptions(introductoryText, driverExceptions);

        }

    }

    /**

     * <p>

     * Adds the specified legend listener (if didn't exist) to receive legend

     * events from this map.</p>

     *

     * @param listener the legend listener

     *

     * @see #removeLayerListener(LegendListener)

     * @see #callLegendChanged()

     */

    public void addLayerListener(LegendListener listener) {

        if (!legendListeners.contains(listener)) {

            legendListeners.add(listener);

        }

    }

    /**

     * <p>

     * Adds the specified layer drawing listener to catch and handle drawing

     * events from layers of this map.</p>

     *

     * @param listener the listener to add

     *

     * @see #removeLayerDrawListener(LayerDrawingListener)

     * @see #fireLayerDrawingEvent(LayerDrawEvent)

     */

    public void addLayerDrawingListener(LayerDrawingListener listener) {

        layerDrawingListeners.add(listener);

    }

    /**

     * <p>

     * Removes the specified layer drawing listener from this map.</p>

     *

     * @param listener the listener to remove

     *

     * @see #addLayerDrawingListener(LayerDrawingListener)

     * @see #fireLayerDrawingEvent(LayerDrawEvent)

     */

    public void removeLayerDrawListener(LayerDrawingListener listener) {

        layerDrawingListeners.remove(listener);

    }

    /**

     * <p>

     * Adds the specified error listener to receive error events from this

     * map.</p>

     *

     * @param listener the listener to add

     *

     * @see #removeErrorListener(LegendListener)

     * @see #reportDriverExceptions(String, List)

     */

    public void addErrorListener(ErrorListener listener) {

        errorListeners.add(listener);

    }

    /**

     * <p>

     * Removes the specified error listener from this map.</p>

     *

     * @param listener the listener to remove

     *

     * @see #addErrorListener(ErrorListener)

     * @see #reportDriverExceptions(String, List)

     */

    public void removeErrorListener(LegendListener listener) {

        legendListeners.remove(listener);

    }

    /**

     * Notifies to all legend listeners registered, that one legend has

     * changed.

     * 

     * This method must be called only if it's wanted to reflect a legend

     * change.

     *

     * @see #addLayerListener(LegendListener)

     * @see #removeLayerListener(LegendListener)

     */

    public synchronized void callLegendChanged() {

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

            ((LegendListener) legendListeners.get(i)).legendChanged(null);

        }

        // getLayers().moveTo(0,0);

    }

    /**

     * <p>

     * Fires a layer drawing event to all

     * {@link LayerDrawingListener LayerDrawingListener} listeners registered,

     * distinguishing the kind of event.</p>

     *

     * @param e the event

     *

     * @see #addLayerDrawingListener(LayerDrawingListener)

     * @see #removeLayerDrawListener(LayerDrawingListener)

     */

    public synchronized void fireLayerDrawingEvent(LayerDrawEvent e) {

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

            LayerDrawingListener listener = (LayerDrawingListener) layerDrawingListeners.get(i);

            switch (e.getEventType()) {

                case LayerDrawEvent.LAYER_BEFORE_DRAW:

                    listener.beforeLayerDraw(e);

                    break;

                case LayerDrawEvent.LAYER_AFTER_DRAW:

                    listener.afterLayerDraw(e);

                    break;

                case LayerDrawEvent.GRAPHICLAYER_BEFORE_DRAW:

                    listener.beforeGraphicLayerDraw(e);

                    break;

                case LayerDrawEvent.GRAPHICLAYER_AFTER_DRAW:

                    listener.afterLayerGraphicDraw(e);

                    break;

            }

        }

        // getLayers().moveTo(0,0);

    }

    /**

     * <p>

     * Notifies to all error listeners registered, that one error has been

     * produced.</p>

     *

     * @param e the event with information of the error

     *

     * @see #addErrorListener(ErrorListener)

     * @see #removeErrorListener(LegendListener)

     * @see #reportDriverExceptions(String, List)

     */

    public synchronized void callNewErrorEvent(ErrorEvent e) {

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

            ((ErrorListener) errorListeners.get(i)).errorThrown(e);

        }

        errorListeners.clear();

        // getLayers().moveTo(0,0);

    }

    /**

     * <p>

     * Removes the specified layer listener from this map.</p>

     *

     * @param listener the listener to remove

     *

     * @see #addLayerListener(LegendListener)

     * @see #callLegendChanged()

     */

    public void removeLayerListener(LegendListener listener) {

        legendListeners.remove(listener);

    }

    /**

     * <p>

     * Returns the hierarchy of {@link FLayers FLayers} nodes stored in this

     * map.</p>

     *

     * @return the hierarchy of nodes of layers stored in this map

     */

    public FLayers getLayers() {

        return layers;

    }

    /**

     * <p>

     * Draws the visible layers of this map according its view port, on the

     * image parameter.</p>

     *

     * @param b image with an accessible buffer of image data

     */

    public void drawLabels(BufferedImage b) {

    }

    /**

     * @see #redraw()

     */

    public void invalidate() {

        updateDrawVersion();

        this.viewPort.updateDrawVersion();

        // Small hack to let the MapControl receive an event and repaint

        FLayer layer;

        if (layers.getLayersCount() > 0) {

            layer = layers.getLayer(layers.getLayersCount() - 1);

        } else {

            layer = getGraphicsLayer();

        }

        LayerPositionEvent event = LayerPositionEvent.createLayerMovedEvent(layer, 0, 0);

        eventBuffer.layerMoved(event);

    }

    /**

     * <p>

     * Prints the layers of this map using the {@link Graphics2D Graphics2D}

     * argument, that usually is the {@link Graphics Graphics} of the printer.

     * </p>

     *

     * @param g for rendering 2-dimensional shapes, text and images on the

     * Java(tm) platform

     * @param scale the scale of the view. Must be between

     * {@linkplain FLayer#getMinScale()} and {@linkplain FLayer#getMaxScale()}.

     * @param properties a set with the settings to be applied to a whole print

     * job and to all the documents in the print job

     * @throws MapContextException if there is an error getting the instance of

     * MapContextDrawer

     *

     * @throws ReadDriverException if fails reading with driver.

     *

     * @see GraphicLayer#draw(BufferedImage, Graphics2D, ViewPort, Cancellable,

     * double)

     */

    public void print(Graphics2D g, double scale,

            PrintAttributes properties) throws ReadException,

            MapContextException {

        CompatLocator.getGraphicsUtils().setRenderingHintsForPrinting(g);

        Cancellable cancel = new Cancellable() {

            public boolean isCanceled() {

                return false;

            }

            public void setCanceled(boolean canceled) {

                // No queremos que se pueda cancelar la impresi?n.

            }

        };

        MapContextDrawer drawer = this.getMapContextDrawer();

        drawer.setPrintGraphicsLayer(this.isPrintGraphicsLayer());

        drawer.print(this.layers, g, cancel, scale, properties);

    }

    /**

     * <p>

     * Returns a new <code>MapContext</code> instance with the information of

     * the <code>vp</code> argument, and the layers of this map.</p>

     *

     * @param vp information for drawing the layers of this map in the available

     * rectangular area according a projection

     *

     * @return a new <code>MapContext</code> instance projected by

     * <code>vp</code>

     */

    public MapContext createNewFMap(ViewPort vp) {

        MapContext ret = new MapContext(vp);

        ret.layers = this.layers;

        DisposeUtils.bind((Disposable)ret.layers);

        DisposeUtils.bind((List)ret.layers);

        return ret;

    }

    /**

     * <p>

     * Creates a new independent <code>MapContext</code> instance, that has a

     * clone of the layers and the view port of this one.</p>

     * <p>

     * The new map will have the same data source drivers to avoid waste memory,

     * and work faster.</p>

     *

     * @return the new <code>MapContext</code> instance

     *

     * @throws XMLException if fails cloning the view port or a layer

     *

     * @see FLayer#cloneLayer()

     * @see ViewPort#cloneViewPort()

     */

    public MapContext cloneFMap() {

        ViewPort vp;

        try {

            vp = (ViewPort) getViewPort().clone();

        } catch (CloneNotSupportedException e) {

            throw new RuntimeException(e);

        }

        FLayers antLayers = getLayers();

        MapContext ret = new MapContext(vp);

        /*

         * Cloning order manager

         */

        LayerOrderManager lom = this.getOrderManager();

        try {

            lom = (LayerOrderManager) lom.clone();

            ret.setOrderManager(lom);

        } catch (CloneNotSupportedException e1) {

            LOGGER.error("While cloning order manager", e1);

        }

        for (int i = 0; i < antLayers.getLayersCount(); i++) {

            FLayer lyr = antLayers.getLayer(i);

            try {

                FLayer auxLayer = lyr.cloneLayer();

                ret.layers.addLayer(auxLayer);

                auxLayer.dispose();

            } catch (Exception e) {

                throw new RuntimeException(e);

            }

        }

        return ret;

    }

    /**

     * Like {@linkplain #cloneFMap()}, but now doesn't clone the layers, rather

     * copies them.

     *

     * @return the new map

     */

    public MapContext cloneToDraw() {

        ViewPort vp;

        try {

            vp = (ViewPort) getViewPort().clone();

            MapContext mapContext = new MapContext(getLayers(), vp);

            return mapContext;

        } catch (CloneNotSupportedException e) {

            throw new RuntimeException(e);

        }

    }

    /**

     * <p>

     * Adds a layer to the group of layers that are at a upper level in the

     * tree.</p>

     *

     * @param vectorial the layer to add

     */

    public void addToTrackLayer(FLayer vectorial) {

    }

    /**

     * <p>

     * Returns the scale of the view in the screen.</p>

     *

     * @return one of this values:

     * <ul>

     * <li>the scale of the adjusted extent scale of the view in the screen

     * <li><code>-1</code> if there is no image

     * <li><code>0</code> if there is no extent defined for the image

     * </ul>

     *

     * @see #setScaleView(long)

     * @see ViewPort#getAdjustedExtent()

     * @see IProjection#getScale(double, double, double, double)

     */

    public long getScaleView() {

        double dpi = this.getViewPort().getDPI();

        IProjection proj = viewPort.getProjection();

        if (viewPort.getImageSize() == null) {

            return -1;

        }

        if (viewPort.getAdjustedEnvelope() == null) {

            return 0;

        }

        double[] trans2Meter = getDistanceTrans2Meter();

        int mUnits = getViewPort().getMapUnits();

        if (proj == null) {

            double w = ((viewPort.getImageSize().width / dpi) * 0.0254);

            return (long) (viewPort.getAdjustedEnvelope().getLength(0)

                    / w * trans2Meter[mUnits]);

        }

        return Math.round(proj.getScale(

                viewPort.getAdjustedEnvelope().getMinimum(0) * trans2Meter[mUnits],

                viewPort.getAdjustedEnvelope().getMaximum(0) * trans2Meter[mUnits],

                viewPort.getImageSize().width,

                dpi));

    }

    /**

     * <p>

     * Sets the new extent of the view, calculated using the scale argument.</p>

     * <p>

     * Doesn't updates the scale if there isn't information about the dimension

     * of the image or the adjusted extent.</p>

     *

     * @param scale the new scale for the view

     *

     * @see ViewPort#setProjection(IProjection)

     * @see #getScaleView()

     */

    public void setScaleView(long scale) {

        double dpi = this.getViewPort().getDPI();

        if (viewPort.getImageSize() == null) {

            return;

        }

        IProjection proj = viewPort.getProjection();

        if (viewPort.getAdjustedExtent() == null) {

            return;

        }

        double[] trans2Meter = getDistanceTrans2Meter();

        Envelope env = viewPort.getAdjustedExtent();

        Rectangle2D r = new Rectangle2D.Double(env.getMinimum(0), env.getMinimum(1), env.getLength(0), env.getLength(1));

        Rectangle2D rec = proj.getExtent(r, scale, viewPort.getImageWidth(), viewPort.getImageHeight(), 100 * getDistanceTrans2Meter()[getViewPort().getMapUnits()], trans2Meter[getViewPort().getDistanceUnits()], dpi);

        try {

            getViewPort().setEnvelope(GEOM_MANAGER.createEnvelope(rec.getX(), rec.getY(), rec.getMaxX(), rec.getMaxY(), SUBTYPES.GEOM2D));

        } catch (CreateEnvelopeException e) {

            LOGGER.error("Error seting the bounding box");

        }

    }

    /**

     * <p>

     * Returns the screen resolution (Dots Per Inch) as it was defined by the

     * user's preference, or by default as it is defined in the default

     * Toolkit.</p>

     *

     * Be care, use ViewPort#getDPI to ensure are using the corrects DPI.

     *

     * @return double with the screen's dpi

     */

    public static double getScreenDPI() {

        return CompatLocator.getGraphicsUtils().getScreenDPI();

    }

    /**

     * @see

     * org.gvsig.fmap.mapcontext.rendering.strategies.Strategy#process(com.iver.cit.gvsig.fmap.FeatureSelectorVisitor)

     */

    public void process(Visitor visitor) {

    }

    /**

     * @see

     * org.gvsig.fmap.mapcontext.rendering.strategies.Strategy#processSelected(com.iver.cit.gvsig.fmap.FeatureVisitor)

     */

    public void processSelected(Visitor visitor) {

    }

    /**

     * @see

     * org.gvsig.fmap.mapcontext.rendering.strategies.Strategy#select(com.iver.cit.gvsig.fmap.FeatureSelectorVisitor,

     * VectorialSubSet)

     */

    public void select(Visitor visitor) {

    }

    /**

     * @see

     * org.gvsig.fmap.mapcontext.rendering.strategies.Strategy#selectFromSelection()

     */

    public void selectFromSelection() {

    }

    /**

     * @see

     * org.gvsig.fmap.mapcontext.rendering.strategies.Strategy#createIndex()

     */

    public void createIndex() {

    }

    /**

     * @see org.cresques.geo.Projected#getProjection()

     *

     * @see ViewPort#getProjection()

     * @see #setProjection(IProjection)

     * @see #reProject(ICoordTrans)

     */

    public IProjection getProjection() {

        ViewPort vp = this.getViewPort();

        if( vp == null ) {

            return null;

        }

        return vp.getProjection();

    }

    /**

     * <p>

     * Sets the new projection.</p>

     *

     * @param proj the new projection

     *

     * @see #getProjection()

     * @see ViewPort#setProjection(IProjection)

     * @see #reProject(ICoordTrans)

     */

    public void setProjection(IProjection proj) {

        if (getViewPort() != null) {

            getViewPort().setProjection(proj);

        }

    }

    /**

     * @see org.cresques.geo.Projected#reProject(org.cresques.cts.ICoordTrans)

     */

    public void reProject(ICoordTrans arg0) {

        // TODO implementar reprojecci?n (lo que sea eso)

    }

    public Envelope getSelectionBounds() throws BaseException {

        SelectedEnvelopeVisitor visitor = new SelectedEnvelopeVisitor();

        layers.accept(visitor);

        Envelope env_in_data_crs = visitor.getSelectioEnvelope();

        return env_in_data_crs;

    }

    /**

     * <p>

     * Draws this map if its {@link ViewPort ViewPort} has an extent

     * defined:<br>

     * <ol>

     * <li>Selects only the layers that have to be drawn:

     * {@linkplain #prepareDrawing(BufferedImage, Graphics2D, double)}.

     * <li>Sets quality: antialiasing by text and images, and quality rendering.

     * <li>Draws the layers.

     * <li>Fires a <code>LayerDrawEvent.GRAPHICLAYER_BEFORE_DRAW</code>.

     * <li>Draws the graphic layer.

     * <li>Fires a <code>LayerDrawEvent.GRAPHICLAYER_AFTER_DRAW</code>.

     * <li>Invokes the garbage collector and memory clean.

     * </ol>

     * </p>

     *

     * @param image buffer used sometimes instead <code>g</code> to accelerate

     * the draw. For example, if two points are as closed that can't be

     * distinguished, draws only one.

     * @param g for rendering 2-dimensional shapes, text and images on the

     * Java(tm) platform

     * @param cancel shared object that determines if this layer can continue

     * being drawn

     * @param scale the scale of the view. Must be between

     * {@linkplain FLayer#getMinScale()} and {@linkplain FLayer#getMaxScale()}.

     * @throws MapContextException if there is an error getting the instance of

     * MapContextDrawer

     * @throws ReadDriverException if fails reading with the driver.

     */

    public void draw(BufferedImage image, Graphics2D g, Cancellable cancel,

            double scale) throws ReadException, MapContextException {

        if (viewPort.getEnvelope() == null) {

            return;

        }

        CompatLocator.getGraphicsUtils().setRenderingHintsForDrawing(g);

        this.getMapContextDrawer().draw(this.layers, image, g, cancel, scale);

    }

    /**

     * <p>

     * Draws only the internal graphic layer using the information of the

     * {@link ViewPort ViewPort} of this map.</p>

     *

     * @param image image used to accelerate the screen draw

     * @param g for rendering 2-dimensional shapes, text and images on the

     * Java(tm) platform

     * @param cancel shared object that determines if this layer can continue

     * being drawn

     * @param scale value that represents the scale

     * @throws ReadDriverException if fails reading with the driver.

     * @deprecated use

     * {@link #draw(BufferedImage, Graphics2D, Cancellable, double)} instead

     * @see GraphicLayer#draw(BufferedImage, Graphics2D, ViewPort, Cancellable,

     * double)

     */

    public void drawGraphics(BufferedImage image, Graphics2D g,

            Cancellable cancel, double scale) throws ReadException {

                // From now on the graphics layer is handled by the MapContextDrawer,

        // so call the draw method instead.

        try {

            draw(image, g, cancel, scale);

        } catch (MapContextException e) {

            throw new RuntimeException(e);

        }

    }

    /**

     * <p>

     * Like

     * {@linkplain MapContext#draw(BufferedImage, Graphics2D, Cancellable, double)}

     * , but creating the task as cancellable.

     * </p>

     *

     * @param image buffer used sometimes instead <code>g</code> to accelerate

     * the draw. For example, if two points are as closed that can't be

     * distinguished, draws only one.

     * @param g for rendering 2-dimensional shapes, text and images on the

     * Java(tm) platform

     * @param scale the scale of the view. Must be between

     * {@linkplain FLayer#getMinScale()} and {@linkplain FLayer#getMaxScale()}.

     * @throws MapContextException if there is an error getting the instance of

     * MapContextDrawer

     *

     * @throws ReadDriverException if the driver fails reading.

     *

     * @see #draw(BufferedImage, Graphics2D, Cancellable, double)

     */

    public void draw(BufferedImage image, Graphics2D g, double scale)

            throws ReadException, MapContextException {

        draw(image, g, new Cancellable() {

            /**

             * @see org.gvsig.utils.swing.threads.Cancellable#isCanceled()

             */

            public boolean isCanceled() {

                return false;

            }

            public void setCanceled(boolean canceled) {

                // Do nothing

            }

        }, scale);

    }

    /**

     * <p>

     * Gets the {@link ViewPort ViewPort} associated to this map.</p>

     *

     * @return the view port

     *

     * @see #setViewPort(ViewPort)

     */

    public ViewPort getViewPort() {

        return viewPort;

    }

    /**

     * <p>

     * Sets a {@link ViewPort ViewPort} with the drawing information of this

     * map.</p>

     * <p>

     * If there was a previous view port, removes its

     * {@link EventBuffer EventBuffer} and adds the new one.</p>

     *

     * @param viewPort the viewPort

     *

     * @see #getViewPort()

     */

    public void setViewPort(ViewPort viewPort) {

        if (this.viewPort != null) {

            this.viewPort.removeViewPortListener(eventBuffer);

        }

        if (this.mapContextDrawer != null) {

            this.mapContextDrawer.setViewPort(viewPort);

        }

        this.viewPort = viewPort;

        if (viewPort != null) {

            viewPort.addViewPortListener(eventBuffer);

        }

    }

    /**

     * <p>

     * Sets the given extent to the {@link ViewPort ViewPort} and updates the

     * view with the new zoom.</p>

     *

     * @param extent the extent of the new zoom

     */

    public void zoomToEnvelope(Envelope env) {

        if (env == null || env.isEmpty()) {

            return;

        }

        if( env.isCollapsed(Geometry.SUBTYPES.GEOM2D) ) {

            // El envelop ha colapsado en X e Y.

            // Fijamos la escala por defecto para cuando colapsa y centramos

            // sobre el centro del envelop.

            this.setScaleView(this.getScaleToUseWhenEnvelopeCollapse());

            Envelope curenv = viewPort.getEnvelope();

            double halfWidth = curenv.getLength(Geometry.DIMENSIONS.X) / 2;

            double halfHeight = curenv.getLength(Geometry.DIMENSIONS.Y) / 2;

            double centerx = env.getCenter(Geometry.DIMENSIONS.X);

            double centery = env.getCenter(Geometry.DIMENSIONS.Y);

            Point lowerCorner = GeometryUtils.createPoint(halfWidth + centerx, halfHeight + centery);

            Point upperCorner = GeometryUtils.createPoint(halfWidth - centerx, halfHeight - centery);

            env.setLowerCorner(lowerCorner);

            env.setUpperCorner(upperCorner);            

        }

        this.viewPort.setEnvelope(env);

    }

    /**

     * <p>

     * Returns the union of all extents of all layers of this map.</p>

     *

     * @return full extent of layers of this map

     * @throws ReadDriverException if the driver fails reading.