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.postgis.io;

import java.awt.geom.AffineTransform;

import java.awt.geom.Rectangle2D;

import java.io.File;

import java.util.ArrayList;

import java.util.Collections;

import java.util.Iterator;

import java.util.List;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.DataStore;

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

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

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

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

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

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

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

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

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

import org.gvsig.fmap.dal.coverage.util.FileUtils;

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

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.serverexplorer.db.DBServerExplorer;

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

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

import org.gvsig.fmap.dal.store.db.DBStoreParameters;

import org.gvsig.metadata.MetadataLocator;

import org.gvsig.raster.cache.tile.provider.TileListener;

import org.gvsig.raster.cache.tile.provider.TileServer;

import org.gvsig.raster.gdal.io.GdalDataParameters;

import org.gvsig.raster.gdal.io.GdalNative;

import org.gvsig.raster.gdal.io.GdalProvider;

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

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

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

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

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

import org.gvsig.raster.impl.store.AbstractRasterDataParameters;

import org.gvsig.raster.impl.store.DefaultStoreFactory;

import org.gvsig.raster.postgis.io.downloader.PostGISRasterTileServer;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.task.TaskStatus;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * This class represents the data access just for PostGIS raster databases.

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

 */

public class PostGISRasterProvider extends GdalProvider implements RemoteRasterProvider {

        public static String           NAME                     = "PostGIS Raster Store";

        public static String           DESCRIPTION              = "PostGIS Raster file";

        public static final String     METADATA_DEFINITION_NAME = "PostGISRasterStore";

        private static final String    OVERVIEW_PREFIX          = "o_";

        private DBServerExplorer       dbServerExplorer         = null;

        private DBStoreParameters      dbParameters             = null;

        private ArrayList<Overview>    overviews                = null;

        private DataManager            dataManager              = DALLocator.getDataManager();

        private DefaultRasterProvider  selectedProvider         = null;

        private Overview               mainOverview             = null;

        private static Logger          logger                   = LoggerFactory.getLogger(PostGISRasterProvider.class.getName());

        class Overview implements Comparable<Overview> {

                public int                         width               = 0;

                public int                         height              = 0;

                public int                         factor              = 0;

                public double                      pxSizeOverview      = 0;

                public DefaultRasterProvider       provider            = null;

                public Overview() {

                }

                public Overview(int f, int w, int h, PostGISRasterDataParameters p) throws NotSupportedExtensionException {

                        this.width = w;

                        this.height = h;

                        this.factor = f;

                        if(p != null)

                                createProvider(p);

                        this.pxSizeOverview = getExtent().width() / (double)w;

                }

                public void createProvider(PostGISRasterDataParameters p) throws NotSupportedExtensionException {

                        GdalDataParameters gdalParams = new GdalDataParameters();

                        gdalParams.setURI(p.getURI());

                        try {

                                this.provider = new GdalProvider(gdalParams, storeServices);

                        } catch (NotSupportedExtensionException e) {

                                logger.info("===>" + gdalParams.getURI() + " " + e.getMessage(), e);

                        }

                        this.width = (int)provider.getWidth();

                        this.height = (int)provider.getHeight();

                        this.pxSizeOverview = provider.getExtent().width() / (double)this.width;

                }

                public int compareTo(Overview o) {

                        if(factor < o.factor)

                                return -1;

                        if(factor > o.factor)

                                return 1;

                        return 0;

                }

        }

        public static void register() {

                RasterLocator.getManager().getProviderServices().registerFileProvidersTiled(PostGISRasterProvider.class);

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

                if (dataman != null && !dataman.getStoreProviders().contains(NAME)) {

                        dataman.registerStoreProvider(NAME,

                                        PostGISRasterProvider.class, PostGISRasterDataParameters.class);

                }

                if (!dataman.getExplorerProviders().contains(PostGISRasterProvider.NAME)) {

                        dataman.registerExplorerProvider(PostGISRasterServerExplorer.NAME, PostGISRasterServerExplorer.class, PostGISRasterServerExplorerParameters.class);

                }

                dataman.registerStoreFactory(NAME, DefaultStoreFactory.class);

        }

        public PostGISRasterProvider() {

        }

        public PostGISRasterProvider (PostGISRasterDataParameters params,

                        DataStoreProviderServices storeServices) throws NotSupportedExtensionException {

                super(params, storeServices, ToolsLocator.getDynObjectManager()

                                .createDynObject(

                                                MetadataLocator.getMetadataManager().getDefinition(

                                                                DataStore.METADATA_DEFINITION_NAME)));

                init(params, storeServices);

        }

        /**

         * Creates data base references and loads structures with the information and metadata

         * @param params load parameters

         * @throws NotSupportedExtensionException

         */

