| gvSIG desktop 1

/* 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 com.iver.cit.gvsig.fmap.layers;

import java.awt.Graphics2D;

import java.awt.Image;

import java.awt.geom.Rectangle2D;

import java.awt.image.BufferedImage;

import java.util.List;

import java.util.Map;

import javax.print.attribute.PrintRequestAttributeSet;

import javax.swing.ImageIcon;

import org.cresques.cts.ICoordTrans;

import org.cresques.cts.IProjection;

import org.cresques.geo.Projected;

import com.iver.cit.gvsig.fmap.DriverException;

import com.iver.cit.gvsig.fmap.MapContext;

import com.iver.cit.gvsig.fmap.MapControl;

import com.iver.cit.gvsig.fmap.ViewPort;

import com.iver.cit.gvsig.fmap.drivers.DriverIOException;

import com.iver.cit.gvsig.fmap.edition.EditionException;

import com.iver.cit.gvsig.fmap.layers.layerOperations.ComposedLayer;

import com.iver.utiles.XMLEntity;

import com.iver.utiles.swing.threads.Cancellable;

/**

 * <p>Definition of the basic methods that all kind of <a href="http://www.gvsig.gva.es/">gvSIG</a> 's layers must implement.</p>

 * 

 * <p>This kind of layers store their data by theirself, are drawable, projectable (with a projection), can be a node of a tree of layers, and

 *  could be editable and have a cache with previous draws. They also can be visible or not, and active or not.</p>

 *

 * <p>A layer can also store information about errors produced working with it, and have a name (kind of layer) and

 *  a brief summary explaining what's for.</p>  

 *  

 * <p>Each particular implementation can add new properties, and limit or expand the functionality.</p> 

 *

 * @see Projected

 */

public interface FLayer extends Projected {

        /**

         * <p>Returns an entity that represents this layer.</p>

         * 

         * <p>This xml entity has elements that represent and store information about this layer.</p>

         *

         * @return an xml entity with information to the current layer

         * @throws com.iver.cit.gvsig.fmap.layers.XMLException if there is an error obtaining the object.

         */

        XMLEntity getXMLEntity() throws XMLException;

        /**

         * <p>Inserts information to this layer from an xml entity.</p>

         * 

         * <p>This xml entity has elements that represent and store information about this layer.</p>

         *

         * @param xml an <code>XMLEntity</code> with the information

         *

         * @throws com.iver.cit.gvsig.fmap.layers.XMLException if there is an error setting the object.

         */

        void setXMLEntity(XMLEntity xml) throws XMLException;

        /**

         * Inserts some properties to this layer.

         *

         * @param xml an <code>XMLEntity</code> with the information

         *

         * @throws com.iver.cit.gvsig.fmap.layers.XMLException if there is an error obtaining the object.

         */

        void setXMLEntity03(XMLEntity xml) throws XMLException;

        /**

         * Changes the status of the current layer to active or inactive.

         *

         * @param selected the boolean to be set

         */

        void setActive(boolean selected);

        /**

         * Returns <code>true</code> or <code>false</code> if this layer is in black or not in the <i>TOC</i>.

         *

         * @return <code>true</code> if this layer is active, otherwise <code>false</code>

         */

        boolean isActive();

        /**

         * Sets a name to this layer.

         *

         * @param name the string that is to be this layer's name

         */

        void setName(String name);

        /**

         * Returns the name of this layer.

         *

         * @return an string with this layer's name

         */

        String getName();

        /**

         * <p>Executes the initialization operations of this layer. This method is invoked

         * only one time during the life of this layer and just before visualize it.</p>

         *

         * @throws com.iver.cit.gvsig.fmap.drivers.DriverIOException if fails loading the layer.

         */

        void load() throws DriverIOException;

        /**

         * Changes the status of the current layer to visible or invisible.

         *

         * @param visibility the boolean to be set

         */

        void setVisible(boolean visibility);

        /**

         * <p>Returns <code>true</code> if this layer is visible and available.</p>

         * 

         * @see #isAvailable()

         * @see #setAvailable(boolean)

         * @see #visibleRequired()

         *

         * @return <code>true</code> if this layer is visible and available, otherwise <code>false</code>

         */

        boolean isVisible();

