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.compat.net.ICancellable;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.coverage.RasterLocator;

import org.gvsig.fmap.dal.coverage.RasterManager;

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

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

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

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

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

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

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

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

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

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

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

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.raster.spi.CoverageStoreProvider;

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

import org.gvsig.raster.impl.DefaultRasterManager;

import org.gvsig.raster.impl.buffer.DefaultRasterQuery;

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.provider.TiledRasterProvider;

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

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

import org.gvsig.tools.persistence.PersistentState;

import org.gvsig.tools.persistence.exception.PersistenceException;

/**

 * 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 DefaultRasterStore {

        public static final String   PERSISTENT_NAME        = "DefaultRemoteRasterStore_Persistent";

    public static final String   PERSISTENT_DESCRIPTION = "DefaultRemoteRasterStore Persistent";

        private double               fixedWidth  = -1;

        private double               fixedHeight = -1;

        private RasterManager        rManager    = RasterLocator.getManager();

        //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 {

                        RemoteStoreParameters params = null;

                        if(parameters instanceof RemoteStoreParameters)

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

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

                        ((RasterProvider)store.getProvider()).setStatus((RasterProvider)getProvider());

                        return store;

                } catch (ValidateDataParametersException e) {

                        return null;

                } catch (ProviderNotRegisteredException e) {

                        return null;

                } catch (InitializeException e) {

                        return null;

                }

        }

        /*

         * (non-Javadoc)

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

         */

        @Override

        protected Buffer setAreaOfInterestInWC(DefaultRasterQuery q)

                throws RasterDriverException, InvalidSetViewException, ProcessInterruptedException {

                if(q.getType() == DefaultRasterQuery.TYPE_COORDS) {

                        q.setAdjustToExtent(currentQuery.isAdjustToExtent());

                        return getWindowWithoutResampling(q);

                }

                if(        q.getType() == DefaultRasterQuery.TYPE_COORDS_SIZE || 

                        q.getType() == DefaultRasterQuery.TYPE_ONE_TILE) {

                        q.setAdjustToExtent(true);

                        return super.getWindowWithResampling(q);

                        /*if(getParameters() instanceof RemoteStoreParameters && ((RemoteStoreParameters)getParameters()).isSizeFixed()) {

                                q.setAdjustToExtent(true);

                                return super.getResampledWindow(q);

                        } else

                                return getWindow(q.getBBox().getULX(), q.getBBox().getULY(), q.getBBox().getLRX(), q.getBBox().getLRY(), q.getBufWidth(), q.getBufHeight(), true);*/

                }

                return null;

        }

        /*

         * (non-Javadoc)

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

         */

        public Buffer getWindowWC(DefaultRasterQuery q)

                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 = provider.worldToRaster(new Point2D.Double(q.getBBox().getULX(), q.getBBox().getULY()));

                Point2D p2 = provider.worldToRaster(new Point2D.Double(q.getBBox().getLRX(), q.getBBox().getLRY()));

                //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 = provider.rasterToWorld(new Point2D.Double(p1X, p1Y));

                Point2D wc2 = provider.rasterToWorld(new Point2D.Double(p2X, p2Y));

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

                        width = (int)fixedWidth;

                        height = (int)fixedHeight;

                }

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

                Extent ex = rManager.getDataStructFactory().createExtent(wc1.getX(), wc1.getY(), wc2.getX(), wc2.getY());

                q.setBBox(ex);

                q.setBandList(bandList);

                q.setBuffer(buffer);

                return ((DefaultRasterProvider)provider).getDataSet(q);

        }

        /*

         * (non-Javadoc)

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

         */

        public Buffer getWindowWithoutResampling(DefaultRasterQuery q)

                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 = provider.rasterToWorld(new Point2D.Double(0, 0));

                Point2D pEnd = provider.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())) ? (q.getX() - q.getW()) : (q.getX() + q.getW());

                double lry = (((int)(ext.getULY() - hRaster)) == ((int)ext.getLRY())) ? (q.getY() - q.getH()) : (q.getY() + q.getH());

                //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 = provider.worldToRaster(new Point2D.Double(q.getX(), q.getY()));

                Point2D p2 = provider.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 = provider.rasterToWorld(new Point2D.Double(Math.floor(p1.getX()), Math.floor(p1.getY())));

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

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

                q.setAreaOfInterest(wc1.getX(), wc1.getY(), Math.abs(wc2.getX() - wc1.getX()), Math.abs(wc2.getY() - wc1.getY()));

                q.setBandList(bandList);

                q.setBuffer(buffer);

                return ((DefaultRasterProvider)provider).getDataSet(q);

        }

        /*

         * (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 getWindowTiled(DefaultRasterQuery q)

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {                

                ((DefaultRasterProvider)provider).getDataSet(q);

        }

        /*

         * (non-Javadoc)

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

         */

        public Buffer getWindowWithResampling(DefaultRasterQuery q)

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {

                int mallocNBands = 0;

                if(bandList.getDrawableBands() != null)

                        mallocNBands = bandList.getDrawableBands().length;

                else

                        mallocNBands = bandList.getDrawableBandsCount();

                int dataType = provider.getDataType()[0];

                Buffer buffer =  DefaultRasterManager.getInstance().createMemoryBuffer(dataType, q.getBufWidth(), q.getBufHeight(), mallocNBands, true);

                q.setBandList(bandList);

                q.setBuffer(buffer);

                return ((DefaultRasterProvider)provider).getDataSet(q);

        }

        /*

         * (non-Javadoc)

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

         */

        public Buffer getWindowPx(DefaultRasterQuery q)

                throws InvalidSetViewException, ProcessInterruptedException, RasterDriverException {

                if(q.getPixelX() < 0 || q.getPixelY() < 0 || q.getPixelW() > getWidth() || q.getPixelH() > getHeight())

                        throw new InvalidSetViewException("Out of image");

                if(        q.getType() == DefaultRasterQuery.TYPE_PX || 

                        q.getType() == DefaultRasterQuery.TYPE_ENTIRE || 

                        q.getBufWidth() <= 0 || q.getBufHeight() <= 0) {

                        q.setBufWidth(q.getPixelW());

                        q.setBufHeight(q.getPixelH());

                        //TODO: Pruebas con SizeFixed

                        /*if(((RemoteStoreParameters)getParameters()).isSizeFixed())

                                return super.getWindow(q.getPixelX(), q.getPixelY(), q.getPixelW(), q.getPixelH());

                        else

                                return getWindow(q.getPixelX(), q.getPixelY(), q.getPixelW(), q.getPixelH());*/

                }

                Buffer buffer =  DefaultRasterManager.getInstance().createMemoryBuffer(provider.getDataType()[0], 

                                q.getBufWidth(), q.getBufHeight(), provider.getBandCount(), true);

                q.setBandList(bandList);

                q.setBuffer(buffer);

                return ((DefaultRasterProvider)provider).getDataSet(q);

        }

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

        //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 provider.getHeight();

        }

        /*

         * (non-Javadoc)

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

         */

        @Override

        public double getWidth() {

                return provider.getWidth();

        }

        /*

         * (non-Javadoc)

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

         */

        @Override

        public int[] getDataType() {

                return provider.getDataType();

        }

        /**

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

         * @return Coordenada X m?nima

         */

        @Override

        public double getMinX() {

                return provider.getExtent().getMin().getX();

        }

        /**

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

         * @return Coordenada Y m?nima

         */

        @Override

        public double getMinY() {

                return provider.getExtent().getMin().getY();

        }

        /**

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

         * @return Coordenada Y m?xima

         */

        @Override

        public double getMaxX() {

                return provider.getExtent().getMax().getX();

        }

        /**

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

         * @return Coordenada Y m?xima

         */

        @Override

        public double getMaxY() {

                return provider.getExtent().getMax().getY();

        }

        /**

         * 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 provider.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 provider.getColorTable();

        }

        /*

         * (non-Javadoc)

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

         */

        @Override

        public boolean isGeoreferenced() {

                return provider.isGeoreferenced();

        }

        /*

         * (non-Javadoc)

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

         */

        @Override

        public RasterDataStore getDataStore() {

                return this;

        }

        /*

         * (non-Javadoc)

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

         */

        @Override

        public RasterDataStore cloneDataStore() throws CloneException {

                DefaultRemoteRasterStore ds = new DefaultRemoteRasterStore();

                int[] bands = new int[]{provider.getBandCount()};

                ds.metadata = new MultiDataStoreMetadata(bands);

                RasterProvider prov = provider.cloneProvider();

                ds.provider = prov;

                ds.metadata = provider.getMetadata();

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

                return ds;

        }

        /*

         * (non-Javadoc)

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

         */

        @Override

        public HistogramComputer getHistogramComputer() {

                if(provider != null)

                        return provider.getHistogramComputer();

                return null;

        }

        /**

         * Returns true if the size is fixed

         * @return

         */

        public boolean isFixedSize() {

                return ((RemoteStoreParameters)getParameters()).isSizeFixed();

        }

        public CoverageStoreProvider getProvider() {

                return provider;

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.fmap.dal.coverage.store.RemoteRasterStore#getInfoByPoint(double, double)

         */

        public String getInfoByPoint(double x, double y, ICancellable cancellable) throws RemoteServiceException {

                return ((RasterProvider)getProvider()).getInfoByPoint(x, y, cancellable);

        }

        public String getInfoByPoint(double x, double y, Extent bbox, int w, int h, ICancellable cancellable) throws RemoteServiceException {

                return ((RemoteRasterProvider)getProvider()).getInfoByPoint((int)x, (int)y, bbox, w, h, cancellable);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.DefaultMultiRasterStore#getCoordsInTheNearestLevel(org.gvsig.fmap.dal.coverage.datastruct.Extent, int, int)

         */

        public Extent getCoordsInTheNearestLevel(Extent extent, int w, int h) {

                try {

                        return ((TiledRasterProvider)getProvider()).getCoordsInTheNearestLevel(extent, w, h);

                } catch (ClassCastException e) {

                        return null;

                }

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.DefaultMultiRasterStore#getCoordsInLevel(java.awt.geom.Point2D, int, int, int)

         */

        public Extent getCoordsInLevel(Point2D viewCenter, int level, int w, int h) {

                try {

                        return ((TiledRasterProvider)getProvider()).getCoordsInLevel(viewCenter, level, w, h);

                } catch (ClassCastException e) {

                        return null;

                }

        }

        /*

         * (non-Javadoc)

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

         */

        public int getZoomLevels() {

                try {

                        return ((TiledRasterProvider)getProvider()).getZoomLevels();

                } catch (ClassCastException e) {

                        return -1;

                }

        }

        /*

         * (non-Javadoc)

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

         */

        public int getNearestLevel(double pixelSize) {

                try {

                        return ((TiledRasterProvider)getProvider()).getNearestLevel(pixelSize);

                } catch (ClassCastException e) {

                        return -1;

                }

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.AbstractRasterDataStore#loadFromState(org.gvsig.tools.persistence.PersistentState)

         */

        public void loadFromState(PersistentState state)

                        throws PersistenceException {

                super.loadFromState(state);

        }

        /*

         * (non-Javadoc)

         * @see org.gvsig.raster.impl.store.AbstractRasterDataStore#saveToState(org.gvsig.tools.persistence.PersistentState)

         */

        public void saveToState(PersistentState state) throws PersistenceException {

                super.saveToState(state);

        }        

        public static void registerPersistence() {

                PersistenceManager manager = ToolsLocator.getPersistenceManager();

                DynStruct definition = manager.getDefinition(PERSISTENT_NAME);

                if( definition == null ) {

                        if (manager.getDefinition(DefaultRasterStore.class) == null) {

                                DefaultRasterStore.registerPersistence();

                        }

                        definition = manager.addDefinition(

                                        DefaultRemoteRasterStore.class,

                                        PERSISTENT_NAME,

                                        PERSISTENT_DESCRIPTION,

                                        null, 

                                        null

                        );

                        definition.extend(PersistenceManager.PERSISTENCE_NAMESPACE, DefaultRasterStore.PERSISTENT_NAME);

                }

        }

}