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;

import java.awt.geom.AffineTransform;

import java.awt.geom.Dimension2D;

import java.io.FileNotFoundException;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.dal.DataStoreParameters;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.fmap.dal.coverage.process.TaskEventManager;

import org.gvsig.fmap.dal.coverage.process.overview.OverviewBuilder;

import org.gvsig.fmap.dal.coverage.process.warp.Warp;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.tools.service.ServiceException;

/**

 * This class is responsible of the management of the library's business logic.

 * It is the library's main entry point, and provides all the services to manage

 * {@link RasterService}s.

 * 

 * @see RasterService

 * @author gvSIG team

 * @version $Id$

 */

public interface RasterManager {

        public int TYPE_MULTIDATA   = 0;

        public int TYPE_MOSAICDATA  = 1;

        /**

         * Gets the factory for data structures

         * @return

         */

        public DataStructFactory getDataStructFactory();

        /**

         * Gets the Provider information object

         * @return

         */

        public ProviderServices getProviderServices();

        /**

         * Gets the CRS utilities

         * @return

         */

        public CRSUtils getCRSUtils();

        /**

         * Gets the file utilities

         * @return

         */

        public FileUtils getFileUtils();

        /**

         * Gets the raster utilities

         * @return

         */

        public RasterUtils getRasterUtils();

        /**

         * Gets the mathematical utilities

         * @return

         */

        public MathUtils getMathUtils();

    /**

     * Create an instance of a {@link RasterService}.

     * 

     * @return {@link RasterService}

     * @throws ServiceException

     *             if there is an error getting the service

     */

    public RasterService getRasterService() throws ServiceException;

    /**

     * Gets the object to convert color spaces

     * @return

     */

    public ColorConversion getColorConversion();

        /**

         * Lista de formatos soportados por RasterLegendIO

         *

         * @return

         */

        public String[] getLegendFormats();

        /**

         * Devuelve un RasterLegend para el formato especificado por parametro.

         *

         * @param formatName

         * @return

         * @throws RasterLegendIONotFound

         */

        public RasterLegend getRasterLegendIO(String formatName) throws RasterLegendIONotFound;

        /**

         * Abre un dataset pasando como par?metros la proyecci?n y un objeto identificador del dataset. Este

         * objeto puede ser una ruta a un fichero en disco. En este caso la extensi?n del fichero servir? para

         * buscar el driver que lo gestiona. Si proporcionamos un array de cadenas se tratar?n como la ruta a N ficheros

         * de disco. Tambi?n puede ser un buffer de datos en memoria o cualquier otro objeto

         * que pueda aceptar un driver.

         * @param param Par?metros al driver

         * @return RasterMultiDatset

         * @throws NotSupportedExtensionException

         * @throws RasterDriverException

         */

        public RasterDataStore open(DataStoreParameters param) throws NotSupportedExtensionException, RasterDriverException;

        public RasterDataStore open(CoverageStoreProvider prov, int type, DataStoreParameters params) throws NotSupportedExtensionException, RasterDriverException;

        /**

         * Builds a new empty RasterQuery object

         * @return

         */

        public RasterQuery createQuery();

        /**

         * Genera instancias del buffer de datos adecuado al tama?o del raster. Si no hay muchos datos

         * (menos de cacheMemorySize) crear? un buffer en memoria. Si hay m?s de esta cantidad

         * entonces crearemos un buffer cacheado (RasterCache). A partir de la cantidad se?alada

         * por multicacheMemorySize haremos un buffer cacheado donde cada p?gina no ocupa todo

         * el ancho del raster ya que este ser? muy grande. La gesti?n de una cache donde cada

         * pagina ha de partir una l?nea lleva una complejidad a?adida.

         *  

         * @param dataType Tipo de dato

         * @param width Ancho

         * @param height Alto

         * @param bandNr Banda

         * @param flag En caso de buffers de memoria este flag a true significa que se reserva la memoria

         * para el buffer de forma normal y si est? a false no se reserva por lo que la reserva deber? ser

         * posterior. 

         * @return Objeto RasterBuffer

         * @throws RasterDriverException 

         * @throws NotSupportedExtensionException 

         * @throws FileNotFoundException 

         */

