Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

*

* Copyright (C) 2007-2008 Infrastructures and Transports Department

* of the Valencian Government (CIT)

* 

* 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., 51 Franklin Street, Fifth Floor, Boston, 

* MA  02110-1301, USA.

* 

*/

package org.gvsig.raster.fmap.layers;

import java.awt.Graphics2D;

import java.awt.geom.AffineTransform;

import java.awt.geom.Point2D;

import java.awt.image.BufferedImage;

import java.util.ArrayList;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.dal.coverage.datastruct.Extent;

import org.gvsig.fmap.dal.coverage.datastruct.NoData;

import org.gvsig.fmap.dal.coverage.exception.GridException;

import org.gvsig.fmap.dal.coverage.exception.InvalidSourceException;

import org.gvsig.fmap.dal.coverage.exception.RasterDriverException;

import org.gvsig.fmap.dal.coverage.exception.RmfSerializerException;

import org.gvsig.fmap.dal.coverage.grid.Grid;

import org.gvsig.fmap.dal.coverage.grid.ROI;

import org.gvsig.fmap.dal.coverage.grid.render.Render;

import org.gvsig.fmap.dal.coverage.store.RasterDataStore;

import org.gvsig.fmap.dal.coverage.store.props.ColorTable;

import org.gvsig.fmap.dal.coverage.util.Historical;

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

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

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.fmap.mapcontext.ViewPort;

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

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

import org.gvsig.tools.task.Cancellable;

/**

 * All kind of raster layers should implement this interface.

 * 

 * @author Nacho Brodin (nachobrodin@gmail.com)

 */

@SuppressWarnings("deprecation")

public interface FLyrRaster extends FLayer {

        /**

         * Gets the uniform resource identifier

         * @return

         */

        public String getURI();

        /**

         * Returns true if a color table exists

         * @return

         */

        public boolean existColorTable();

        /**

         * Define la ultima leyenda valida de la capa o se pone a null para que la

         * capa busque una leyenda valida.

         * @param ct

         */

        public void setLastLegend(ColorTable ct);

        /**

         * Crea el objeto renderizador de raster

         * @return Rendering

         */

        public Render getRender();

        /**

         * Gets the MapContext object

         * @return

         */

        public MapContext getMapContext();

        /**

         * Gets the full extent

         * @return

         */

        public Extent getFullRasterExtent();

        /**

         * Gets the DataStore

         * @return

         */

        public RasterDataStore getDataStore();

        /**

         * Metodo para consultar si una capa puede ser un RGB. Suponemos que es un RGB

         * si el tipo de datos es de tipo byte y su interpretacion de color tiene

         * asignada los tres colores.

         * @return boolean

         */

        public boolean isRGB();

        /**

         * Returns true if the drawn is going to be tiled

         * @return

         */

        public boolean isTiled();

        /**

         * Gets the regions of interest

         * @return 

         */

        public ArrayList<ROI> getRois();

        /**

         * Sets the regions of interest

         *

         */

        public void setRois(ArrayList<ROI> rois);

        /**

         * Obtiene la proyecci?n del fichero.

         * @return IProjection

         */

        public IProjection readProjection() throws RasterDriverException;

        /**

         * Gets the tile size

         * @return

         */

        public int[] getTileSize();

        /**

         * Obtiene el grid de la capa completa. Esta llamada devuelve un buffer de solo lectura

         * @param interpolated true si se solicita un grid interpolado y false si se solicita sin interpolar.

         * @return Grid.

         * @throws InterruptedException

         */

        public Grid getReadOnlyFullGrid(boolean interpolated) throws GridException, InterruptedException;

        /**

         * Obtiene el valor NoData asociado al raster.

         * @return double

         */

        public NoData getNoDataValue();

        /**

         * Gets the height in pixels of this raster layer

         */

        public double getPxHeight();

        /**

         * Gets the width in pixels of this raster layer

         */

        public double getPxWidth();

        /**

         * Returs a string with the extension of the first file

         */

        public String getFileFormat();

        /**

         * Obtiene el flag que dice si la imagen est? o no georreferenciada

         * @return true si est? georreferenciada y false si no lo est?.

         */

        public boolean isGeoreferenced();

        /**

         * Returns the number of bands of each dataset

         * @return

         */

        public int[] getBandCountFromDataset();

        /**

         * Gets the projection in well known text format

         * @return

         * @throws RasterDriverException

         */

        public String getWktProjection() throws RasterDriverException;

        /**

         * Gets the color interpretation

         * @param band

         * @param dataset

         * @return

         */

        public String getColorInterpretation(int band, int dataset);

        /**

         * When a process is using information of this layer this variable will contain

         * the thread ID.

         * @param readingData

         */

        public void setReadingData(String readingData);

        /**

         * Sets the nodata value for this layer

         * @param noDataValue the noDataValue to set

         */

        public void setNoDataValue(NoData noDataValue);

        /**

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

         *

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

         * @see #getMinScale()

         */

        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