        public void init (AbstractRasterDataParameters params,

                        DataStoreProviderServices storeServices) throws NotSupportedExtensionException {

                try {

                        setParam(storeServices, params);

                        mainOverview = new Overview();

                        mainOverview.createProvider((PostGISRasterDataParameters)param);

                        mainOverview.factor = 1;

                        file = ((GdalProvider)mainOverview.provider).getNative();

                        setColorInterpretation(file.getColorInterpretation());

                        setColorTable(file.getColorTable());

                        noData = file.getNoDataValue();

                        String wktProjection = file.getProjectionRef();

                        if(wktProjection != null && wktProjection != "") {

                                try {

                                        proj = RasterLocator.getManager().getCRSUtils().convertWktToIProjection(wktProjection);

                                } catch (Exception e) {

                                        logger.info("Error reading WKT from the raster provider", e);

                                }

                        }

                        //CrsWkt crs = new CrsWkt(wktProjection);

                        //IProjection proj = CRSFactory.getCRS("EPSG:23030");

                        ownTransformation = file.getOwnTransformation();

                        externalTransformation = (AffineTransform)ownTransformation.clone();

                        bandCount = file.getRasterCount();

                        load();

                } catch (Exception e) {

                        throw new NotSupportedExtensionException("Gdal library can't be initialized with this PostGIS raster parameters", e);

                } 

                //Obtenemos el tipo de dato de gdal y lo convertimos el de RasterBuf

                int[] dt = new int[file.getDataType().length];

                for (int i = 0; i < dt.length; i++)

                        dt[i] = GdalNative.getRasterBufTypeFromGdalType(file.getDataType()[i]);

                setDataType(dt);

                PostGISRasterDataParameters p = (PostGISRasterDataParameters)params;

                //Object obj = p.getDynValue(PostGISRasterDataParameters.FIELD_DBPARAMS);

                dbParameters = (DBStoreParameters)p.getDynValue(PostGISRasterDataParameters.FIELD_DBPARAMS);

                dbServerExplorer = (DBServerExplorer)p.getDynValue(PostGISRasterDataParameters.FIELD_DBEXPLORER);

        }

        public String getRMFFile() {

                return super.getRMFFileForRemoteServices(getTableName(uri));

        }

        /**

         * Reads overviews from database. The overviews in PostGIS raster are loaded 

         * in separated tables. The name of those tables is the same that the original table

         * with a overview prefix. Now this prefix is "o_X_" where the X is a factor scale.

         * 

         * For that reason the overview object contains the DataParameter which correspond

         * to each table.

         * @throws DataException 

         * @throws DataException

         */

        @SuppressWarnings("unchecked")

        private void readOverviews() throws DataException  {

                if(overviews == null) {

                        overviews = new ArrayList<Overview>();

                        String mainHost = ((PostGISRasterDataParameters)param).getURI();

                        String mainTable = dbParameters.getTable();

                        List parameters = dbServerExplorer.list();

                        int mainFactor = 1; 

                        if(isOverview(mainTable, mainTable)) {

                                mainFactor = getFactor(mainTable);

                        }

                        overviews.add(mainOverview);

                        Iterator iter = parameters.iterator();

                        while (iter.hasNext()) {

                                DBStoreParameters p = (DBStoreParameters) iter.next();

                                String tname = p.getTable();

                                try {

                                        if(isOverview(mainTable, tname)) {

                                                Overview o = new Overview();

                                                o.factor = (getFactor(tname) / mainFactor);

                                                o.width = (int)(getWidth() / o.factor);

                                                o.height = (int)(getHeight() / o.factor);

                                                o.pxSizeOverview = getExtent().width() / (double)o.width;

                                                o.createProvider(createParameters(mainHost, mainTable, tname));

                                                overviews.add(o);

                                        }

                                } catch (NumberFormatException e) {

                                } catch (PostGISRasterCoreException e) {

                                } catch (ValidateDataParametersException e) {

                                } catch (NotSupportedExtensionException e) {

                                }

                        }

                        Collections.sort(overviews);

                }

        }

        /**

         * Returns true if tname is an overview of mainTable

         * @param mainTable

         * @param tname

         * @return

         */

        private boolean isOverview(String mainTable, String tname) throws NumberFormatException {

                if(mainTable.compareTo(tname) != 0) {

                        return ((tname.endsWith(mainTable) && tname.startsWith(OVERVIEW_PREFIX)) ||

                                        (tname.startsWith(OVERVIEW_PREFIX) && mainTable.startsWith(OVERVIEW_PREFIX) && getFactor(tname) > getFactor(mainTable)));

                }

                return false;

        }

        /**

         * Gets the overview factor number reading the name of the table

         * @param tname

         * @return

         * @throws NumberFormatException

         */

