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.io.FileNotFoundException;

import java.util.Set;

import org.cresques.cts.IProjection;

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

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

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

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

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

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

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

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

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

import org.gvsig.fmap.dal.coverage.filter.FilterLoader;

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

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

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

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

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.parameter.NewRasterStoreParameters;

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.feature.FeatureStore;

import org.gvsig.raster.roi.AbstractROI;

import org.gvsig.raster.roi.ROIReader;

import org.gvsig.raster.roi.ROIWriter;

import org.gvsig.raster.roi.VectorialROI;

/**

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

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

         *        SERVICES

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

        /**

         * Gets the factory to build buffers which store pixel data

         * @return {@link BufferFactory}

         */

        public BufferFactory getBufferFactory();

        /**

         * Gets the factory for data structures

         * @return

         */

        public DataStructFactory getDataStructFactory();

        /**

         * Gets the data source services

         * @return

         */

        public ProviderServices getProviderServices();

        /**

         * Gets projection utilities 

         * @return

         */

        public CRSUtils getCRSUtils();

        /**

         * Returns true if exists any implementation registered for

         * this service

         * @return

         */

        public boolean isCRSUtilSupported();

        /**

         * Gets utilities for files management

         * @return

         */

        public FileUtils getFileUtils();

        /**

         * Gets utilities for raster management

         * @return

         */

        public RasterUtils getRasterUtils();

        /**

         * Gets mathematical utilities

         * @return

         */

        public MathUtils getMathUtils();

    /**

     * Gets the object to convert color spaces

     * @return

     */

    public ColorConversion getColorConversion();

        /**

         * Builds a new empty RasterQuery object

         * @return {@link RasterQuery}

         */

        public RasterQuery createQuery();

        /**

         * Gets an instance of the overview builder registered

         * @return OverviewBuilder

         */

        public OverviewBuilder getOverviewBuilder(String id);

        /**

         * REturns true if the overview builder is supported

         * @return

         */

        public boolean isOverviewBuilderSupported();

        /**

         * Gets the list of keys in the overview builder

         * @return

         */

        public Set<String> getOverviewBuilderKeyList();

    /**

     * Builds a new service to recover historical objects 

     * @return

     */

    public Historical createHistoricalService();

        /**

         * Returns a Statistics object for a ROI

         * @param roi

         * @return

         */

        public Statistics createROIStatistics(AbstractROI roi);

        /**

         * Creates a service to render a buffer on a java Image object

         * @return

         */

        public ImageDrawer createImageDrawerService();

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

         *        LEGENDS

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

        /**

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

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

         *        TASK

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

        /**

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

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

         *        FILTER

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

        /**

         * Builds a new and empty filter list

         * @return

         */

        public RasterFilterList createEmptyFilterList(int type);

        /**

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

        /**

         * Builds loader of filters using a default list of filters. This loader avoids the

         * use of a Grid

         * @param dataType

         * @return

         */

        public FilterLoader createFilterLoader(int dataType);

        /**

         * Builds loader of filters using a specific list of filters. ThOis loader avoids the

         * use of a Grid

         * @param dataType

         * @return

         */

        public FilterLoader createFilterLoader(RasterFilterList filterList);

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

         *      ROI

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

        /**

         * Creates a reader for a ROI file

         * @param filename

         *        file name where the regions

         * @param store

         *        data store associated to these regions

         * @param projection

         *        Regions projection

         * @param bbox

         *        

         * @return

         * @throws FileNotExistsException 

         * @throws ROIException 

         */

        public ROIReader createROIReader(

                        String filename, 

                        RasterDataStore store, 

                        IProjection projection) throws ROIException, FileNotExistsException;

        /**

         * Creates a reader from a <code>FeatureStore</code>

         * @param roiStore

         * @param store

         * @param projection

         * @return

         * @throws ROIException

         * @throws FileNotExistsException

         */

        public ROIReader createVectorialROIReader(

                        FeatureStore roiStore, 

                        RasterDataStore store, 

                        IProjection projection);

        /**

         * Creates a writer for a ROI file

         * @param filename

         * @param projection

         * @return

         */

        public ROIWriter createROIWriter(

                        String filename, 

                        IProjection projection);

        /**

         * Creates a vectorial region of interest

         * @param roi

         * @return

         */

        public VectorialROI createVectorialROI(RasterDataStore roi);

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

         *      DEPRECATED

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

        /**

         * 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 

         * @deprecated Use {@link BufferFactory} to get a {@link BufferParams} and build a {@link Buffer}

         * BufferParam params = RasterManager.getBufferFactory().createBufferParams(dataType, width, height, bandNr, malloc);

         * Buffer buffer = RasterManager.getBufferFactory().createBuffer(params);

         */

        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

         * @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. 

         * @deprecated Use {@link BufferFactory} to get a {@link BufferParams} and build a {@link Buffer}

         * BufferParam params = RasterManager.getBufferFactory().createMemoryBufferParams(dataType, width, height, bandNr, malloc);

         * Buffer buffer = RasterManager.getBufferFactory().createBuffer(params);

         */

        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.

         * @deprecated Use DAL API {@link NewRasterStoreParameters}

         */

        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.

         * @deprecated Use DAL API {@link NewRasterStoreParameters}

         */

        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.

         * @deprecated Use DAL API {@link NewRasterStoreParameters}

         */

        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

         *  @deprecated Use DAL API {@link NewRasterStoreParameters}

         */

        public Params createWriterParams(String fileName);

        /**

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

         * @return

         * @deprecated Use DAL API {@link NewRasterStoreParameters}

         */

        public DataServerWriter createDataServerWriter();

}