         * @see #getMaxScale()

         */

        public void setMaxScale(double maxScale);

        /**

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

         *

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

         * @see #setMaxScale(double)

         */

        public double getMaxScale();

        /**

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

         *

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

         * @see #setMinScale(double)

         */

        public double getMinScale();

        /**

         * @return Returns the removeRasterFlag.

         */

        public boolean isRemoveRasterFlag();

        /**

         * Asigna el valor del flag que dice si destruimos la memoria del raster

         * al eliminarlo del TOC o  no.

         * @param removeRasterFlag The removeRasterFlag to set.

         */

        public void setRemoveRasterFlag(boolean removeRasterFlag);

        /**

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

         *

         * @param o LayerListener a borrar.

         *

         * @return True si ha sido correcto el borrado del Listener.

         */

        public boolean removeLayerListener(LayerListener o);

        /**

         * @throws ReadException

         * @throws ReadDriverException

         * @see com.iver.cit.gvsig.fmap.layers.LayerOperations#draw(java.awt.image.BufferedImage,

         *                 java.awt.Graphics2D, com.iver.cit.gvsig.fmap.ViewPort,

         *                 com.iver.utiles.swing.threads.Cancellable)

         */

        public void draw(BufferedImage image, Graphics2D g, ViewPort vp, Cancellable cancel, double scale) throws ReadException;

        /**

         * Clones this layer

         * @return

         * @throws Exception

         */

        public FLayer cloneLayer() throws Exception;

        /**

         * Gets a layer which the source is a file

         * @return

         * @throws RasterDriverException 

         */

        public FLayer getFileLayer() throws RasterDriverException;

        /**

         * Gets the position of the alpha band  

         * @return

         */

        public int getAlphaBandNumber();

        public String getName();

        /**

         * Gets the projection

         * @return

         */

        public IProjection getProjection();

        /**

         * Devuelve si es reproyectable o no la capa

         * @return

         */

        public boolean isReproyectable();

        /**

         * Recupera del raster la matriz de transformaci?n que lo situa en cualquier parte de la vista

         * @return AffineTransform

         */

        public AffineTransform getAffineTransform();

        /**

         * Obtiene la lista de transformaciones que se han ido aplicando al raster.

         * @return Historical. Lista de AffineTransform

         */

        public Historical getAffineTransformHistorical();

        /**

         * Asigna al raster la matriz de transformaci?n para situarlo en cualquier parte de la vista

         * @param transf

         */

        public void setAffineTransform(AffineTransform transf);

        /**

         * Asigna al raster la matriz de transformaci?n para situarlo en cualquier parte de la vista.

         * Esta versi?n no guarda en el historico.

         * @param transf

         */

        public void setAffineTransformWithoutHistorical(AffineTransform transf);

        /**

         * Salva la georreferenciaci?n a fichero rmf.

         * @param fName

         * @throws RmfSerializerException

         */

        public void saveGeoToRmf() throws RmfSerializerException;

        /**

         * Metodo que obtiene si un punto cae dentro de los l?mites de la capa

         * o fuera de ellos.

         * @param p Punto a calcular

         * @return true si est? dentro de los l?mites y false si est? fuera

         */

        public boolean isInside(Point2D p);

        /**

         * Returns true if this layer is remote

         * @return

         */

        public boolean isRemote();

        /**

         * Gets the attribute list

         * <UL>

         * <LI>Filename</LI>

         * <LI>Filesize</LI>

         * <LI>Width</LI>

         * <LI>Height</LI>

         * <LI>Bands</LI>

         * </UL>

         * @return ArrayList<Object>

         */

        public ArrayList<Object> getAttributes();

        /**

         * Returns the full bounding box of this layer

         * @return

         */

        public Envelope getFullEnvelope();

        /**

         * Ajusta las coordenadas especificadas en el par?metro al ?rea m?xima

         * del raster en p?xeles.

         * @param req Punto a ajustar dentro del extener del raster

         */

        public Point2D adjustWorldRequest(Point2D req);

        /**

         * Returns the maximun X coordinate of the bounding

         * @return

         */

        public double getMaxX();

        /**

         * Returns the maximun Y coordinate of the bounding

         * @return

         */

        public double getMaxY();

        /**

         * Returns the minimun X coordinate of the bounding

         * @return

         */

        public double getMinX();

        /**

         * Returns the minimun Y coordinate of the bounding

         * @return

         */

        public double getMinY();

        /**

         * Adds a new file. The behavior of this function depends on 

         * the kind of provider and its implementation.

         * @param file

         * @throws InvalidSourceException 

         */

        public void addFile(String file) throws InvalidSourceException;

        /**

         * Removes a file. The behavior of this function depends on 

         * the kind of provider and its implementation.

         * @param file

         */

        public void removeFile(String file);

        /**

         * When this flag is true then renderice nodata value as transparent

         * @param t

         */

        public void setNoDataTransparent(boolean t);

}