TileStoreTileSource.java

/* The MIT License (MIT)
 *
 * Copyright (c) 2015 Reinventing Geospatial, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.rgi.view;

import java.awt.Image;
import java.io.IOException;

import org.openstreetmap.gui.jmapviewer.Coordinate;
import org.openstreetmap.gui.jmapviewer.OsmMercator;
import org.openstreetmap.gui.jmapviewer.interfaces.TileSource;

import com.rgi.common.Dimensions;
import com.rgi.common.coordinate.CoordinateReferenceSystem;
import com.rgi.common.coordinate.CrsCoordinate;
import com.rgi.common.coordinate.referencesystem.profile.GlobalGeodeticCrsProfile;
import com.rgi.common.tile.TileOrigin;
import com.rgi.common.tile.scheme.TileScheme;
import com.rgi.common.tile.scheme.ZoomTimesTwo;
import com.rgi.store.tiles.TileStoreException;
import com.rgi.store.tiles.TileStoreReader;

/**
 * Connect jmapviewer code with SWAGD code for viewing tile stores in a map viewer.
 *
 * @author Steven D. Lander
 */
public class TileStoreTileSource  implements TileSource
{
    private final TileStoreReader tileStore;

    private final int minimumZoomLevel;
    private final int maximumZoomLevel;
    private final GlobalGeodeticCrsProfile globalGeodeticCrs = new GlobalGeodeticCrsProfile();
    private final CoordinateReferenceSystem globalGeodetic   = this.globalGeodeticCrs.getCoordinateReferenceSystem();
    private final static TileOrigin Origin     = TileOrigin.UpperLeft;           // Tile Origin for JMapViewer
    private final static TileScheme TileScheme = new ZoomTimesTwo(0, 31, 1, 1);  // Tile scheme for JMapViewer: http://wiki.openstreetmap.org/wiki/Slippy_Map
    private final int tileSize;
    /**
     * @param tileStore The tile store that will be viewed.
     * @throws TileStoreException Thrown when the tile store is not supported or is invalid.
     */
    public TileStoreTileSource(final TileStoreReader tileStore) throws TileStoreException
    {
        this.tileStore = tileStore;

        this.minimumZoomLevel = tileStore.getZoomLevels().stream().min(Integer::compare).orElse(-1);
        this.maximumZoomLevel = tileStore.getZoomLevels().stream().max(Integer::compare).orElse(-1);
        final Dimensions<Integer> tileDimensions = this.tileStore.getImageDimensions();

        if(tileDimensions == null)
        {
            throw new IllegalArgumentException("Tile Dimensions cannot be null");
        }

        this.tileSize = tileDimensions.getWidth();
    }

    @Override
    public boolean requiresAttribution()
    {
        return false;
    }

    @Override
    public String getAttributionText(final int zoom, final Coordinate topLeft, final Coordinate botRight)
    {
        return null;
    }

    @Override
    public String getAttributionLinkURL()
    {
        return null;
    }

    @Override
    public Image getAttributionImage()
    {
        return null;
    }

    @Override
    public String getAttributionImageURL()
    {
        return null;
    }

    @Override
    public String getTermsOfUseText()
    {
        return null;
    }

    @Override
    public String getTermsOfUseURL()
    {
        return null;
    }

    @Override
    public int getMaxZoom()
    {
        return this.maximumZoomLevel;
    }

    @Override
    public int getMinZoom()
    {
        return this.minimumZoomLevel;
    }

    @Override
    public TileUpdate getTileUpdate()
    {
        return TileUpdate.None; // The "server" does not support any of the other update mechanisms
    }

    @Override
    public String getName()
    {
        return this.tileStore.getName();
    }

    @Override
    public String getTileUrl(final int zoom, final int tilex, final int tiley) throws IOException
    {
        return null;
    }

    @Override
    public String getTileType()
    {
        try
        {
            return this.tileStore.getImageType();
        }
        catch(final TileStoreException ex)
        {
            ex.printStackTrace();
            return null;
        }
    }

    @Override
    public int getTileSize()
    {
        return this.tileSize;
    }

    @Override
    public double getDistance(final double lat1, final double lon1, final double lat2, final double lon2) {
        return OsmMercator.getDistance(lat1, lon1, lat2, lon2);
    }

    @Override
    public int LonToX(final double lon, final int zoom) {
        return (int )OsmMercator.LonToX(lon, zoom);
    }

    @Override
    public int LatToY(final double lat, final int zoom) {
        return (int )OsmMercator.LatToY(lat, zoom);
    }

    @Override
    public double XToLon(final int x, final int zoom) {
        return OsmMercator.XToLon(x, zoom);
    }

    @Override
    public double YToLat(final int y, final int zoom) {
        return OsmMercator.YToLat(y, zoom);
    }


    @Override
    public double lonToTileX(final double lon, final int zoom)
    {
        final CrsCoordinate crsCoordinate = new CrsCoordinate(lon, 0, this.globalGeodetic);
        final int tileX = this.globalGeodeticCrs.crsToTileCoordinate(crsCoordinate, this.globalGeodeticCrs.getBounds(), TileStoreTileSource.TileScheme.dimensions(zoom) , TileStoreTileSource.Origin).getX();
        return tileX;
    }

    @Override
    public double latToTileY(final double lat, final int zoom)
    {
        final CrsCoordinate crsCoordinate = new CrsCoordinate(lat, 0, this.globalGeodetic);
        final int tileY = this.globalGeodeticCrs.crsToTileCoordinate(crsCoordinate, this.globalGeodeticCrs.getBounds(), TileStoreTileSource.TileScheme.dimensions(zoom) , TileStoreTileSource.Origin).getY();
        return tileY;
    }

    @Override
    public double tileXToLon(final int x, final int zoom)
    {

        final double longitude = this.globalGeodeticCrs.tileToCrsCoordinate(x, 0, this.globalGeodeticCrs.getBounds(), TileStoreTileSource.TileScheme.dimensions(zoom) , TileStoreTileSource.Origin).getX();

        return longitude;
    }

    @Override
    public double tileYToLat(final int y, final int zoom)
    {
        // TODO Auto-generated method stub
        final double latitude = this.globalGeodeticCrs.tileToCrsCoordinate(0, y, this.globalGeodeticCrs.getBounds(), TileStoreTileSource.TileScheme.dimensions(zoom) , TileStoreTileSource.Origin).getY();
        return latitude;
    }

    @Override
    public String getId()
    {
        return this.tileStore.getName();
    }


}