gvSIG data provider for OpenStreetMap (raster)

org.gvsig.raster.osm.io.DefaultOSMIOLibrary

/* OSM layers for gvSIG.

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

*

* 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.osm.downloader;

import java.io.BufferedOutputStream;

import java.io.DataInputStream;

import java.io.DataOutputStream;

import java.io.File;

import java.io.FileOutputStream;

import java.net.HttpURLConnection;

import java.net.MalformedURLException;

import java.net.URI;

import java.net.URISyntaxException;

import java.net.URL;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.compat.net.ICancellable;

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

import org.gvsig.raster.cache.tile.Tile;

import org.gvsig.raster.cache.tile.exception.TileGettingException;

import org.gvsig.raster.impl.provider.tile.BaseTileDownloader;

import org.gvsig.raster.osm.io.OSMDataParameters;

/**

 * Tile getter for Open Street Map

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

 */

public class TileDownloaderForOSM extends BaseTileDownloader {

	private String server   = null;

	private String suffix   = null;

	private String slash    = "/";

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

	public TileDownloaderForOSM(RasterDataStore store,

			int tileSize) {

		super(store, tileSize, tileSize);

		server = ((OSMDataParameters)store.getParameters()).getURI().toString();

		suffix = ((OSMDataParameters)store.getParameters()).getTileSuffix();

	}

	public synchronized Tile downloadTile(Tile tile) throws TileGettingException {

		int level = tile.getLevel();

		int y = tile.getRow();

		int x = tile.getCol();

		try {

			String stringUri = server +

            (server.endsWith(slash) ? "" : slash) +

            level + slash +

            x + slash +

            y + "." + suffix;

			//logger.info("OSM URI = "+stringUri);

            URI uri = new URI(stringUri);

			URL url = uri.toURL();

            downloadFile(url, tile.getFile(), tile.getCancelled());

		} catch (MalformedURLException e) {

			throw new TileGettingException(e);

		} catch (URISyntaxException e) {

			throw new TileGettingException(e);

		}

		readTileFromDisk(tile);

		return tile;

	}

	 public synchronized void downloadFile(URL url, File file, ICancellable cancel) throws TileGettingException {

	    	int IO_BUFFER_SIZE = 8 * 1024;

			int timeout =  30000;

			DataOutputStream dos;

			try {

				DataInputStream is;

				HttpURLConnection connection = null;

				connection = (HttpURLConnection)url.openConnection();

				connection.setConnectTimeout(timeout);

				is = new DataInputStream(url.openStream());

				dos = new DataOutputStream( new BufferedOutputStream(new FileOutputStream(file)));

				byte[] buffer = new byte[IO_BUFFER_SIZE];

				int read;

				while ((read = is.read(buffer)) != -1) {

					dos.write(buffer, 0, read);

					if(cancel != null && cancel.isCanceled())

						return;

				}

				dos.close();

				is.close();

				is = null;

				dos = null;

			} catch (Exception e) {

				throw new TileGettingException(e);

			}

	    }

}

/* OSM layers for gvSIG. 

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

* 

* 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.osm.downloader;

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

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

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

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

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

import org.gvsig.raster.osm.cachestruct.OSMCacheStruct;

import org.gvsig.raster.osm.io.OSMDataParameters;

/** 

* Data server for the tile cache in a OSMProvider 

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

*/

public class OSMTileServer implements TileServer {

	private CacheStruct                struct               = null;

	private Downloader                 downloader           = null;

	private RasterDataStore            store                = null;

	private String                     suffix               = null;

	private int                        tileSize             = 256;

	private int                        levels               = 0;

	/**

	 * Creates a OSMTileServer

	 * @param prov

	 * @param suffix

	 * 			it depends on the layer

	 * @param levels

	 * 			it depends on the layer

	 */

	public OSMTileServer(RasterDataStore store, String suffix, int levels) {

		this.store = store;

		this.suffix = suffix;

		this.levels = levels;

	}

