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.raster.impl.store;

import java.awt.geom.Point2D;

import org.gvsig.fmap.dal.DALLocator;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.fmap.dal.spi.DataManagerProviderServices;

import org.gvsig.raster.impl.DefaultRasterManager;

import org.gvsig.raster.impl.datastruct.BandListImpl;

import org.gvsig.raster.impl.provider.DefaultRasterProvider;

import org.gvsig.raster.impl.provider.RasterProvider;

import org.gvsig.raster.impl.provider.RemoteRasterProvider;

import org.gvsig.raster.impl.store.properties.MultiDataStoreHistogram;

import org.gvsig.raster.impl.store.properties.MultiDataStoreMetadata;

import org.gvsig.raster.impl.store.properties.MultiDataStoreStatistics;

import org.gvsig.raster.impl.store.properties.RemoteStoreHistogram;

/**

 * This store represents a raster loaded from a remote service. This implements the interface

 * RemoteRasterServiceStore to provide enough methods for this kind of services.

 *

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

 */

public class DefaultRemoteRasterStore extends DefaultMultiRasterStore {

        private boolean              open        = false;

        private double               fixedWidth  = -1;

        private double               fixedHeight = -1;

        //When a image hasn't been loaded yet we need to know the extent

        public DefaultRemoteRasterStore() {

                super();

        }

        /**

         * Crea un objeto MultiRasterDataset nuevo con los mismos ficheros

         * que el actual.

         * @return MultiRasterDataset

         * @throws InitializeException 

         */

        @Override

        public RasterDataStore newDataStore() {

                DataManagerProviderServices dataman = (DataManagerProviderServices) DALLocator.getDataManager();

                try {

                        WMSDataParameters params = ((WMSDataParameters)getParameters()).clone();

                        DefaultMultiRasterStore store = (DefaultMultiRasterStore)dataman.openStore(params.getDataStoreName(), params);

                        for (int i = 0; i < store.getProviders().size(); i++) {

                                store.getProvider(i).setStatus(getProvider(i));

                        }

                        return store;

                } catch (ValidateDataParametersException e) {

                        return null;

                } catch (ProviderNotRegisteredException e) {

                        return null;

                } catch (InitializeException e) {

                        return null;

                }

        }

        /**

         * Adds a provider

         * @param prov

         */