        public Buffer createBuffer(int dataType, int width, int height, int bandNr, boolean malloc);

        /**

         * Genera una instancia del buffer de solo lectura. Este buffer consta de una cache y unos apuntadores

         * a las p?ginas en disco. Cuando se accede a los datos se carga en memoria la p?gina pedida.

         *  

         * @param dataType Tipo de dato

         * @param width Ancho

         * @param height Alto

         * @param bandNr Banda

         */

        public Buffer createReadOnlyBuffer(int dataType, int width, int height, int bandNr);

        /**

         * Genera una instancia del buffer de solo lectura. Este buffer consta de una cache y unos apuntadores

         * a las p?ginas en disco. Cuando se accede a los datos se carga en memoria la p?gina pedida.

         *  

         * @param dataType Tipo de dato

         * @param width Ancho

         * @param height Alto

         * @param bandNr Banda

         * @param flag En caso de buffers de memoria este flag a true significa que se reserva la memoria

         * para el buffer de forma normal y si est? a false no se reserva por lo que la reserva deber? ser

         * posterior. 

         */

        public Buffer createMemoryBuffer(int dataType, int width, int height, int bandNr, boolean malloc);

        /**

         * Factoria para obtener escritores de los distintos tipos de raster.

         * @param fName Nombre del fichero.

         * @return GeoRasterWriter, o null si hay problemas.

         */

        public RasterWriter createWriter(String fName) throws NotSupportedExtensionException, RasterDriverException;

        /**

         * Factoria para obtener escritores de los distintos tipos de raster.

         *

         * @param fName Nombre del fichero.

         * @return GeoRasterWriter, o null si hay problemas.

         */

        public RasterWriter createWriter(DataServerWriter dataWriter,

                                                                                                 String outFileName,

                                                                                                 int nBands,

                                                                                                 AffineTransform at,

                                                                                                 int outSizeX,

                                                                                                 int outSizeY,

                                                                                                 int dataType,

                                                                                                 Params params,

                                                                                                 IProjection proj) throws NotSupportedExtensionException, RasterDriverException;

        /**

         * Factoria para obtener escritores de los distintos tipos de raster.

         *

         * @param fName Nombre del fichero.

         * @return GeoRasterWriter, o null si hay problemas.

         */

        public RasterWriter createWriter(DataServerWriter dataWriter,

                                                                                                 String outFileName,

                                                                                                 int nBands,

                                                                                                 AffineTransform at,

                                                                                                 int outSizeX,

                                                                                                 int outSizeY,

                                                                                                 int dataType,

                                                                                                 Params params,

                                                                                                 IProjection proj,

                                                                                                 boolean geo) throws NotSupportedExtensionException, RasterDriverException;

        /**

         * Obtiene los par?metros del driver de escritura a partir del nombre de fichero de salida.

         * @return WriterParams

         */

        public Params createWriterParams(String fileName);

        /**

         * Gets an instance of the overview builder registered

         * @return OverviewBuilder

         */

        public OverviewBuilder createOverviewBuilder();

        /**

         * Gets a new instance of a ColorInterpretation object

         * @param A list of color interpretation strings

         * @return

         */

        public ColorInterpretation createColorInterpretation(String[] colorInterp);

        /**

         * Crea un grid a partir de un MultiRasterDataset. Usa el extent de la fuente de datos como

         * extent completo y el extent pasado como par?metro como extensi?n de ventana.

         *

         * Cuando se construye el reader se carga el buffer con la extensi?n definida en windowExtent

         * y las bandas especificadas en bands.

         *

         * @param IRasterDataSource datasets que proporcionan los datos

         * @param bands n?mero de bandas requeridas

         * @param windowExtent Extensi?n de la ventana. Si este par?metro es null se usar? el

         * mismo que el de la capa.

         */