	public Downloader getDownloader() {

		if(downloader == null) {

			downloader = new TileDownloaderForOSM(store, getStruct().getTileSizeByLevel(0)[0]);

		}

		return downloader;

	}

	public CacheStruct getStruct() {

		if(struct == null) {

			struct = new OSMCacheStruct(levels, 

					tileSize, 

					tileSize, 

					((OSMDataParameters)store.getParameters()).getOSMLayerName(), 

					RasterLibrary.pathTileCache, 

					suffix, 

					0);

		}

		return struct;

	}

	public void setStruct(CacheStruct struct) {

		//La structura de cache es proporcionada por el servidor

	}

	public String getFileSuffix() {

		return suffix;

	}

	public void setFileSuffix(String extension) {

		this.suffix = extension;

	}

}

/* OSM layers for gvSIG. 

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

* 

* 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.osm.io;

import java.util.List;

import org.gvsig.compat.net.ICancellable;

import org.gvsig.fmap.dal.DataServerExplorerParameters;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.NewDataStoreParameters;

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

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

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

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

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

public class OSMServerExplorer {

	public static final String NAME       = OSMProvider.NAME;

	public String getProviderName() {

		return OSMProvider.NAME;

	}

	public boolean canAdd() {

		return false;

	}

	public boolean canAdd(String storeName) throws DataException {

		return false;

	}

	public List<?> list() throws DataException {

		return null;

	}

	public List<?> list(int mode) throws DataException {

		return null;

	}

	public boolean add(String provider, NewDataStoreParameters parameters,

			boolean overwrite) throws DataException {

		return false;

	}

	public void remove(DataStoreParameters parameters) throws DataException {

	}

	public NewDataStoreParameters getAddParameters(String storeName)

			throws DataException {

		return null;

	}

	public DataServerExplorerParameters getParameters() {

		return null;

	}

	public List<?> getDataStoreProviderNames() {

		return null;

	}

	public void dispose() {

	}

	public DataServerExplorerProviderServices getServerExplorerProviderServices() {

		return null;

	}

	public DataStoreParameters getStoredParameters() {

		return null;

	}

	public void connect(ICancellable cancellable) throws ConnectException {

	}

	public boolean isHostReachable(int timeout) {

		return false;

	}

	public boolean isHostReachable() {

		return isHostReachable(RasterDataServerExplorer.TIME);

	}

}

/* OSM layers for gvSIG.

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

*

* 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.osm.io;

import java.awt.geom.AffineTransform;

import java.io.File;

import java.net.URI;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.crs.CRSFactory;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataStore;

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.metadata.MetadataLocator;

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

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

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

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

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

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

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

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

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

import org.gvsig.raster.osm.cachestruct.OSMCacheStruct;

import org.gvsig.raster.osm.downloader.OSMTileServer;

import org.gvsig.tools.ToolsLocator;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Data provider for OSM servers

 *

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

 */

public class OSMProvider extends AbstractRasterProvider {

	public static String                     NAME                     = "OSM Raster";

	public static String                     DESCRIPTION              = "OSM Raster Server";

	public final String                      METADATA_DEFINITION_NAME = NAME;

	private Extent                           viewRequest              = null;

	private TileServer                       tileServer               = null;

	private boolean                          open                     = false;

    private DataStoreTransparency            fileTransparency         = null;

    private static final Logger              logger                   = LoggerFactory.getLogger(OSMProvider.class);

	public static void register() {

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

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

			dataman.registerStoreProvider(NAME,

					OSMProvider.class, OSMDataParametersImpl.class);

		}