        /**

         * Returns the parent <code>FLayers</code> of this layer.

         *

         * @return the parent of this layer, or <code>null</code> if hasn't parent

         */

        public FLayers getParentLayer();

        /**

         * <p>Returns a reference to the model of this layer, or null if this layer has no model.</p>

         *

         * @return the model of this layer

         */

        public MapContext getMapContext();

        /**

         * Inserts the parent <code>FLayers</code> of the layer. 

         *

         * @param root a <code>FLayers</code> object

         */

        public void setParentLayer(FLayers root);

        /**

         * Returns the full extension of the layer.

         *

         * @return location and dimension of this layer

         *

         * @throws com.iver.cit.gvsig.fmap.DriverException if fails the driver used in this method.

         */

        Rectangle2D getFullExtent() throws DriverException;

        /**

         * Draws the layer using a buffer.

         *

         * @param image an image used to accelerate the screen draw

         * @param g a <code>Graphics2D</code> object that will allow the 2D draw

         * @param viewPort the view port where the layer will be drawn

         * @param cancel an object thread that implements the <code>Cancellable</code> interface, and will allow to cancel the draw

         * @param scale a double value that represents the scale

         *

         * @throws com.iver.cit.gvsig.fmap.DriverException if fails the driver used in this method.

         */

        void draw(BufferedImage image, Graphics2D g, ViewPort viewPort,

                Cancellable cancel, double scale) throws DriverException;

        /**

         * Prints this layer according to some properties requested.

         *

         * @param g a <code>Graphics2D</code> object that will allow the 2D draw

         * @param viewPort the view port where the layer will be drawn

         * @param cancel an object thread that implements the <code>Cancellable</code> interface, and will allow to cancel the draw

         * @param scale a double value that represents the scale

         * @param properties a set with the settings to be applied to a whole print job and to all the docs in the print job

         *

         * @throws com.iver.cit.gvsig.fmap.DriverException if fails the driver used in this method.

         */

        void print(Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, PrintRequestAttributeSet properties)

                throws DriverException;

        /**

         * Inserts the transformation coordinates.

         *

         * @param ct transformation coordinates

         */

        void setCoordTrans(ICoordTrans ct);

        /**

         * Returns the transformation coordinates.

         *

         * @return transformation coordinates

         */

        ICoordTrans getCoordTrans();

        /**

         * Adds a LayerListener to the listener list.

         *

         * @param o a layer listener

         *

         * @return <code>true</code> if hasn't been any problem during the insertion of the listener

         */

        public boolean addLayerListener(LayerListener o);

        /**

         * Returns all LayerListener listeners of this layer as an array.

         * 

         * @return an array with all layer listeners associated to this layer

         */

        public LayerListener[] getLayerListeners();

        /**

         * Removes the LayerListener parameter from this layer.

         *

         * @param o a layer listener

         *

         * @return <code>true</code> if hasn't been any problem doing this process

         */

        public boolean removeLayerListener(LayerListener o);

        /**

         * <p>Returns <code>true</code> or <code>false</code> if the value of scale as parameter

         *  is within the maximum and minimum scale of this layer.</p> 

         * 

         * @param scale the scale > 0

         * 

         * @return <code>true</code> if the scale is within the range of scales of this layer, otherwise <code>false</code>

         */

        public boolean isWithinScale(double scale);

        /**

         * Returns the minimum scale visible. Lower scales won't be drawn.

         * 

         * @return the minimum scale > 0, -1 if not defined

         */

        public double getMinScale();

        /**

         * Returns the maximum scale visible. Higher scales won't be drawn.

         * 

         * @return the maximum scale > 0, -1 if not defined

         */

        public double getMaxScale();

        /**

         * Sets the minimum scale visible. Lower scales won't be drawn.

         * 

         * @param minScale the scale > 0, -1 if not defined 

         */

        public void setMinScale(double minScale);

        /**

         * Sets the maximum scale visible. Higher scales won't be drawn.

         * 

         * @param maxScale the scale > 0, -1 if not defined

         */

        public void setMaxScale(double maxScale);

        /**

         * Changes the status of the current layer to editable or not.

         * 

         * @param b the boolean to be set

         * 

         * @throws com.iver.cit.gvsig.fmap.edition.EditionException if fails enabling for edition this kind of layer.

         */

