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

import org.cresques.cts.IProjection;

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

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

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

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

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

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

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

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

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

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

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

/**

 * Properties of a raster data store

 *

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

 */

public interface RasterStoreProperties {

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

        //***********Single Properties*************

        /**

         * Obtiene el tipo de dato por banda

         * @return tipo de dato por banda

         */

        public int[] getDataType();

        /**

         * Gets the nodata value for this raster

         * @return

         */

        public NoData getNoDataValue();

        /**

         * Obtiene el n?mero de bandas del raster

         * @return N?mero de bandas

         */

        public int getBandCount();

        /**

         * Obtiene la altura del raster en p?xeles.

         * @return altura

         */

        public double getHeight();

        /**

         * Obtiene la anchura del raster en p?xeles.

         * @return anchura

         */

        public double getWidth();

        /**

         * Obtiene el tama?o de celda del raster

         * @return Valor del tama?o de celda

         */

        public double getCellSize();

        /**

         * Obtiene el tama?o de pixel en X

         * @return tama?o de pixel en X

         */

        public double getPixelSizeX();

        /**

         * Obtiene el tama?o de pixel en Y

         * @return tama?o de pixel en Y

         */

        public double getPixelSizeY();

        /**

         * Obtiene el extent del raster.

         * @return Extent

         */

        public Extent getExtent();

        /**

         * Este es el extent sobre el que se ajusta una petici?n para que esta no

         * exceda el extent m?ximo del raster. Para un raster sin rotar ser? igual al

         * extent pero para un raster rotado ser? igual al extent del raster como si

         * no tuviera rotaci?n. Esto ha de ser as? ya que la rotaci?n solo se hace

         * sobre la vista y las peticiones han de hacerse en coordenadas de la imagen

         * sin shearing aplicado.

         * @return Extent

         */

        public Extent getExtentWithoutRot();

        /**

         * Obtiene el nombre del dataStore

         * @return String 

         *         nombre del fichero

         */

        public String getName();

        /**

         * Obtiene la proyecci?n asociada al raster. Como todos los dataset del 

         * multiDataset deben tener la misma proyecci?n obtenemos esta del primer

         * dataset.

         * @return Proyecci?n en formato cadena

         * @throws RasterDriverException

         */

        public String getWktProjection() throws RasterDriverException;

        /**

         * Gets the dataset projection

         * @return IProjection

         */

        public IProjection getProjection();

        /**

         * Sets the dataset projection

         * @param proj

         */

        public void setProjection(IProjection proj, boolean persist) throws RmfSerializerException;

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

        //***********Dataset Properties*************

        /**

         * Obtiene el objeto que contiene que contiene la interpretaci?n de 

         * color por banda para el dataset seleccionado

         * @param dataset Dataset del que se necesesita la informaci?n de color dentro del RasterMultiDataset

         * @return DatasetColorInterpretation

         */

        public ColorInterpretation getColorInterpretation();

        public void setColorInterpretation(ColorInterpretation ci);

        /**

         * Gets the object with the metadata

         * @return

         */

        public Metadata getMetadata();

        /**

         * Gets the color table.

         * @return color table loaded or null if it doesn't have

         */

        public ColorTable getColorTable();

        /**

         * Gets the legend as a image. The store could not have implemented this method .

         * This is useful above all for WMS but whatever raster layer 

         * could return a legend as image.

         * @return

         */

        public Image getImageLegend();

        /**

         * Obtiene el estado de transparencia a partir de los estados de transparencia de todos

         * los ficheros que lo componen. Si varios de los ficheros que lo componen tienen banda de 

         * transparencia estas tendr?n que ser mezcladas sobre una banda de transparencia ?nica.

         * @return Objeto FileTransparency con el estado de transparencia

         */

        public Transparency getTransparency();

        /**

         * Gets the statistics object

         * @return MultiFileStatistics

         */

        public Statistics getStatistics();

        /**

         * Sets the statistics object. When the statistics are assigned the rmf is saved

         * with the new statistics.

         * @param stats

         * @throws RmfSerializerException 

         */

        public void setStatistics(Statistics stats) throws RmfSerializerException;

        /**

         * Obtiene el histograma asociado al dataset. 

         *

         * @return Histograma asociado al dataset.

         * @throws InterruptedException 

         */

        public HistogramComputer getHistogramComputer() throws HistogramException, InterruptedException;

}