		dataman.registerStoreFactory(NAME, DefaultStoreFactory.class);

	}

	public OSMProvider() {

	}

	/**

	 * Opens the dataset.

	 * @param proj Projection

	 * @param fName File name

	 * @throws NotSupportedExtensionException

	 */

	public OSMProvider(String params) throws NotSupportedExtensionException, OpenException {

		super(params);

	}

	public OSMProvider (OSMDataParametersImpl params,

			DataStoreProviderServices storeServices) throws NotSupportedExtensionException, OpenException {

		super(params, storeServices, ToolsLocator.getDynObjectManager()

				.createDynObject(

						MetadataLocator.getMetadataManager().getDefinition(

								DataStore.METADATA_DEFINITION_NAME)));

		init(params, storeServices);

	}

	/**

	 * Build file references

	 * @param proj Projection

	 * @param param Load parameters

	 * @throws NotSupportedExtensionException

	 */

	public void init (OSMDataParametersImpl params,

			DataStoreProviderServices storeServices) throws NotSupportedExtensionException, OpenException {

		setParam(storeServices, params);

		setDataType(new int[]{Buffer.TYPE_BYTE, Buffer.TYPE_BYTE, Buffer.TYPE_BYTE, Buffer.TYPE_BYTE});

		bandCount = 4;

		super.init();

		fileSize = (long)(getWidth() * getHeight() * 3);

		Extent ext = getExtent();

		ownTransformation = new AffineTransform(

				ext.width() / getWidth(), 0,

				0, -(ext.height() / getHeight()),

				getExtent().getMin().getX(),

				getExtent().getMax().getY());

		externalTransformation = (AffineTransform)ownTransformation.clone();

		open = true;

	}

	public IProjection getProjection() {

		if(proj == null) {

			try {

				proj = CRSFactory.getCRS("EPSG:3857");

			} catch(Exception e) {

				logger.info("Projection not loaded", e);

			}

		}

		return proj;

	}

	/**

	 * Gets the bounding box in world coordinates.

	 * @return Extent

	 */

	public Extent getExtent() {

		return ((OSMCacheStruct)getTileServer().getStruct()).getWorldExtent();

	}

	/**

	 * Reloads metadata using the selected grid

	 */

	@SuppressWarnings("unused")

	private void reloadMetadataFromGrid() {

		//wktProjection = null;

		//CrsWkt crs = new CrsWkt(wktProjection);

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

		/*ownTransformation = new AffineTransform(

				scaleX, 0,

				0, -scaleY,

				pRect.getMinX(),

				pRect.getMaxY());*/

		externalTransformation = (AffineTransform)ownTransformation.clone();

		bandCount = 3;

		setDataType(new int[]{Buffer.TYPE_BYTE, Buffer.TYPE_BYTE, Buffer.TYPE_BYTE});

	}

	public RasterProvider load() {

		return this;

	}

	public boolean isOpen() {

		return open;

	}

	public void close() {

	}

	public URI translateURI(URI uri) {

		return uri;

	}

	public NoData getNoDataValue() {

		NoData nodata = super.getNoDataValue();

		if(nodata != null)

			nodata.setNoDataTransparent(false);

		return noData;

	}

	/**

	 * Asigna el extent de la vista actual. existe un fichero .rmf debemos hacer una transformaci�n

	 * de la vista asignada ya que la petici�n viene en coordenadas del fichero .rmf y la vista (v)

	 * ha de estar en coordenadas del fichero.

	 */

	public void setView(Extent e) {

		viewRequest = new ExtentImpl(e);

	}

	public Extent getView() {

		return viewRequest;

	}

	public double getWidth() {

		int n = getTileServer().getStruct().getNumberOfLevels() - 1;

		return getExtent().width() / getTileServer().getStruct().getPixelSizeByLevel(n);

	}

	public double getHeight() {

		int n = getTileServer().getStruct().getNumberOfLevels() - 1;

		return getExtent().width() / getTileServer().getStruct().getPixelSizeByLevel(n);

	}

	public Object readBlock(int pos, int blockHeight, double scale)

		throws InvalidSetViewException, FileNotOpenException, RasterDriverException, ProcessInterruptedException {

		return null;

	}

	public Object getData(int x, int y, int band)throws InvalidSetViewException, FileNotOpenException, RasterDriverException {

		return null;

	}

	public int getBlockSize(){

		return 0;

	}

	/**

	 * Informa de si el driver ha supersampleado en el �ltimo dibujado. Es el driver el que colocar�

	 * el valor de esta variable cada vez que dibuja.

	 * @return true si se ha supersampleado y false si no se ha hecho.

	 */

	public boolean isSupersampling() {

		return false;

	}

	public void setAffineTransform(AffineTransform t){

		super.setAffineTransform(t);

	}

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

		if(band >= getBandCount())

			throw new BandAccessException("Wrong band");

		return 0;

	}

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

		if (band >= getBandCount())

			throw new BandAccessException("Wrong band");

		return 0;

	}

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

		if (band >= getBandCount())

			throw new BandAccessException("Wrong band");

		return 0;

	}

	public boolean isOverviewsSupported() {

		return true;

	}

	public boolean isReproyectable() {

		return true;

	}

	public String getProviderName() {

		return NAME;

	}

    public String getName() {

        return this.getParameters().getOSMLayerName();

    }

    @Override

    public String getFullName() {

        return this.uri.toString();

    }

	public OSMDataParameters getParameters() {

		return (OSMDataParameters)this.param;

	}

	public DataStoreTransparency getTransparency() {

		if(fileTransparency == null)

			fileTransparency = new DataStoreTransparency(getColorInterpretation());

		return fileTransparency;

	}

	public ColorInterpretation getColorInterpretation() {

		if(super.getColorInterpretation() == null) {

			super.setColorInterpretation(DataStoreColorInterpretation.createRGBInterpretation());

		}

		return super.getColorInterpretation();

	}

	public void setStatus(RasterProvider provider) {

		if(provider instanceof OSMProvider) {

			//Not implemented yet

		}

	}

	public boolean isTimeSupported() {

		return true;

	}

	public boolean isTiled() {

		return true;

	}

	public TileServer getTileServer() {

		if(tileServer == null) {

			DefaultRasterStore store = new DefaultRasterStore();

			store.setProvider(this);

			tileServer = new OSMTileServer(store,

					((OSMDataParameters)param).getTileSuffix(),

					((OSMDataParameters)param).getNumberOfLevels());

		}

		return tileServer;

	}

	@Override

	public void loadBuffer(SpiRasterQuery query)

			throws ProcessInterruptedException, RasterDriverException {

	}

    /* (non-Javadoc)

     * @see org.gvsig.raster.impl.provider.RasterProvider#addFile(java.io.File)

     */

    @Override

    public void addFile(File file) throws InvalidSourceException {

        // Do nothing

    }

    /* (non-Javadoc)

     * @see org.gvsig.raster.impl.provider.RasterProvider#removeFile(java.io.File)

     */

    @Override

    public void removeFile(File file) {

        // Do nothing

    }

    /* (non-Javadoc)

     * @see org.gvsig.raster.impl.provider.AbstractRasterProvider#getFileSuffix()

     */

    @Override

    public String getFileSuffix() {

        return ((OSMDataParameters)getDataParameters()).getTileSuffix();

    }

}

