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

import org.gvsig.exceptions.BaseException;

import com.hardcode.gdbms.driver.exceptions.ReadDriverException;

import com.iver.cit.gvsig.exceptions.expansionfile.ExpansionFileReadException;

import com.iver.cit.gvsig.exceptions.layers.LoadLayerException;

import com.iver.cit.gvsig.exceptions.layers.ReloadLayerException;

import com.iver.cit.gvsig.exceptions.layers.StartEditionLayerException;

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

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

import com.iver.utiles.XMLEntity;

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

/**

 * Interfaz que tienen que implementar todas las capas.

 */

public interface FLayer extends Projected {

        /**

         * Obtiene una representaci?n de la colecci?n de capas de forma recursiva

         *

         * @return XMLEntity.

         * @throws XMLException

         */

        XMLEntity getXMLEntity() throws XMLException;

        /**

         * Inserta las propiedades del XMLEntity al objeto actual.

         *

         * @param xml XMLEntity

         *

         * @throws XMLException

         */

        void setXMLEntity(XMLEntity xml) throws XMLException;

        /**

         * Inserta las propiedades del XMLEntity al objeto actual.

         *

         * @param xml XMLEntity

         *

         * @throws XMLException

         */

        void setXMLEntity03(XMLEntity xml) throws XMLException;

        /**

         * Pone la capa actual a activa o inactiva seg?n el boolean que se pasa

         * como par?metro.

         *

         * @param selected activa.

         */

        void setActive(boolean selected);

        /**

         * Devuelve true si la capa esta activa.

         *

         * @return activa.

         */

        boolean isActive();

        /**

         * Inserta un nombre a la capa.

         *

         * @param name nombre.

         */

        void setName(String name);

        /**

         * Devuelve el nombre de la capa.

         *

         * @return nombre de la capa.

         */

        String getName();

        /**

         * Realiza las operaciones de inicializaci?n de la capa. El m?todo es

         * invocado una ?nica vez durante la vida de la capa y justo antes de

         * visualizar la capa

         * @throws LoadLayerException TODO

         */

        void load() throws LoadLayerException;

        /**

         * Pone la capa en modo visible o no visible.

         *

         * @param visibility visibilidad.

         */

        void setVisible(boolean visibility);

        /**

         * Devuelve true si la capa es visible.

         * Es dependiente isAvialable @link isAvialable

         *

         * @return visibilidad.

         *

         * @see isAvialable()

         * @see setAvialable()

         * @see visibleRequired()

         */

        boolean isVisible();

        /**

         * Devuelve el FLayers padre de la capa.

         *

         * @return FLayers padre de la capa.

         */

        public FLayers getParentLayer();

        /**

         * Devuelve el FMap al que est? a?adida la capa o null si la capa no ha

         * sido a?adida a ning?n FMap

         *

         * @return FMap

         */

        public MapContext getMapContext();

        /**

         * Inserta el FLayers padre de la capa.

         *

         * @param root capa padre.

         */

        public void setParentLayer(FLayers root);

        /**

         * Obtiene la extensi?n completa de la capa

         *

         * @return FullExtent.

         * @throws ReadDriverException

         * @throws ExpansionFileReadException

         */

        Rectangle2D getFullExtent() throws ReadDriverException, ExpansionFileReadException;

        /**

         * Dibuja la capa

         *

         * @param image Imagen utilizada para acelerar el dibujado en pantalla.

         * @param g Graphics2D sobre el que dibujar.

         * @param viewPort Propiedades de la vista.

         * @param cancel PAra poder cancelar el dibujado.

         * @throws ReadDriverException TODO

         */

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