        public Grid createGrid(RasterDataStore datasource, int[] bands, GridExtent windowExtent) throws RasterBufferInvalidException;

        /**

         * Crea un grid a partir de un BufferFactory. Se har? una petici?n del extent completo de la fuente.

         * bufferFactory tiene asociada una fuente de datos pero se ignorar? si tiene el buffer lleno. La instanciaci?n

         * de GridNotInterpolated har? que se haga la petici?n para cargar raster completo.

         * @param bufferFactory Fuente de datos

         * @param bands n?mero de bandas requeridas y orden de dibujado en el buffer

         */

        public Grid createGrid(RasterDataStore datasource, int[] bands) throws RasterBufferInvalidException;

        /**

         * Crea un grid a partir de un BufferFactory. Se har? una petici?n del extent completo de la fuente.

         * bufferFactory tiene asociada una fuente de datos pero se ignorar? si tiene el buffer lleno. La instanciaci?n

         * de GridNotInterpolated har? que se haga la petici?n para cargar raster completo. El buffer se cargar?

         * con todas las bandas disponibles.

         * @param datasource Fuente de datos

         */

        public Grid createGrid(RasterDataStore datasource) throws RasterBufferInvalidException;

        /**

         * Crea un grid vacio a partir de un extent y un tipo de datos. Se crea un buffer vacio en el

         * que puede escribirse a trav?s del writer. Los datos escritos pueden ser consultados con el

         * reader. No tiene una fuente de datos asociada ya que es un grid vacio basicamente para

         * escritura.

         * @param layerExtent Tama?o completo de la capa

         * @param windowExtent Ventana de datos.

         * @param dataType Tipo de datos del buffer

         * @param bands n?mero de bandas requeridas y orden de dibujado en el buffer

         */

        public Grid createGrid(GridExtent layerExtent,

                        GridExtent windowExtent,

                        int dataType,

                        int[] bands) throws RasterBufferInvalidException;

        /**

         * Crea un grid a partir de un BufferFactory. El buffer debe estar cargado de datos y el extent

         * de este viene definido en el par?metro windowExtent.

         * @param bufferFactory Fuente de datos

         * @param windowExtent        Extent de los datos cargados en bufferFactory

         * @param notInterp Si es true fuerza a que el reader sea sin interpolaci?n. Si es false decide si

         * el reader es interpolado o no a partir de los extents de capa y la ventana seleccionada.

         */

        public Grid createGrid(Buffer buf, RasterDataStore datasource, boolean notInterp);

        /**

         * Builds a Warp object

         * @return

         */

        public Warp createWarp();

    /**

     * Builds a new service to recover historical objects 

     * @return

     */

    public Historical createHistoricalService();

    /**

     * Builds a new ViewPortData object

     * @param proj

     * @param extent

     * @param size

     * @return

     */

    public ViewPortData createViewPortData(IProjection proj, Extent extent, Dimension2D size);

    /**

     * Builds a new ViewPortData object

     * @return

     */

    public ViewPortData createViewPortData();

        /**

         * Returns a Statistics object for a ROI

         * @param roi

         * @return

         */

        public Statistics createROIStatistics(AbstractROI roi);

        /**

         * Builds a new and empty filter list

         * @return

         */

        public RasterFilterList createEmptyFilterList();

        /**

         * Gets a register task. To get a task it will use the current thread ID

         * @return TaskEventManager

         */

        public TaskEventManager getRasterTask();

        /**

         * Registers the object as a task using the current thread ID. It returns

         * a TaskEventManager

         * @param process

         * @return

         */

        public TaskEventManager createRasterTask(Object process);

        /**

         * Builds a new data server to write data in a buffer 

         * @return

         */

        public DataServerWriter createDataServerWriter();

        /**

         * Builds a new parameter object. These parameters represents the fieds of a filter

         * panel.

         * @param id

         * @param value

         * @param type 

         * @param list

         * @return

         */

        public Params createParams(String id, Object value, int type, String[] list);

}