/* OSM layers for gvSIG.

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

*

* 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.osm.io;

import java.net.URI;

/**

 * Parameters for the WMS provider

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

 */

public interface OSMDataParameters {

    public void setURI(URI uri);

	public URI getURI();

	public int getWidth();

	public int getHeight();

	public void setWidth(int w);

	public void setHeight(int h);

	public String getOSMLayerName();

	public void setOSMLayerName(String name);

	public int getNumberOfLevels();

	public void setNumberOfLevels(int levels);

	public String getTileSuffix();

	public void setTileSuffix(String suffix);

}

/* OSM layers for gvSIG. 

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

* 

* 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.osm.io;

import java.util.Hashtable;

import java.util.Map;

/**

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

 */

public class OSMException extends Exception {

    private static final long serialVersionUID = 1476084093500156070L;

    private String            wmtsCode         = null;

    protected String          formatString     = null;

    protected String          messageKey       = null;

    protected long            code             = 0;

    public OSMException() {		

        init();			

    }	

    public OSMException(Throwable cause) {	

    	super(cause);

        init();	

        initCause(cause);

    }

    public OSMException(String msg, Throwable cause) {	

    	super(msg, cause);

        init();	

        this.formatString = msg;

    }

    public OSMException(String wfsCode,String message) {		

        init();	

        formatString = message;

        this.wmtsCode = wfsCode;

    }	