        private int getFactor(String tname) throws NumberFormatException {

                String factor = tname.substring(tname.indexOf('_') + 1);

                factor = factor.substring(0, factor.indexOf('_'));

                return new Integer(factor);

        }

        /**

         * Creates the list of parameters

         * @param mainHost

         * @param mainTable

         * @param tableName

         * @return

         * @throws PostGISRasterCoreException 

         * @throws PostGISRasterCoreException

         * @throws ProviderNotRegisteredException 

         * @throws InitializeException 

         * @throws ValidateDataParametersException 

         */

        @SuppressWarnings("deprecation")

        private PostGISRasterDataParameters createParameters(String mainHost, String mainTable, String tableName) throws PostGISRasterCoreException, ValidateDataParametersException, InitializeException, ProviderNotRegisteredException {

                String newHost = mainHost.replaceFirst(mainTable, tableName);

                PostGISRasterServerExplorerParameters explorerParams = (PostGISRasterServerExplorerParameters) dataManager.createServerExplorerParameters(PostGISRasterServerExplorer.NAME);

                explorerParams.setHost(newHost);

                PostGISRasterServerExplorer explorer = (PostGISRasterServerExplorer) dataManager.createServerExplorer(explorerParams);

                RasterDataParameters storeParameters = (RasterDataParameters)explorer.getStoreParameters();

                storeParameters.setURI(newHost);

                return (PostGISRasterDataParameters)storeParameters;

        }

        /**

         * Selects the right overview. The right overview means the first 

         * one with a pixel size lesser or equals than the original. 

         * @param pixels

         * @param mts

         */

        private void overviewSelector(int pixels, double mts) {

                this.selectedProvider = overviews.get(overviews.size() - 1).provider;

                //System.out.println("*************" + overviews.get(overviews.size() - 1).pxSizeOverview + "**************");

                double pxSizeRequest = mts / (double)pixels;

                for (int i = overviews.size() - 1; i > 0; i--) {

                        Overview ovb = overviews.get(i);

                        if(pxSizeRequest <= ovb.pxSizeOverview) {

                                this.selectedProvider = ovb.provider;

                                //System.out.println(ovb.pxSizeOverview);

                        }

                }

                //System.out.println("***************************");

                logger.info("...Overview selected: " + getTableName(selectedProvider.getURI()) + " W:" + selectedProvider.getWidth() + " H:" + selectedProvider.getHeight());

        }

        public int getOverviewCount(int band) throws BandAccessException, RasterDriverException {

                if(band >= getBandCount())

                        throw new BandAccessException("Wrong band");

                return overviews.size();

        }

        public int getOverviewWidth(int band, int overview) throws BandAccessException, RasterDriverException {

                if (band >= getBandCount())

                        throw new BandAccessException("Wrong band");

                if (overview >= overviews.size())

                        throw new BandAccessException("Wrong overview count");

                return overviews.get(overview).width;

        }

        public int getOverviewHeight(int band, int overview) throws BandAccessException, RasterDriverException {

                if (band >= getBandCount())

                        throw new BandAccessException("Wrong band");

                if (overview >= overviews.size())

                        throw new BandAccessException("Wrong overview count");

                return overviews.get(overview).height;

        }

        public void getWindow(

                        Extent ex, 

                        int bufWidth, 

                        int bufHeight, 

                        BandList bandList, 

                        TileListener listener, 

                        TaskStatus status) throws ProcessInterruptedException, RasterDriverException {

//                PostGISRasterDataParameters p = (PostGISRasterDataParameters)param;

//                Buffer buf = RasterLocator.getManager().createBuffer(getDataType()[0], bufWidth, bufHeight, getBandCount(), true);

//                TileCacheManager m = TileCacheLocator.getManager();

//                Tile tile = m.createTile(-1, 0, 0);

//                

//                //Creamos un BandList con todas las bandas del fichero

//                BandList bl = new BandListImpl();

//                for(int i = 0; i < getBandCount(); i++) {

//                        try {

//                                DatasetBand band = new DatasetBandImpl(selectedProvider.getURIOfFirstProvider(), i, getDataType()[i], getBandCount());

//                                bl.addBand(band, i);

//                        } catch(BandNotFoundInListException e) {

//                                //No a?adimos la banda

//                        }

//                }

//                

//                if(p.getNumberOfBlocks() > 1) {

//                        for (int i = 0; i < p.getNumberOfBlocks(); i++) {

//                                GdalNative gdal;

//                                try {

//                                        gdal = new GdalNative(p.getURI() + " column='rast' where='rid = " + i + "'");

//                                        gdal.readWindow(buf, bandList, 0, 0, gdal.width, gdal.height, bufWidth, bufHeight);

//                                        Extent ext = gdal.getExtentWithoutRot();

//                                        tile.setUl(new Point2D.Double(ext.getULX(), ext.getULY()));

//                                        tile.setLr(new Point2D.Double(ext.getLRX(), ext.getLRY()));

//                                        tile.setData(new Object[]{buf, null, null});

//                                        listener.tileReady(tile);

//                                } catch (GdalException e) {

//                                        throw new RasterDriverException("", e);

//                                } catch (IOException e) {

//                                        throw new RasterDriverException("", e);

//                                } catch (TileGettingException e) {

//                                        throw new RasterDriverException("", e);

//                                }

//                        }

//                }

                super.getWindow(ex, bufWidth, bufHeight, bandList, listener, status);

        }