                Cancellable cancel,double scale) throws ReadDriverException;

        /**

         * Dibuja la capa

         *

         * @param g Graphics2D de la impresora sobre el que dibujar.

         * @param viewPort Propiedades de la vista.

         * @param cancel

         * @throws ReadDriverException TODO

         */

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

                throws ReadDriverException;

        /**

         * Inserta las coordenadas de transformaci?n.

         *

         * @param ct Coordenadas de transformaci?n.

         */

        void setCoordTrans(ICoordTrans ct);

        /**

         * Devuelve las coordenadas de transformaci?n.

         *

         * @return Coordenadas de transformaci?n.

         */

        ICoordTrans getCoordTrans();

        /**

         * A?ade un listener LayerListener a la lista de listeners.

         *

         * @param o Listener.

         *

         * @return True si es correcta la inserci?n del listener.

         */

        public boolean addLayerListener(LayerListener o);

        public LayerListener[] getLayerListeners();

        /**

         * Borra de la lista el LayerListener que se pasa como par?metro.

         *

         * @param o Listener.

         *

         * @return True si es correcto el borrado del listener.

         */

        public boolean removeLayerListener(LayerListener o);

        public boolean isWithinScale(double scale);

        /**

         * La capa no se visualiza si est? por debajo de esa escala

         * @return la escala minima de visualizaci?n

         */

        public double getMinScale();

        /**

         * La capa no se visualiza si est? por encima de esa escala

         * @return la escala m?xima de visualizaci?n

         */

        public double getMaxScale();

        public void setMinScale(double minScale);

        public void setMaxScale(double maxScale);

        public void setEditing(boolean b) throws StartEditionLayerException;

        public boolean isEditing();

        public boolean isCachingDrawnLayers();

        /**

         * Set true if you want this layer to store an image of previous layers

         * Then, if you perform and "FLayers.invalidateLayer(lyr)", the system will

         * redraw only the layers you are requesting.

         * Otra opci?n ser?a guardar una imagen de cada capa dibujada, y poner una

         * llamada en cada una de ellas, algo como "invalidate()". Al renderizar,

         * se puede ver si est? invalidada, y si no lo est?, pegar la imagen cacheada.

         * ERROR!: Luis tiene raz?n en esto: No puedes cachear esa imagen porque

         * si el fondo ha cambiado, el antialiasing afectar? al dibujado de esa capa.

         * Sin embargo, s? ser?a ?til si lo que se hace es dibujar la imagen cacheada

         * de cada una de las capas que no est?n invalidadas, y a partir de que aparezca

         * una de ellas invalidada, el resto ya se tienen que dibujar.

         * La pega de que consumes m?s memoria sigue estando presente.

         * @param bCacheDrawnLayers

         */

        public void setCachingDrawnLayers(boolean bCacheDrawnLayers);

        /**

         * Icono a mostrar en el TOC junto a la capa

         * @return el icono

         */

        public ImageIcon getTocImageIcon();

        /**

         * If the layer appears in the TOC then <b>true</b> is returned,

         * if <b>false</b> the layer will not be displayed at the TOC

         * although it remains in the view and in the project

         */

        boolean isInTOC();

        /**

         * @return true if this layer need a repaint.

         */

        public boolean isDirty();

        /**

         * true if this layer need a repaint. 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 can perform some optimization

         * in the method prepareDrawing from FMap.

         * @param dirty

         */

        public void setDirty(boolean dirty);

        public BufferedImage getCacheImageDrawnLayers();

        public void setCacheImageDrawnLayers(BufferedImage cacheImageDrawnLayers);

        /**

         * Returns the status of the layer

         */

        public FLayerStatus getFLayerStatus();

        /**

         * Sets the status of the layer

         * @param status

         */

        public void setFLayerStatus(FLayerStatus status);

        /*

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

         * unavailable status.

         * */

        /**

         * Return if the layer is in OK status

         * (it hasnt got errors)

         */

        public boolean isOk();

        /**

         * returns the number of errors that causes layer

         * unavailable status

         * @return

         */

        public int getNumErrors();

        /**

         * return the specified error

         * @param i

         * @return

         */

        public BaseException getError(int i);

        /**

         * add an error cause to describe the layer's wrong status

         * @param exception TODO

         */

        public void addError(BaseException exception);

        /**

         * Returns a list with all layer errors

         * @return

         */

        public List getErrors();

        /**

         * @return set layer aviable or not.

         */

        public void setAvailable(boolean available);

        /**

         * @return true if this layer is aviable.

         *

         * Default value is true.

         */

        public boolean isAvailable();

        /**

         * Intenta recuperar una capa ante un posible error.

         * Si tiene algun problema en la carga, marca

         * el avialable a false y lanza una excepcion.

         * @throws ReloadLayerException TODO

         */

        public void reload() throws ReloadLayerException;

        /**

         * Devuelve true si la capa esta establecida como visible.

         *

         * @return visibilidad.

         */

        boolean visibleRequired();

        /**

         * Devuelve una cadena con informacion sobre la capa.

         *

         * @return visibilidad.

         */

        public String getInfoString();

        /**

         * @return true if this layer can be put in edition mode and save the

         * edits in itself.

         */

        public boolean isWritable();

        /**

         * This method can be used to have a fast cloned layer. The implementations should take care of

         * NOT recreate the layer. Instead of this, is better to use the same source (driver) and deepclone

         * the legend. Exception=> the labels aren't deepcloned to avoid memory consumption.

         * Note: Labels are memory consuming to speed up layers like PostGIS and so on.

         * @return clonedLayer

         * @throws Exception

         */

        public FLayer cloneLayer() throws Exception;

        /**

         * Useful to associate any object to a layer. For example, you

         * can attach a network definition to key "network" and

         * check if a layer has a network loaded if getAssociatedObject("network")

         * is not null

         *

         * @param key

         * @return null if key is not found

         */

        public Object getProperty(Object key);

        /**

         * @param key

         * @param obj

         */

        public void setProperty(Object key, Object obj);

        public Map getExtendedProperties();

}