    public OSMException(String message) {        

        init(); 

        formatString = message;       

    }   

	@SuppressWarnings("unchecked")

	protected Map values() {		

        Hashtable params;

        params = new Hashtable();		

        return params;

    }

    public void init() {

        messageKey = "wmts_exception";

        formatString = "WMTS Exception";

        code = serialVersionUID;

    }

    /**

     * @return Returns the wfsCode.

     */

    public String getWfsCode() {

        return wmtsCode;

    }	

}

/* OSM layers for gvSIG. 

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

* 

* 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.osm.io;

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

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

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

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dynobject.DelegatedDynObject;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.persistence.PersistenceManager;

/**

 * Parameters for OSM provider

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

 */

public class OSMDataParametersImpl extends AbstractRasterDataParameters implements OSMDataParameters {

	private DelegatedDynObject            delegatedDynObject         = null;

	private static final String           FIELD_WIDTH                = "width";

	private static final String           FIELD_HEIGHT               = "height";

	private static final String           FIELD_MAX_RES_LEVEL        = "maxResolutionLevel";

	private static final String           FIELD_NAME                 = "name";

	private static final String           FIELD_SUFFIX               = "suffix";

	public OSMDataParametersImpl() {

		super();

		initialize();

	}

	protected void initialize() {

		this.delegatedDynObject = (DelegatedDynObject) ToolsLocator

				.getDynObjectManager().createDynObject(registerDynClass());

	}

	public static DynStruct registerDynClass() {

		PersistenceManager manager = ToolsLocator.getPersistenceManager();

		DynStruct definition = manager.getDefinition("OSMDataParameters_Persistent");

		if( definition == null ) {

			definition = manager.addDefinition(

					OSMDataParametersImpl.class,

					"OSMDataParameters_Persistent",

					"OSM DataParameters Persistency",

					null, 

					null

			);

		}

		AbstractRasterDataParameters.registerDynClass(definition);

		definition.addDynFieldInt(FIELD_MAX_RES_LEVEL)

		.setDescription("Maximun levels of resolution")

		.setMandatory(false);

		definition.addDynFieldInt(FIELD_WIDTH)

		.setDescription("Width")

		.setMandatory(false);

		definition.addDynFieldInt(FIELD_HEIGHT)

		.setDescription("Height")

		.setMandatory(false);

		definition.addDynFieldString(FIELD_NAME)

		.setDescription("Layer name")

		.setMandatory(false);		

		definition.addDynFieldString(FIELD_SUFFIX)

		.setDescription("Field suffix")

		.setMandatory(false);

		return definition;

	}

	public void assignFields(RasterDataParameters par, RasterDataServerExplorer explorer) {

		super.assignFields(par, explorer);

		OSMDataParameters p = null;

		if(par instanceof OSMDataParameters)

			p = (OSMDataParameters)par;

		else

			return;

		setTileSuffix(p.getTileSuffix());

		setOSMLayerName(p.getOSMLayerName());

		setWidth(p.getWidth());

		setHeight(p.getHeight());

		setNumberOfLevels(p.getNumberOfLevels());

	}

	public String getDataStoreName() {

		return OSMProvider.NAME;

	}