        public Buffer getWindow(

                        Extent ex, 

                        BandList bandList, 

                        Buffer rasterBuf, 

                        TaskStatus status) 

                throws ProcessInterruptedException, RasterDriverException {

                return super.getWindow(ex, bandList, rasterBuf, status);

        }

        public Buffer getWindow(

                        double ulx, 

                        double uly, 

                        double w, 

                        double h, 

                        BandList bandList, 

                        Buffer rasterBuf, 

                        boolean adjustToExtent, 

                        TaskStatus status) throws ProcessInterruptedException, RasterDriverException {

                return super.getWindow(ulx, uly, w, h, bandList, rasterBuf, adjustToExtent, status);

        }

        public Buffer getWindow(

                        Extent extent, 

                        int bufWidth, 

                        int bufHeight, 

                        BandList bandList, 

                        Buffer rasterBuf, 

                        boolean adjustToExtent, 

                        TaskStatus status) throws ProcessInterruptedException, RasterDriverException {

                try {

                        readOverviews();

                } catch (DataException e) {

                        throw new RasterDriverException("Overviews can't be read", e);

                }

                overviewSelector(bufWidth, extent.width());

                //Creamos un BandList con todas las bandas del fichero

                BandList bl = new BandListImpl();

                for(int i = 0; i < getBandCount(); i++) {

                        try {

                                FileUtils fUtil = RasterLocator.getManager().getFileUtils(); 

                                DatasetBand band = new DatasetBandImpl(fUtil.getFormatedRasterFileName(selectedProvider.getDataParameters().getURI()), i, getDataType()[i], getBandCount());

                                bl.addBand(band);

                        } catch(BandNotFoundInListException e) {

                                //No a?adimos la banda

                        }

                }

                bl.setDrawableBands(bandList.getDrawableBands());

                DefaultRasterQuery q = (DefaultRasterQuery)RasterLocator.getManager().createQuery();

                q.setAreaOfInterest(extent, bufWidth, bufHeight);

                q.setBandList(bl);

                q.setBuffer(rasterBuf);

                q.setAdjustToExtent(adjustToExtent);

                q.setTaskStatus(status);

                return selectedProvider.getDataSet(q);

        }

        public Buffer getWindow(

                        int x, 

                        int y, 

                        int w, 

                        int h, 

                        int bufWidth, 

                        int bufHeight, 

                        BandList bandList, 

                        Buffer rasterBuf, 

                        TaskStatus status) throws ProcessInterruptedException, RasterDriverException {

                return super.getWindow(x, y, w, h, bandList, rasterBuf, status);

        }

        /**

         * When the remote layer has fixed size this method downloads the file and return its reference. 

         * File layer has in the long side FIXED_SIZE pixels and the bounding box is complete. This file could be

         * useful to build an histogram or calculate statistics. This represents a sample of data.

         * @return

         * @throws RasterDriverException

         */

        public File getFileLayer() throws RasterDriverException {

                return null;

        }

        public File getLastRequest() {

                return null;

        }

        public Buffer getBufferLastRequest() throws ProcessInterruptedException,

                        RasterDriverException {

                return null;

        }

        public Rectangle2D getLayerExtent(String layerName, String srs)

                        throws RemoteServiceException {

                return null;

        }

        /**

         * Gets the name of a raster file

         */

        private String getTableName(String name) {

                String newName = "";

                String schema = null;

                String table = null;

                int index = name.indexOf(" schema='") + 8;

                if(index != -1) {

                        try {

                                schema = name.substring(index + 1, name.indexOf("'", index + 1)); 

                                newName += schema + ".";

                        } catch (StringIndexOutOfBoundsException e) {

                        }

                }

                index = name.indexOf(" table='") + 7;

                if(index != -1) {

                        try {

                                table = name.substring(index + 1, name.indexOf("'", index + 1));

                                newName += table;

                        } catch (StringIndexOutOfBoundsException e) {

                        }

                }

                return newName;

        }

        public TileServer getTileServer() {

                if(tileServer == null)

                        tileServer = new PostGISRasterTileServer(this);

                return tileServer;

        }

}