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.fmap.dal.coverage.store;

import java.awt.geom.AffineTransform;

import java.awt.geom.Point2D;

import java.io.File;

import java.util.List;

import org.cresques.cts.ICoordTrans;

import org.cresques.cts.IProjection;

import org.gvsig.compat.net.ICancellable;

import org.gvsig.fmap.dal.DataStore;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.coverage.dataset.Buffer;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.fmap.dal.coverage.process.vector.Vectorization;

import org.gvsig.fmap.dal.coverage.store.parameter.RasterDataParameters;

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

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

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

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

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

import org.gvsig.fmap.dal.raster.spi.CoverageStoreProvider;

import org.gvsig.raster.roi.ROI;

/**

 * Interfaz que deben implementar los almacenes de datos raster.

 * 

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

 */

public interface RasterDataStore extends DataStore, TRasterStore, 

        PyramidRasterStore, RasterStoreProperties, Histogramable {

        public static final int              RED_BAND            = 0x01;

        public static final int              GREEN_BAND          = 0x02;

        public static final int              BLUE_BAND           = 0x04;

        public static final int              ALPHA_BAND          = 0x08;

        /**

        * Tipos de raster dependiendo de su fuente

        */

        public static final int              FILE                = 0;

        public static final int              POSTGIS             = 1;

        public static final int              REMOTE              = 2;

        public static final int              MOSAIC              = 3;

        /**

         * Actions to reload the information of a layer such as, read rmf or

         * tfw files 

         */

        public void reload();

        /**

         * Gets a default band list for this provider

         * @return

         */

        public BandList getDefaultBandList();

        /**

         * Gets a list of data parameters. If it doesn't have

         * internal providers this method will return only one DataParameter

         * @return

         */

        public RasterDataParameters[] getDataParametersByProvider();

        /**

         * Gets a list of sizes. If the provider doesn't have files it will return null.

         * If the provider has one file it will return an array of one element with the

         * size of this file. If the provider contains others with one file each one.

         * @return

         */

        public long[] getFileSizeByProvider();

        /**

         * Gets a list of file names or URI. Each element of this array is the name of a 

         * provider 

         * @return

         */

        public String[] getURIByProvider();

        /**

         * Gets the number of bands by provider. 

         * @return

         */

        public int[] getBandCountByProvider();

        /**

         * Gets a list of Metadata 

         * @return

         */

        public Metadata[] getMetadataByProvider();

        /**

         * Gets the number of overviews by provider

         * @param number of band

         * @return

         */

        public int[] getOverviewCountByProvider(int band) throws BandAccessException;

        /**

         * Gets the size of a overview in one band. The result is a list of strings (WidthXHeight)

         * 

         * @param band

         * @return

         */

        public String[] getOverviewSizeByProvider(int band, int overview) throws BandAccessException;

        /**

         * Gets a list of affine transforms

         * @return

         */

        public AffineTransform[] getAffineTransformByProvider();

        /**

         * Gets the height by provider

         * @return

         */

        public double[] getHeightByProvider();

        /**

         * Gets the width by provider

         * @return

         */

        public double[] getWidthByProvider();

        /**

         * Gets the URI of the source. If the provider has only one band

         * the result will be the URI. If it is multifile will have to choose

         * among several sources.

         * @param band

         * @return

         */

        public String getURIByBand(int band);

        /**

         * Returns the number of internal providers that it has

         * @return

         */

        public int getProviderCount();

        /**

         * 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);

        /**

         * Define el valor NoData asociado al raster.

         * @return

         */

        public void setNoDataValue(NoData value);

        /**

         * Obtiene el extent asignado

         * @return        Extent

         */

        public Extent getView();

        /**

         * Creates a new dataset which has the same source reference

         * @return RasterDataStore

         */

        public RasterDataStore newDataStore();

        /**

         * Creates a new dataset which has the same source reference but insure

         * that the provider will be not tiled. Most of processes has to be applied

         * over not tiled providers 

         * @return RasterDataStore

         */

        public RasterDataStore newNotTiledDataStore();

        /**

         * Obtiene el Tama?o de cada fichero de que consta el raster en bytes. 

         * @return long que representa el tama?o

         */

        public long getFileSize();

        /**

         * Convierte un punto desde coordenadas pixel a coordenadas del mundo.

         * @param pt Punto a transformar

         * @return punto transformado en coordenadas del mundo

         */

        public Point2D rasterToWorld(Point2D pt);

        /**

         * Convierte un punto desde del mundo a coordenadas pixel.

         * @param pt Punto a transformar

         * @return punto transformado en coordenadas pixel

         */

        public Point2D worldToRaster(Point2D pt);

        /**

         * Metodo que obtiene si un punto cae dentro de los l?mites de la extensi?n de la fuente de 

         * datos raster 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 the data source is tiled

         * @return

         */

        public boolean isTiled();

        /**

         * Returns true if the provider has several files and all of them has the same extension

         * @return

         */

        public boolean isMultiFile();

        /**

         * Returns true if the source of data is a mosaic of images

         * @return

         */

        public boolean isMosaic();

        /**

         * Obtiene la matriz de transformaci?n del propio raster. Esta matriz es la

         * encargada de convertir las coordenadas de la petici?n en coordenadas a las

         * que se pide a la libreria. En gdal, por ejemplo, se piden las coordenadas a

         * la libreria en coordenadas pixel por lo que esta matriz tendr? la

         * georreferenciaci?n asociada en el worldfile o cabecera. Otras librerias

         * como ermapper la petici?n a la libreria se hace en coordenadas geograficas

         * que son las mismas en las que pide el usuario de gvSIG por lo que esta

         * matriz en este caso se inicializa con la identidad.

         * @return

         */

        public AffineTransform getOwnAffineTransform();

        /**

         * Obtiene la transformaci?n afin aplicada en las peticiones con coordenadas

         * reales. Esta corresponde al producto matricial entre la transformaci?n de

         * la propia georreferenciaci?n del raster (ownTransformation) y la

         * transformaci?n que se le aplique de forma externa. Si esta ?ltima no existe

         * ser? la matriz identidad.

         * @return Matriz de la transformaci?n af?n.

         */

        public AffineTransform getAffineTransform();

        /**

         * Asigna una transformaci?n al raster para que se tenga en cuenta en la

         * asignaci?n del setView. Esta asignaci?n recalcula el extent, el

         * requestExtent y asigna el AffineTransform que se usar? para la

         * transformaci?n. Esta transformaci?n ser? considerada como si la imagen

         * tuviera asociado un rmf.

         * @param t Transformaci?n af?n a aplicar

         */

        public void setAffineTransform(AffineTransform transf);

        /**

         * Gets an object which vectorize a raster

         * @return

         * @throws RasterDriverException

         * @throws ProcessInterruptedException

         *         When the object Vectorization is built the raster data buffer is loaded. 

         *         This operation can be interrupted

         */

        public Vectorization createVectorizeObject() throws QueryException, ProcessInterruptedException;

        /**

         * Builds an render object using this RasterDataStore

         * @return Render

         */

        public Render getRender();

        /**

         * Assigns a render object

         * @param render

         */

        public void setRender(Render render);

        /**

         * Saves georeferencing information in the rmf file

         * @throws RmfSerializerException

         */

        public void saveGeoreferencingToRmf() throws RmfSerializerException;

        /**

         * Saves a color table

         * @param table

         * @throws RmfSerializerException

         */

        public void saveColorTableToRmf(ColorTable table) throws RmfSerializerException;

        /**

         * Saves the geo point list to a RMF file

         * @param pointList

         * @throws RmfSerializerException

         */

        public void saveGeoPointListToRmf(GeoPointList pointList) throws RmfSerializerException;

        /**

         * Saves a list of files in the RMF file

         * @param fileList

         * @throws RmfSerializerException

         */

        public void saveROIFileListToRmf(List<File> fileList) throws RmfSerializerException;

        /**

         * Gets the list of ROI files in the RMF

         * @return

         * @throws RmfSerializerException

         */

        public List<File> getROIFileListFromRmf();

        /**

         * Tipo de fichero soportado.

         * Devuelve true si el tipo de fichero (extension) est? soportado, si no

         * devuelve false.

         *

         * @param fName Fichero raster

         * @return  true si est? soportado, si no false.

                */

        public boolean isFileSupported(String fName);

        /**

         * Returns true if this DataStore is open and false if not

         * @return

         */

        public boolean isOpen();

        /**

         * Obtiene el flag que dice si el raster est? o no georreferenciado

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

         */

        public boolean isGeoreferenced();

        /**

         * Returns true if this data store is reproyectable or false if not

         * @return

         */

        public boolean isReproyectable();

        /**

         * Consulta de si un raster tiene rotaci?n o no.

         * @return true si tiene rotaci?n y false si no la tiene.

         */

        public boolean isRotated();

        /**

         * Obtiene el n?mero de overviews de una banda

         * @return N?mero de overviews del raster.

         */

        public int getOverviewCount(int band) throws BandAccessException, RasterDriverException;

        /**

         * Informa de si el dataset soporta overviews o no.

         * @return true si soporta overviews y false si no las soporta.

         */

        public boolean overviewsSupport();

        /**

         * Obtiene el ancho de una overview de una banda

         * @return

         */

        public int getOverviewWidth(int band, int overview) throws BandAccessException, RasterDriverException;

        /**

         * Obtiene el alto de una overview de una banda

         * @return

         */

        public int getOverviewHeight(int band, int overview) throws BandAccessException, RasterDriverException;

        /**

         * Returns the band list

         * @return

         */

        public BandList getBands();

        /**

         * Clones this object

         * @return RasterDataStore

         * @throws CloneException 

         */

        public RasterDataStore cloneDataStore() throws CloneException;

        /**

         * Gets a provider

         * @return

         */

        public CoverageStoreProvider getProvider();

        /**

         * Sets a provider

         * @return

         */

        public void setProvider(CoverageStoreProvider prov);

        /**

         * Deletes the cache of this layer composed by the files in the provider list

         */

        public void deleteLayerFromCache();

        /**

         * Sets the parameters

         * @param p

         */

        public void setParameters(DataStoreParameters p);

        /**

         * Returns the source type (FILE, POSTGIS, REMOTE,...)

         * @return

         */

        public int getSourceType();

        /**

         * This method will return the DataParameters if it has a simple provider behind. If it has

         * a TileProvider this method will return the DataParameters used by the TileProvider.  

         * @return

         */

        public RasterDataParameters getInternalParameters();

        /**

         * Closes this data store

         * @throws CloseException

         */

        public void close() throws CloseException;

        //******************************************

        //***********Query methods******************

        /**

         * Returns the last buffer loaded if the flag storeLastBuffer in the query is true

         * @return

         */

        public Buffer getLastBuffer();

        /**

         * Gets a pixel 

         * @param x

         * @param y

         * @param band

         * @return

         * @throws InvalidSetViewException

         * @throws FileNotOpenException

         * @throws RasterDriverException

         */

        public Object getData(int x, int y, int band)throws InvalidSetViewException, FileNotOpenException, RasterDriverException;

        /**

         * Makes a request to load a buffer of data. This call returns an array of results. The first

         * element in the array is the buffer and the other elements are the transparency buffer, 

         * the legend and so on. This funtion is mainly used by the getTile call. This array contains

         * all visualization properties. 

         * @param query 

         * @return Object[]

         */

        public Object[] queryArray(RasterQuery query) throws ProcessInterruptedException, QueryException;

        /**

         * Makes a request to load a buffer of data. This call returns only a buffer. This call is used

         * by most functions because the properties are read from the datastore.

         * @param query 

         * @return Buffer

         */

        public Buffer query(RasterQuery query) throws ProcessInterruptedException, QueryException;

        /**

         * Sets a tile server to create a second level of cache. This second level will be

         * created if the cache structure is different to the current.

         * @param tileServer

         */

        public void setTileServer(Class<?> tileServer) throws InitializeException;

        /**

         * Some sevices has neither limits nor pixel size. For instance, WebMapService 

         * is a service of this type if the size is not fixed. Other services, like

         * WMTS are enclosed too but in this case it will have resolution by level.

         * This method returns true if the data source is enclosed.

         * @return

         */

        public boolean isRasterEnclosed();

        /**

         * This function returns true if the image to be loaded needs a enhanced filter or

         * doesn't. It depends on the format, number of bands, type of data and so on.

         * @return The default value is false but each driver can change this value.

         */

        public boolean needEnhanced();

        /**

         * Sets the transformation

         * @param t

         */

        public void setCoordTrans(ICoordTrans t);

        /**

         * Gets the information in a real point

         * @param x

         *        X Pixel position

         * @param y

         *        Y pixel position

         * @return

         */

        public String getInfoByPoint(double x, double y, ICancellable cancellable) throws InfoByPointException;

        /**

         * Gets the information in a pixel point. Some services need additional 

         * information as the window where the request is done 

         * @param x

         *        X Pixel position

         * @param y

         *        Y pixel position

         * @param bbox

         *        Bounding box of the window

         * @param w

         *        Width in pixels of the window

         * @param h

         *        Height in pixels of the window

         * @param cancellable

         * @return

         * @throws RemoteServiceException

         */

        public String getInfoByPoint(double x, double y, Extent extent, int w, int h, ICancellable cancellable) throws InfoByPointException;

        /**

         * Gets the list of geo points associated to this provider

         * @return

         */

        public GeoPointList getGeoPointList();

        /**

         * Sets the list of geo points associated to this provider

         */

        public void setGeoPointList(GeoPointList geoPointList);

        /**

         * Gets the list of regions of interest

         * @param defaultProjection

         * @return

         * @throws ROIException

         */

        public List<ROI> getRois(IProjection defaultProjection) throws ROIException;

        /**

         * Gets the list of regions of interest

         * @param defaultProjection

         * @return

         * @throws ROIException

         */

        public List<ROI> getRois(String epsg) throws ROIException;

        /**

         * Sets the list of regions of interest

         * @param rois

         */

        public void setRois(List<ROI> rois);

}