	public String getDescription() {

		return OSMProvider.DESCRIPTION;

	}

	@Override

	protected DelegatedDynObject getDelegatedDynObject() {

		return delegatedDynObject;

	}

	public boolean isOverridingHost() {

		return false;

	}

	public void setOverrideHost(boolean over) {

	}

	public void setWidth(int w) {

		this.setDynValue(FIELD_WIDTH, new Integer(w));

	}

	public void setHeight(int h) {

		this.setDynValue(FIELD_HEIGHT, new Integer(h));

	}

	public int getWidth() {

		Integer b = (Integer)getDynValue(FIELD_WIDTH);

		if(b != null)

			return ((Integer)b).intValue();

		return 0;

	}

	public int getHeight() {

		Integer b = (Integer)getDynValue(FIELD_HEIGHT);

		if(b != null)

			return ((Integer)b).intValue();

		return 0;

	}

	public String getOSMLayerName() {

		String b = (String)getDynValue(FIELD_NAME);

		if(b != null)

			return b;

		return null;

	}

	public void setOSMLayerName(String name) {

		this.setDynValue(FIELD_NAME, name);

	}

	public int getNumberOfLevels() {

		Integer b = (Integer)getDynValue(FIELD_MAX_RES_LEVEL);

		if(b != null)

			return ((Integer)b).intValue();

		return 0;

	}

	public void setNumberOfLevels(int levels) {

		this.setDynValue(FIELD_MAX_RES_LEVEL, new Integer(levels));

	}

	public String getTileSuffix() {

		String b = (String)getDynValue(FIELD_SUFFIX);

		if(b != null)

			return b;

		return null;

	}

	public void setTileSuffix(String suffix) {

		this.setDynValue(FIELD_SUFFIX, suffix);

	}

}

/* OSM layers for gvSIG. 

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

* 

* 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.osm.io;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

/**

 *

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

 */

public class DefaultOSMIOLibrary extends AbstractLibrary {	

	@Override

	protected void doInitialize() throws LibraryException {

	}

	@Override

	protected void doPostInitialize() throws LibraryException {

		OSMProvider.register();

		OSMDataParametersImpl.registerDynClass();

	}

}

/* OSM layers for gvSIG. 

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

* 

* 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.osm.cachestruct;

/**

 * Description of a tile matrix

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

 */

public class TileMatrix {

    private double                      scaleXDenominator    = 0;

    private double                      scaleYDenominator    = 0;

    private double[]                    topLeftCorner       = null;

    private int                         tileWidth           = 0;

    private int                         tileHeight          = 0;

    private long                        matrixWidth         = 0;

    private long                        matrixHeight        = 0;

    private static final double         MTS_X_GRADO         = 111319.490793274;

	public double getScaleXDenominator() {

		return scaleXDenominator;

	}

	public void setScaleXDenominator(double scaleXDenominator) {

		this.scaleXDenominator = scaleXDenominator;

	}

	public double getScaleYDenominator() {

		return scaleYDenominator;

	}

	public void setScaleYDenominator(double scaleYDenominator) {

		this.scaleYDenominator = scaleYDenominator;

	}

	public int getTileWidth() {

		return tileWidth;

	}

	public void setTileWidth(int tileWidth) {

		this.tileWidth = tileWidth;

	}

	public int getTileHeight() {

		return tileHeight;

	}

	public void setTileHeight(int tileHeight) {

		this.tileHeight = tileHeight;

	}

	public long getMatrixWidth() {

		return matrixWidth;

	}

	public void setMatrixWidth(long matrixWidth) {

		this.matrixWidth = matrixWidth;

	}

	public long getMatrixHeight() {

		return matrixHeight;

	}

	public void setMatrixHeight(long matrixHeight) {

		this.matrixHeight = matrixHeight;

	}

	public double[] getTopLeftCorner() {

		return topLeftCorner;

	}