        public void addProvider(RemoteRasterProvider prov) {

                providers.add(prov);

                addBands(prov);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.RasterDataStore#getName()

         */

        public String getName() {

                if(providers != null && providers.size() >= 1)

                        return providers.get(0).getFName();

                return null;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.dataset.MultiRasterDataSet#addDataStore(org.gvsig.fmap.dal.coverage.buffer.RasterDataStore)

         */

        @Override

        public void addDataStore(RasterDataStore f)throws FileNotFoundInListException, InvalidSourceException, OperationNotSupportedException {

                throw new OperationNotSupportedException("Not supported for WMS");

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.dataset.MultiRasterDataSet#addDataStore(java.lang.String[])

         */

        @Override

        public void addDataStore(RasterProvider provider) throws OperationNotSupportedException {

                throw new OperationNotSupportedException("Not supported for WMS");

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.MultiRasterStore#addDataStore(java.lang.String[])

         */

        @Override

        public void addDataStore(String[] fileName) throws FileNotFoundInListException, NotSupportedExtensionException, RasterDriverException, OperationNotSupportedException {

                throw new OperationNotSupportedException("Not supported for WMS");

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.MultiRasterStore#addDataStore(java.lang.String)

         */

        public void addDataStore(String fileName)throws FileNotFoundInListException, NotSupportedExtensionException, RasterDriverException, OperationNotSupportedException {

                throw new OperationNotSupportedException("Not supported for WMS");

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.dataset.MultiRasterDataSet#removeDataStore(java.lang.String)

         */

        public void removeDataStore(String fileName) throws OperationNotSupportedException {

                throw new OperationNotSupportedException("Not supported for WMS");

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.dataset.MultiRasterDataSet#removeDataStore(org.gvsig.fmap.dal.coverage.buffer.RasterDataStore)

         */

        public void removeDataStore(RasterDataStore file) throws OperationNotSupportedException {

                throw new OperationNotSupportedException("Not supported for WMS");

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.AbstractRasterDataStore#setAreaOfInterest()

         */

        @Override

        protected Buffer setAreaOfInterest() 

                throws ProcessInterruptedException, InvalidSetViewException, RasterDriverException {

                return getWindowRaster(0, 0, (int)getWidth(), (int)getHeight());

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.AbstractRasterDataStore#setAreaOfInterest(double, double, double, double)

         */

        @Override

        protected Buffer setAreaOfInterest(double x, double y, double w, double h)

                throws RasterDriverException, InvalidSetViewException, ProcessInterruptedException {

                return getWindowRaster(x, y, w, h, currentQuery.isAdjustToExtent());

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.AbstractRasterDataStore#setAreaOfInterest(double, double, double, double, int, int)

         */

        @Override

        protected Buffer setAreaOfInterest(double ulx, double uly, double lrx, double lry, int bufWidth, int bufHeight)

                throws RasterDriverException, InvalidSetViewException, ProcessInterruptedException {

                if(getParameters() instanceof WMSDataParameters && ((WMSDataParameters)getParameters()).isSizeFixed())

                        return super.getWindowRaster(ulx, uly, lrx, lry, bufWidth, bufHeight, true);

                else

                        return getWindowRaster(ulx, uly, lrx, lry, bufWidth, bufHeight, true);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.AbstractRasterDataStore#setAreaOfInterest(int, int, int, int)

         */

        @Override

        protected Buffer setAreaOfInterest(int x, int y, int w, int h) 

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {

                if(((WMSDataParameters)getParameters()).isSizeFixed())

                        return super.getWindowRaster(x, y, w, h);

                else

                        return getWindowRaster(x, y, w, h);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.AbstractRasterDataStore#setAreaOfInterest(int, int, int, int, int, int)

         */

        @Override

        protected Buffer setAreaOfInterest(int x, int y, int w, int h, int bufWidth, int bufHeight)

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {

                if(((WMSDataParameters)getParameters()).isSizeFixed())

                        return super.getWindowRaster(x, y, w, h, bufWidth, bufHeight);

                else

                        return getWindowRaster(x, y, w, h, bufWidth, bufHeight);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.QueryableRaster#getWindowRaster(double, double, double, double)

         */

        public Buffer getWindowRaster(double ulx, double uly, double lrx, double lry)

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {

                //Leemos pixels completos aunque el valor obtenido sea decimal. Esto se consigue redondeando

                //por arriba el m?s alto y por abajo el menor y luego restandolos

                Point2D p1 = providers.get(0).worldToRaster(new Point2D.Double(ulx, uly));

                Point2D p2 = providers.get(0).worldToRaster(new Point2D.Double(lrx, lry));

                //Para el valor mayor redondeamos por arriba. Para el valor menor redondeamos por abajo.

                double p1X = (p1.getX() > p2.getX()) ? Math.ceil(p1.getX()) : Math.floor(p1.getX());

                double p1Y = (p1.getY() > p2.getY()) ? Math.ceil(p1.getY()) : Math.floor(p1.getY());

                double p2X = (p2.getX() > p1.getX()) ? Math.ceil(p2.getX()) : Math.floor(p2.getX());

                double p2Y = (p2.getY() > p1.getY()) ? Math.ceil(p2.getY()) : Math.floor(p2.getY());

                int width = (int)Math.abs(p1X - p2X);

                int height = (int)Math.abs(p1Y - p2Y);

                //Ajustamos por si nos hemos salido del raster

                if(((int)(Math.min(p1X, p2X) + width)) > getWidth())

                        width = (int)(getWidth() - Math.min(p1X, p2X));

                if(((int)(Math.min(p1Y, p2Y) + height)) > getHeight())

                        height = (int)(getHeight() - Math.min(p1Y, p2Y));

                if (p1X < 0)

                        p1X = 0;

                if (p1Y < 0)

                        p1Y = 0;

                if (p2X > getWidth())

                        p2X = getWidth();

                if (p2Y > getHeight())

                        p2Y = getHeight();

                //Si hemos redondeado los pixeles de la petici?n (p1 y p2) por arriba y por abajo deberemos calcular un extent mayor

                //equivalente a los pixeles redondeados.

                Point2D wc1 = providers.get(0).rasterToWorld(new Point2D.Double(p1X, p1Y));

                Point2D wc2 = providers.get(0).rasterToWorld(new Point2D.Double(p2X, p2Y));

                if(fixedWidth >= 0 && fixedHeight >= 0) {

                        width = (int)fixedWidth;

                        height = (int)fixedHeight;

                }

                Buffer buffer =  DefaultRasterManager.getInstance().createMemoryBuffer(getProvider(0).getDataType()[0], width, height, getProvider(0).getBandCount(), true);

                return ((DefaultRasterProvider)providers.get(0)).getWindowRaster(wc1.getX(), wc1.getY(), wc2.getX(), wc2.getY(), bandList, buffer);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.QueryableRaster#getWindowRaster(double, double, double, double, boolean)

         */

        public Buffer getWindowRaster(double ulx, double uly, double w, double h, boolean adjustToExtent)

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {

                //El incremento o decremento de las X e Y depende de los signos de rotaci?n y escala en la matriz de transformaci?n. Por esto

                //tenemos que averiguar si lrx es x + w o x -w, asi como si lry es y + h o y - h

                Extent ext = getExtent();

                Point2D pInit = providers.get(0).rasterToWorld(new Point2D.Double(0, 0));

                Point2D pEnd = providers.get(0).rasterToWorld(new Point2D.Double((int)getWidth(), (int)getHeight()));

                double wRaster = Math.abs(pEnd.getX() - pInit.getX());

                double hRaster = Math.abs(pEnd.getY() - pInit.getY());

                double lrx = (((int)(ext.getULX() - wRaster)) == ((int)ext.getLRX())) ? (ulx - w) : (ulx + w);

                double lry = (((int)(ext.getULY() - hRaster)) == ((int)ext.getLRY())) ? (uly - h) : (uly + h);

                //Leemos pixels completos aunque el valor obtenido sea decimal. Esto se consigue redondeando

                //por arriba el m?s alto y por abajo el menor y luego restandolos

                Point2D p1 = providers.get(0).worldToRaster(new Point2D.Double(ulx, uly));

                Point2D p2 = providers.get(0).worldToRaster(new Point2D.Double(lrx, lry));

                int width = (int)Math.abs(Math.ceil(p2.getX()) - Math.floor(p1.getX()));

                int height = (int)Math.abs(Math.floor(p1.getY()) - Math.ceil(p2.getY()));

                //Ajustamos por si nos hemos salido del raster

                if(((int)(p1.getX() + width)) > getWidth())

                        width = (int)(getWidth() - p1.getX());

                if(((int)(p1.getY() + height)) > getHeight())

                        height = (int)(getHeight() - p1.getY());

                if (p1.getX() < 0)

                        p1.setLocation(0, p1.getY());

                if (p1.getY() < 0)

                        p1.setLocation(p1.getX(), 0);

                if (p2.getX() > getWidth())

                        p2.setLocation(getWidth(), p2.getY());

                if (p2.getY() > getHeight())

                        p2.setLocation(p2.getX(), getHeight());

                if(fixedWidth >= 0 && fixedHeight >= 0) {

                        width = (int)fixedWidth;

                        height = (int)fixedHeight;

                }

                //Si hemos redondeado los pixeles de la petici?n (p1 y p2) por arriba y por abajo deberemos calcular un extent mayor

                //equivalente a los pixeles redondeados.

                Point2D wc1 = providers.get(0).rasterToWorld(new Point2D.Double(Math.floor(p1.getX()), Math.floor(p1.getY())));

                Point2D wc2 = providers.get(0).rasterToWorld(new Point2D.Double(Math.ceil(p2.getX()), Math.ceil(p2.getY())));

                Buffer buffer =  DefaultRasterManager.getInstance().createMemoryBuffer(getProvider(0).getDataType()[0], width, height, getProvider(0).getBandCount(), true);

                return ((DefaultRasterProvider)providers.get(0)).getWindowRaster(wc1.getX(), wc1.getY(), Math.abs(wc2.getX() - wc1.getX()), Math.abs(wc2.getY() - wc1.getY()), bandList, buffer, adjustToExtent);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.QueryableRaster#getWindowRaster(double, double, double, double, int, int, org.gvsig.fmap.dal.coverage.grid.render.TileListener, int)

         */

        public void getWindowRaster(double ulx, double uly, double lrx, double lry, 

                int bufWidth, int bufHeight, TileListener listener)

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {

                ((DefaultRasterProvider)providers.get(0)).getWindowRaster(ulx, uly, lrx, lry, bufWidth, bufHeight, bandList, listener);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.QueryableRaster#getWindowRaster(double, double, double, double, int, int, boolean)

         */

        public Buffer getWindowRaster(double ulx, double uly, double lrx, double lry, int bufWidth, int bufHeight, boolean adjustToExtent)

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {

                Buffer buffer =  DefaultRasterManager.getInstance().createMemoryBuffer(getProvider(0).getDataType()[0], bufWidth, bufHeight, getProvider(0).getBandCount(), true);

                return ((DefaultRasterProvider)providers.get(0)).getWindowRaster(ulx, uly, lrx, lry, bufWidth, bufHeight, bandList, buffer, adjustToExtent);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.QueryableRaster#getWindowRaster(int, int, int, int)

         */

        public Buffer getWindowRaster(int x, int y, int w, int h)

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {

                if(x < 0 || y < 0 || w > providers.get(0).getWidth() || h > providers.get(0).getHeight())

                        throw new InvalidSetViewException("Out of image");

                Buffer buffer =  DefaultRasterManager.getInstance().createMemoryBuffer(getProvider(0).getDataType()[0], w, h, getProvider(0).getBandCount(), true);

                return ((DefaultRasterProvider)providers.get(0)).getWindowRaster(x, y, w, h, bandList, buffer);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.QueryableRaster#getWindowRaster(int, int, int, int, int, int)

         */

        public Buffer getWindowRaster(int x, int y, int w, int h, int bufWidth, int bufHeight)

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {

                if(x < 0 || y < 0 || w > providers.get(0).getWidth() || h > providers.get(0).getHeight())

                        throw new InvalidSetViewException("Out of image");

                Buffer buffer =  DefaultRasterManager.getInstance().createMemoryBuffer(getProvider(0).getDataType()[0], bufWidth, bufHeight, getProvider(0).getBandCount(), true);

                return ((DefaultRasterProvider)providers.get(0)).getWindowRaster(x, y, w, h, bufWidth, bufHeight, bandList, buffer);

        }

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

        //Setters and Getters

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

        /**

         * Calcula el tama?o de los ficheros en disco

         * @return tama?o en bytes de todos los ficheros de la lista

         */

        @Override

        public long getFileSize() {

                return 0;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.DefaultMultiRasterStore#getHeight()

         */

        @Override

        public double getHeight() {

                return providers.get(0).getHeight();

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.dataset.IRasterDataSource#getWidth()

         */

        @Override

        public double getWidth() {

                return providers.get(0).getWidth();

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.dataset.RasterDataStore#getDataType()

         */

        @Override

        public int[] getDataType() {

                return providers.get(0).getDataType();

        }

        /**

         * Obtiene la coordenada X m?nima de toda la lista

         * @return Coordenada X m?nima

         */

        @Override

        public double getMinX() {

                return providers.get(0).getExtent().getMin().getX();

        }

        /**

         * Obtiene la coordenada Y m?nima de toda la lista

         * @return Coordenada Y m?nima

         */

        @Override

        public double getMinY() {

                return providers.get(0).getExtent().getMin().getY();

        }

        /**

         * Obtiene la coordenada Y m?xima de toda la lista

         * @return Coordenada Y m?xima

         */

        @Override

        public double getMaxX() {

                return providers.get(0).getExtent().getMax().getX();

        }

        /**

         * Obtiene la coordenada Y m?xima de toda la lista

         * @return Coordenada Y m?xima

         */

        @Override

        public double getMaxY() {

                return providers.get(0).getExtent().getMax().getY();

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.RasterDataStore#getTransparencyFilesStatus()

         */

        @Override

        public Transparency getTransparencyFilesStatus() {

                return providers.get(0).getTransparency();

        }

        /**

         * Obtiene la paleta correspondiente a uno de los ficheros que forman el GeoMultiRasterFile

         * @param i Posici?n del raster

         * @return Paleta asociada a este o null si no tiene

         */

        @Override

        public ColorTable getColorTable(int i) {

                return providers.get(0).getColorTable();

        }

        /**

         * Obtiene la lista de paletas correspondiente a todos los ficheros que forman el GeoMultiRasterFile

         * @return Paleta asociada a este o null si no tiene. Una posici?n null en el array tambi?n indica que

         * para ese fichero no hay paletas asociadas.

         */

        @Override

        public ColorTable[] getColorTables(){

                return new ColorTable[]{providers.get(0).getColorTable()};

        }

        /**

         * Obtiene la paleta correspondiente al nombre del fichero pasado por par?metro.

         * @param fileName Nombre del fichero

         * @return Paleta o null si no la tiene

         */

        @Override

        public ColorTable getColorTable(String fileName){

                return providers.get(0).getColorTable();

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.dataset.IRasterDataSource#isGeoreferenced()

         */

        @Override

        public boolean isGeoreferenced() {

                return providers.get(0).isGeoreferenced();

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.util.IHistogramable#getPercent()

         */

        @Override

        public int getPercent() {

                return 0;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.util.IHistogramable#resetPercent()

         */

        @Override

        public void resetPercent() {

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.dataset.QueryableRaster#getDataset()

         */

        @Override

        public RasterDataStore getDataStore() {

                return this;

        }

        /**

         * Obtiene el n?mero de dataset para un n?mero de banda y la posici?n de la banda dentro de

         * ese dataset.

         * @param bandNumber N?mero de banda

         * @return Dataset que corresponde a la banda pedida y n?mero de banda dentro del dataset (dataset, banda)

         */

        @Override

        public int[] getProviderFromBandNumber(int bandNumber) {

                if(bandNumber < 0 && bandNumber >= getBandCount())

                        return new int[]{0, bandNumber};

                return null;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.RasterDataStore#cloneDataStore()

         */

        @Override

        public RasterDataStore cloneDataStore() {

                DefaultRemoteRasterStore ds = new DefaultRemoteRasterStore();

                int[] bands = new int[]{providers.get(0).getBandCount()};

                ds.metadata = new MultiDataStoreMetadata(bands);

                RasterProvider prov = providers.get(0).cloneProvider();

                ds.providers.add(prov);

                ds.metadata.add(providers.get(0).getMetadata());

                ds.bandList = (BandListImpl)bandList.clone();

                ds.stats = new MultiDataStoreStatistics(ds.providers);

                ds.histogram = new MultiDataStoreHistogram(ds);

                return ds;

        }

    /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.RasterDataStore#isOpen()

         */

        public boolean isOpen() {

                return open;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.RasterDataStore#getHistogram()

         */

        @Override

        public Histogram getHistogram() {

                if (histogram == null)

                        histogram = new RemoteStoreHistogram(this);

                return histogram;

        }

        /**

         * Returns true if the size is fixed

         * @return

         */

        public boolean isFixedSize() {

                return ((WMSDataParameters)getParameters()).isSizeFixed();

        }

}