        public void setEditing(boolean b) throws EditionException;

        /**

         * <p>Returns <code>true</code> if this layer is editable.</p> 

         * 

         * @return <code>true</code> if this layer is editable, otherwise <code>false</code>

         */        

        public boolean isEditing();

        /**

         * <p>Uses or not a <code>BufferedImage</code> object that represents this image.</p>

         * 

         * @return <code>true</code> if uses that kind of image, otherwise <code>false</code>

         */

        public boolean isCachingDrawnLayers();

        /**

         * <p>Set <code>true</code> if you want this layer to store an image of previous layers.

         *  Then, if you perform a <code>FLayers#invalidateLayer()</code>, the system will

         *  redraw only this layers you are requesting.</p>

         *  

         *  @param bCacheDrawnLayers the boolean to be set

         */ 

//         * <p>Another option could be store an image of each layer drawn, and call each one using something

//         *  like "invalidate()". On having rendered, it's possible to see if it's invalidated, and if itsn't,

//         *  paste the cached image.</p>

//         *  

//         * <p> ERROR!: You can't cache that image, because if the background has changed, the antialiasing

//         *  will affect the draw of that layer. However, it would be useful draw the cached image of each layer

//         *  that aren't invalidated, and from that appears one of them invalidated, the rest already have to draw.

//         *  The problem is that continues spending more memory</p>

//         *  

//         * @param bCacheDrawnLayers

//         */

        public void setCachingDrawnLayers(boolean bCacheDrawnLayers);

        /**

         * Returns the image icon that will be shown in the TOC next to this layer.

         * 

         * @return a reference to the image icon, or <code>null</code> if there isn't any

         */

        public ImageIcon getTocImageIcon();

        /**

         * <p>Returns <code>true</code> or <code>false</code> if this layer appears or not in the TOC.</p>

         * <p>If doesn't appears, remains in the view and in the project.</p>

         * 

         * @return 

         */

        boolean isInTOC();

        /**

         * <p>Returns <code>true</code> or <code>false</code> if this layer needs or doesn't need a repaint.

         * 

         * @return true if this layer need a repaint.

         */

        public boolean isDirty();

        /**

         * <p>Changes the status of this layer to dirty if needs a repaint.</p>

         * 

         * <p>By default, all layers will be set to dirty when the extent changes. But for events like changing

         * its legend, or editing a layer, we could perform some optimization using the private method <code>MapContext#prepareDrawing</code> from <code>MapContext</code>.</p>

         *

         * @param dirty <code>true</code> if this layer needs a repaint

         */

        public void setDirty(boolean dirty);

        /**

         * Returns the image with bands, of the drawn layers.

         * 

         * @return an image with bands

         */

        public BufferedImage getCacheImageDrawnLayers();

        /**

         * Sets the image with bands, for the drawn layers.

         * 

         * @param cacheImageDrawnLayers an image with bands

         */

        public void setCacheImageDrawnLayers(BufferedImage cacheImageDrawnLayers);

        /**

         * Returns the status of this layer.

         * 

         * @return the status stored in a <code>FLayerStatus</code> object

         */

        public FLayerStatus getFLayerStatus();

        /**

         * Sets the status of this layer.

         * 

         * @param status information of the status for this layer

         */

        public void setFLayerStatus(FLayerStatus status);

        /*

         * This stuff is to save error's info that causes

         * unavailable status.

         * */

        /**

         * Returns <code>true</code> if this layer is in OK status (it hasn't got errors).

         * 

         * @return <code>true</code> if is in OK status, otherwise <code>false</code>

         */

        public boolean isOk();

        /**

         * Returns the number of errors which causes this layer to be in unavailable status.

         *

         * @return number of errors >= 0

         */

        public int getNumErrors();

        /**

         * Returns the specified error.

         * 

         * @param i index of the error >= 0 && < <code>getNumErrors</code>

         * 

         * @return a singular error

         */

        public DriverException getError(int i);

        /**

         * Adds an error reason that describes this layer's wrong status.

         * 

         * @param error a <code>DriverException</code> with the information of the error

         */

        public void addError(DriverException error);

