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.util;

import java.io.File;

import java.io.IOException;

import java.util.ArrayList;

import org.gvsig.fmap.dal.DataStoreParameters;

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

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

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

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

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

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

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

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

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

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

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

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

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

/**

 * Providers information and basic operations

 *

 * @author Nacho Brodin nachobrodin@gmail.com

 */

public interface ProviderServices {

    /**

     * 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(String file) throws NotSupportedExtensionException, RasterDriverException,

        InitializeException, ProviderNotRegisteredException;

    public RasterDataStore open(CoverageStoreProvider prov, DataStoreParameters params)

        throws NotSupportedExtensionException, RasterDriverException;

    /**

     * Registers raster providers that support tiles. This method is only for

     * providers.

     * In a far future it will be in the SPI.

     *

     * @param provider

     */

    public void registerFileProvidersTiled(Class<?> provider);

    /**

     * Gets the list of raster providers that support tiles. This method is only

     * for providers.

     * In a far future it will be in the SPI.

     *

     * @return

     */

    public void registerTileProviderFormats(Class<?> c);

    /**

     * Registers a implementation to create overviews

     *

     * @param ovBuilder

     */

    public void registerOverviewBuilderImplementation(String id, OverviewBuilder ovBuilder);

    /**

     * Registers a implementation for the CRS service

     *

     * @param crsUtil

     */

    public void registerCRSUtilImplementation(CRSUtils crsUtil);

    /**

     * Register a format and a provider which is capable to manage this format

     *

     * @param ext

     *            Extension

     * @param c

     *            Provider class

     */

    public void addFormat(String ext, Class<?> c);

    /**

     * Returns true if the extension is supported and false if doesn't

     *

     * @param ext

     * @return

     */

    public boolean isExtensionSupported(String ext, Class<?> c);

    /**

     * Returns true if the extension is supported and false if doesn't

     *

     * @param ext

     * @return

     */

    public boolean isExtensionSupported(String ext);

    /**

     * Returns the list of supported formats in read only mode

     *

     * @return

     */

    public String[] getReadOnlyFormatList();

    /**

     * Obtiene la lista de extensiones registradas

     *

     * @return Lista de extensiones registradas o null si no hay ninguna

     */

    public String[] getDriversExtensions();

    /**

     * Obtiene la lista de extensiones de ficheros sobre los que se puede salvar

     * en un determinado tipo de datos. Como par?metro de la funci?n se

     * especifica

     * el tipo de datos sobre el que se desea consultar. Este m?todo consulta

     * para

     * cada driver registrado que extensiones soportan un tipo.

     *

     * @param dataType

     *            Tipo de datos

     * @param bands

     *            Numero de bandas

     * @param reprojectable

     *            Especifica si devuelve solo los formatos reproyectables

     * @return Lista de extensiones registradas que soportan el tipo de datos

     *         pasado por par?metro.

     * @throws RasterDriverException

     */

    public ArrayList<String> getExtensionsSupported(int dataType, int bands) throws RasterDriverException;

    /**

     * Obtiene la lista de tipos de driver

     *

     * @return Lista de tipos de driver registradas o null si no hay ninguno

     */

    public String[] getWriteDriversType();

    /**

     * Obtiene el tipo de driver a partir de la extensi?n

     *

     * @param ext

     *            Extensi?n

     * @return Tipo

     */

    public String getWriteDriverType(String ext);

    /**

     * Devuelve el n?mero de drivers soportados

     *

     * @return N?mero de drivers soportados

     */

    public int getWriteNDrivers();

    /**

     * Devuelve el n?mero de tipos de driver registrados

     *

     * @return N?mero de tipos de driver soportados

     */

    public int getWriteNTypes();

    /**

     * M?todo que pregunta si la extensi?n pasada por par?metro est? soportada

     * con

     * el tipo y n?mero de bandas indicadas.

     *

     * @param dataType

     *            Tipo de dato

     * @param bands

     *            N?mero de bandas

     * @param extensi?n

     * @return true si est? soportada y false si no lo est?

     */

    public boolean isSupportedThisFileToWrite(String ext, int dataType, int bands);

    /**

     * Guarda en el fichero file (en formato RMF) el objecto value usando el

     * serializador que trata

     * las clases class1.

     *

     * Si el fichero RMF no existe se crea. Ha de ser un RMF de formato valido.

     *

     * @param file

     * @param class1

     * @param value

     * @throws RmfSerializerException

     */

    public void saveObjectToRmfFile(String file, Class<?> class1, Object value) throws RmfSerializerException;

    /**

     * The object passed by parameter is saved in the selected file (in RMF

     * format)

     * using the serializer. If the RMF file does not exists it is created

     *

     * @param file

     * @param value

     * @throws RmfSerializerException

     */

    public void saveObjectToRmfFile(String file, Object value) throws RmfSerializerException;

    /**

     * Builds a <code>RasterStoreParameters</code> using a file name.

     * It is only valid for files.

     */

    public RasterDataParameters createParameters(String id);

    /**

     * Builds a <code>RasterStoreParameters</code> using a file name.

     * It is only valid for files but the provider will be not tiled

     *

     * @throws ProviderNotRegisteredException

     * @throws InitializeException

     */

    public RasterDataParameters createNotTiledParameters(String id) throws InitializeException,

        ProviderNotRegisteredException;

    /**

     * Builds a <code>RasterStoreParameters</code> using a file name. If exists

     * more than one

     * provider which support this file this method will return a list of

     * parameters

     * It is only valid for files.

     */

    public ArrayList<RasterDataParameters> createParametersList(String id);

    /**

     * Builds a <code>RasterStoreParameters</code> using a file. If exists more

     * than one

     * provider which support this file this method will return a list of

     * parameters

     * It is only valid for files.

     */

    public ArrayList<RasterDataParameters> createParametersList(File file);

    /**

     * Builds a <code>RasterStoreParameters</code> for tiled files using a file

     * name.

     */

    public RasterDataParameters createParametersForTiledFiled(String id);

    /**

     * Saves a buffer to disk

     *

     * @param bufResult

     *            Buffer to save

     * @param pixelSize

     *            Pixel size

     * @param extension

     *            output file format

     * @param alphaBand

     *            true if it has alpha band

     * @param file

     *            Path to the new file

     * @param extent

     *            Bounding box of the buffer

     * @throws NotSupportedExtensionException

     * @throws RasterDriverException

     * @throws ProcessInterruptedException

     * @throws IOException

     */

    public void exportBufferToFile(Buffer bufResult, double pixelSize, String extension, boolean alphaBand, File file,

        Extent extent, ColorInterpretation colorInterpretation) throws NotSupportedExtensionException,

        RasterDriverException, ProcessInterruptedException, IOException;

}