	public void setTopLeftCorner(double[] topLeftCorner) {

		this.topLeftCorner = topLeftCorner;

	}

    /**

     * Gets the width in meters of a tile

     * @param projected

     * @return

     */

    public double getWidthMtsTile(boolean projected) {

    	if(!projected) {

    		return (scaleXDenominator * tileWidth * 0.28) / (MTS_X_GRADO * 1000);

    	} else {

    		return (scaleXDenominator * tileWidth * 0.28) / 1000;

    	}

    }

    /**

     * Gets the height in meters of a tile

     * @param projected

     * @return

     */

    public double getHeightMtsTile(boolean projected) {

    	if(!projected) {

    		return (scaleYDenominator * tileHeight * 0.28) / (MTS_X_GRADO * 1000);

    	} else {

    		return (scaleYDenominator * tileHeight * 0.28) / 1000;

    	}

    }

	public void print() {

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

		System.out.println("   scaleXDenominator:" + getScaleXDenominator());

		System.out.println("   scaleYDenominator:" + getScaleYDenominator());

		if(topLeftCorner != null)

			System.out.println("   topLeftCorner:" + topLeftCorner[0] + ", " + topLeftCorner[1]);

		System.out.println("   tileWidth:" + getTileWidth());

		System.out.println("   tileHeight:" + getTileHeight());

		System.out.println("   matrixWidth:" + getMatrixWidth());

		System.out.println("   matrixHeight:" + getMatrixHeight());

	}

}

/* OSM layers for gvSIG. 

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

* 

* 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.osm.cachestruct;

import java.awt.geom.Point2D;

/**

 * Limits of a tile matrix

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

 */

public class TileMatrixLimits {

	private TileMatrix             tileMatrix           = null;

	private int                    minTileRow           = 0;

	private int                    maxTileRow           = 0;

	private int                    minTileCol           = 0;

	private int                    maxTileCol           = 0;

	public TileMatrix getTileMatrix() {

		if(tileMatrix == null)

			tileMatrix = new TileMatrix();

		return tileMatrix;

	}

	/**

	 * Gets the upper left corner and the lower right corner of the 

	 * selected tile

	 * @param x X tile position

	 * @param y Y tile position

	 * @return

	 */

	public Point2D[] getTileExtent(int x, int y) {

		double sizeXTile = getTileMatrix().getTileWidth() * getTileMatrix().getScaleXDenominator();

		double sizeYTile = getTileMatrix().getTileWidth() * getTileMatrix().getScaleYDenominator();

		double initX = getTileMatrix().getTopLeftCorner()[0] + (sizeXTile * x);

		double initY = getTileMatrix().getTopLeftCorner()[1] - (sizeYTile * y);

		Point2D[] p = new Point2D[2];

		p[0] = new Point2D.Double(initX, initY);

		p[1] = new Point2D.Double(initX + sizeXTile, initY - sizeYTile);

		return p;

	}

	public int getMinTileRow() {

		return minTileRow;

	}

	public void setMinTileRow(int minTileRow) {

		this.minTileRow = minTileRow;

	}

	public int getMaxTileRow() {

		return maxTileRow;

	}

	public void setMaxTileRow(int maxTileRow) {

		this.maxTileRow = maxTileRow;

	}

	public int getMinTileCol() {

		return minTileCol;

	}

	public void setMinTileCol(int minTileCol) {

		this.minTileCol = minTileCol;

	}

	public int getMaxTileCol() {

		return maxTileCol;

	}

	public void setMaxTileCol(int maxTileCol) {

		this.maxTileCol = maxTileCol;

	}

	public void print() {

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

		System.out.println("  MaxTileCol:" + getMaxTileCol());

		System.out.println("  MaxTileRow:" + getMaxTileRow());

		System.out.println("  MinTileCol:" + getMinTileCol());

		System.out.println("  MinTileRow:" + getMinTileRow());

		if(tileMatrix != null)

			tileMatrix.print();

	}

}

