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

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

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

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

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

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

/**

 * Providers information

 * @author Nacho Brodin nachobrodin@gmail.com

 */

public interface ProviderServices {

        /**

         * 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, boolean reprojectable) 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

         */

        @SuppressWarnings("unchecked")

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

        /**

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

         * la misma clase que el objeto value.

         *

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

         *

         * @param file

         * @param value

         * @throws RmfSerializerException

         */

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

        /**

         * Builds a RasterStoreParameters using a file name. 

         * It is only valid for files.

         */

        public RasterDataParameters createParameters(String id);

        /**

         * Builds a RasterStoreParameters 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 RasterStoreParameters 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);

}