        /**

         * Returns a list with all layer errors.

         * 

         * @return an <code>ArrayList</code> with the errors

         */

        public List getErrors();

        /**

         * Changes the status of the current layer to available or not. By default it's <code>true</code>. 

         * 

         * @param the boolean to be set

         */

        public void setAvailable(boolean available);

        /** 

         * Returns the status of availability of the current layer. 

         * 

         * @return <code>true</code> if the source of data is on-line, otherwise <code>false</code>

         */        

        public boolean isAvailable();

        /**

         * <p>Tries recover a layer of a possible error.</p>

         * <p>If it has any problem during the load, marks the availability

         *  to false and throws an exception.</p>

         *

         * @throws DriverIOException if it's thrown a <code>DriverException</code> or an <code>IOException</code> during the load of this layer.

         */

        public void reload() throws DriverIOException;

        /**

         * Returns <code>true</code> if this layer has the visible status enabled.

         *

         * @return <code>true</code> if visible this layer has the visible status enabled, otherwise <code>false</code>

         */

        boolean visibleRequired();

        /**

         * Returns an string with the information of this layer.

         *

         * @return the string that is to be this component's information

         */

        public String getInfoString();

        /**

         * Returns the writing status of this layer.

         * 

         * @return <code>true</code> if there is a writing driver for this layer, otherwise <code>false</code>

         */

        public boolean isWritable();

        /**

         * <p>Returns a reference to an object (property) associated to this layer.</p>

         * 

         * <p>For example, you can attach a network definition to key "network" and check

         *  if a layer has a network loaded using <i>getAssociatedObject("network")</i> and

         *  that it's not null.</p>

         * 

         * @param key the key associated to the property

         * 

         * @return <code>null</code> if key is not found

         */

        public Object getProperty(Object key);

        /**

         * Insets an object as a property to this layer.

         *

         * @param key the key associated to the property 

         * @param obj the property

         */

        public void setProperty(Object key, Object obj);

        /**

         * <p>This method can be used to have a fast cloned layer.</p>

         * <p>The implementations should take care of not recreate this layer. Instead of this,

         *  is better to use the same source (driver) and <i>deepclone</i> the legend. Exception:

         *   the labels aren't <i>deepcloned</i> to avoid memory consumption.</p> 

         * <p><i>Note</i>: Labels are memory consuming to speed up layers like PostGIS and so on.</p>

         * 

         * @return a layer that is a clonation of this layer

         * 

         * @throws java.lang.Exception any exception produced during the cloning of this layer, will be thrown.

         */

        public FLayer cloneLayer() throws Exception;

        /**

         * Returns a hash map with all new properties associated to this layer.

         * 

         * @return hash table with the added properties

         */

        public Map getExtendedProperties();

        /**

         * <p>Returns a new instance of ComposedLayer.</p>

         * 

         * <p>This allows make a single draw for a group

         * of layers with the same source.</p>

         * 

         * <p>If this operation isn't applicable for this 

         * kind of layer, this method returns null.</p>

         * 

         * <p>By default this operation is not supported.</p>

         * 

         * @see com.iver.cit.gvsig.fmap.layers.layerOperations.ComposedLayer

         * 

         * @return a new composed layer or <code>null</code> if not supported

         */

        public ComposedLayer newComposedLayer();

        /**

         * Returns the image icon that will be shown in the TOC next to this layer, according its status. 

         * 

         * @return the image

         */

        Image getTocStatusImage();

        /**

         * Returns <code>true</code> if the projection of the layer can be changed.

         * 

         * @return <code>true</code> if can be changed its projection, otherwise <code>false</code>

         */

        public boolean isReprojectable();

        /**

         * <p>Changes the projection of this layer.</p>

         * <p>This method will be overload in each kind of layer, according its specific operations</p>

         * 

         * @param mapC object that will allow work with the image (draw, reproject, transform, store information, ...)

         * 

         * @return <true> if the layer is created with the method {@link FLayers#addLayer(FLayer)}, but returns <code>false</code>

         *  if the layer load control is passed to the reprojection method

         */

        public boolean reProject(MapControl mapC);

        /**

         * Inserts the projection to this layer.

         * 

         * @param proj information about the new projection

         */

        public void setProjection(IProjection proj);

}