/* OSM layers for gvSIG. 

 * Geographic Information System of the Valencian Government

*

* Copyright (C) 2012 Nacho Brodin

* 

* 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.osm.cachestruct;

import java.awt.geom.Point2D;

import java.awt.geom.Rectangle2D;

import java.util.ArrayList;

import java.util.List;

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

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

import org.gvsig.raster.cache.tile.Tile;

import org.gvsig.raster.cache.tile.TileCacheLocator;

import org.gvsig.raster.cache.tile.exception.TileBuildException;

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

/**

 * Implementation for a structure of a cache

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

 */

public class OSMCacheStruct implements CacheStruct {

    private TileMatrixSet                 tileMatrixSet  = null;

    private ArrayList<TileMatrixLimits>   limits         = null;

    private String                        layerName      = null;

	private Rectangle2D                   worldExtent    = null;

	private String                        fileSuffix     = null;

	private String                        epsg           = null;

	private long                          fileSize       = 0;

	private double                        realPixelSize  = 0;

    public OSMCacheStruct(int levels, 

    		int tilePxWidth,

    		int tilePxHeight,

    		String layerName,

    		String baseDir,

    		String fileSuffix,

    		long size) {

    	this.layerName = layerName;

    	this.fileSuffix = fileSuffix;

    	this.fileSize = size;

    	this.epsg = "EPSG:3857"; //WGS87 Pseudomercator

    	//Coordenadas del mundo en geogr?ficas y planas

    	//worldExtent = new Rectangle2D.Double(-180, -85.0511, 360, 170.1022); // arctan(sin(PI)) = 85.0511

    	//worldExtent = new Rectangle2D.Double(-180, -180, 360, 360);

    	worldExtent = new Rectangle2D.Double(-20037508, -20037508, 40075016, 40075016);

    	double[][] pixelSizeList = buildWorldMatrix(levels, tilePxWidth, tilePxHeight, worldExtent);

        buildLayerMatrix(levels, tilePxWidth, tilePxHeight, worldExtent, pixelSizeList);

    }

    private void buildLayerMatrix(int levels, 

    		int tilePxWidth, 

    		int tilePxHeight,

    		Rectangle2D worldExtent,

    		double[][] pixelSizeList) {

    	limits = new ArrayList<TileMatrixLimits>();

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

    		//Calculo de tiles para ese nivel en la capa actual

    		int minTileCol = 0;

    		int minTileRow = 0;

    		int maxTileCol = (i == 0) ? 0 : (int)Math.pow(2, i) - 1;

    		int maxTileRow = (i == 0) ? 0 : (int)Math.pow(2, i) - 1;

    		TileMatrixLimits limit = new TileMatrixLimits();

    		limit.setMinTileRow(minTileRow);

    		limit.setMinTileCol(minTileCol);

    		limit.setMaxTileRow(maxTileRow);

    		limit.setMaxTileCol(maxTileCol);

    		//Calcula las coordenadas de la esquina superior izquierda del TileMatrixLimits

    		double ulx = worldExtent.getMinX() + (minTileCol * tilePxWidth * pixelSizeList[0][i]);

    		double uly = worldExtent.getMaxY() - (minTileRow * tilePxHeight * pixelSizeList[1][i]);

    		limit.getTileMatrix().setTopLeftCorner(new double[]{ulx, uly});

    		limit.getTileMatrix().setScaleXDenominator(pixelSizeList[0][i]);

    		limit.getTileMatrix().setScaleYDenominator(pixelSizeList[1][i]);

    		limit.getTileMatrix().setTileWidth(tilePxWidth);

    		limit.getTileMatrix().setTileHeight(tilePxHeight);

    		limits.add(limit);

    	}

    }

    private double[][] buildWorldMatrix(int levels, 

    		int tilePxWidth,