org.openstreetmap.gui.jmapviewer.interfaces

Interface TileSource

All Superinterfaces:

Attributed

All Known Subinterfaces:

TemplatedTileSource

All Known Implementing Classes:

AbstractOsmTileSource, AbstractTileSource, AbstractTMSTileSource, AbstractWMSTileSource, BingAerialTileSource, CachedAttributionBingAerialTileSource, OsmTileSource.CycleMap, OsmTileSource.Mapnik, ScanexTileSource, TemplatedTMSTileSource, TemplatedWMSTileSource, TMSTileSource, WMTSTileSource

public interface TileSource
extends Attributed

Method Summary

Modifier and Type	Method and Description
int	getDefaultTileSize()
double	getDistance(double la1, double lo1, double la2, double lo2) Gets the distance using Spherical law of cosines.
java.lang.String	getId() A unique id for this tile source.
int	getMaxZoom() Specifies the maximum zoom value.
java.util.Map<java.lang.String,java.lang.String>	getMetadata(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers) Extracts metadata about the tile based on HTTP headers
int	getMinZoom() Specifies the minimum zoom value.
java.lang.String	getName() A tile layer name as displayed to the user.
java.lang.String	getTileId(int zoom, int tilex, int tiley) Creates tile identifier that is unique among all tile sources, but the same tile will always get the same identifier.
int	getTileSize() Specifies how large each tile is.
java.lang.String	getTileUrl(int zoom, int tilex, int tiley) Constructs the tile url.
int	getTileXMax(int zoom)
int	getTileXMin(int zoom)
int	getTileYMax(int zoom)
int	getTileYMin(int zoom)
boolean	isNoTileAtZoom(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers, int statusCode, byte[] content) Determines, if the returned data from TileSource represent "no tile at this zoom level" situation.
TileXY	latLonToTileXY(double lat, double lon, int zoom)
TileXY	latLonToTileXY(ICoordinate point, int zoom)
java.awt.Point	latLonToXY(double lat, double lon, int zoom)
java.awt.Point	latLonToXY(ICoordinate point, int zoom)
ICoordinate	tileXYToLatLon(int x, int y, int zoom)
ICoordinate	tileXYToLatLon(Tile tile)
ICoordinate	tileXYToLatLon(TileXY xy, int zoom)
ICoordinate	xyToLatLon(int x, int y, int zoom)
ICoordinate	xyToLatLon(java.awt.Point point, int zoom)

Methods inherited from interface org.openstreetmap.gui.jmapviewer.interfaces.Attributed

getAttributionImage, getAttributionImageURL, getAttributionLinkURL, getAttributionText, getTermsOfUseText, getTermsOfUseURL, requiresAttribution

Method Detail

getMaxZoom

int getMaxZoom()

Specifies the maximum zoom value. The number of zoom levels is [0.. getMaxZoom()].

Returns:

maximum zoom value that has to be smaller or equal to JMapViewer.MAX_ZOOM

getMinZoom

int getMinZoom()

Specifies the minimum zoom value. This value is usually 0. Only for maps that cover a certain region up to a limited zoom level this method should return a value different than 0.

Returns:

minimum zoom value - usually 0

getName

java.lang.String getName()

A tile layer name as displayed to the user.

Returns:

Name of the tile layer

getId

java.lang.String getId()

A unique id for this tile source. Unlike the name it has to be unique and has to consist only of characters valid for filenames.

Returns:

the id

getTileUrl

java.lang.String getTileUrl(int zoom,
                            int tilex,
                            int tiley)
                     throws java.io.IOException

Constructs the tile url.

Parameters:

zoom - zoom level

tilex - X coordinate

tiley - Y coordinate

Returns:

fully qualified url for downloading the specified tile image

Throws:

java.io.IOException - if any I/O error occurs

getTileId

java.lang.String getTileId(int zoom,
                           int tilex,
                           int tiley)

Creates tile identifier that is unique among all tile sources, but the same tile will always get the same identifier. Used for creation of cache key.

Parameters:

zoom - zoom level

tilex - X coordinate

tiley - Y coordinate

Returns:

tile identifier

getTileSize

int getTileSize()

Specifies how large each tile is.

Returns:

The size of a single tile in pixels. -1 if default size should be used

getDefaultTileSize

int getDefaultTileSize()

Returns:

default tile size, for this tile source TODO: @since

getDistance

double getDistance(double la1,
                   double lo1,
                   double la2,
                   double lo2)

Gets the distance using Spherical law of cosines.

Parameters:

la1 - latitude of first point

lo1 - longitude of first point

la2 - latitude of second point

lo2 - longitude of second point

Returns:

the distance betwen first and second point, in m.

latLonToXY

java.awt.Point latLonToXY(double lat,
                          double lon,
                          int zoom)

Parameters:

lon - longitude

lat - latitude

zoom - zoom level

Returns:

transforms longitude and latitude to pixel space (as if all tiles at specified zoom level where joined)

latLonToXY

java.awt.Point latLonToXY(ICoordinate point,
                          int zoom)

Parameters:

point - point

zoom - zoom level

Returns:

transforms longitude and latitude to pixel space (as if all tiles at specified zoom level where joined)

xyToLatLon

ICoordinate xyToLatLon(java.awt.Point point,
                       int zoom)

Parameters:

point - point

zoom - zoom level

Returns:

WGS84 Coordinates of given point

xyToLatLon

ICoordinate xyToLatLon(int x,
                       int y,
                       int zoom)

Parameters:

x - X coordinate

y - Y coordinate

zoom - zoom level

Returns:

WGS84 Coordinates of given point

latLonToTileXY

TileXY latLonToTileXY(double lat,
                      double lon,
                      int zoom)

Parameters:

lon - longitude

lat - latitude

zoom - zoom level

Returns:

x and y tile indices

latLonToTileXY

TileXY latLonToTileXY(ICoordinate point,
                      int zoom)

Parameters:

point - point

zoom - zoom level

Returns:

x and y tile indices

tileXYToLatLon

ICoordinate tileXYToLatLon(TileXY xy,
                           int zoom)

Parameters:

xy - X/Y coordinates

zoom - zoom level

Returns:

WGS84 coordinates of given tile

tileXYToLatLon

ICoordinate tileXYToLatLon(Tile tile)

Parameters:

tile - Tile

Returns:

WGS84 coordinates of given tile

tileXYToLatLon

ICoordinate tileXYToLatLon(int x,
                           int y,
                           int zoom)

Parameters:

x - X coordinate

y - Y coordinate

zoom - zoom level

Returns:

WGS84 coordinates of given tile

getTileXMax

int getTileXMax(int zoom)

Parameters:

zoom - zoom level

Returns:

maximum X index of tile for specified zoom level

getTileXMin

int getTileXMin(int zoom)

Parameters:

zoom - zoom level

Returns:

minimum X index of tile for specified zoom level

getTileYMax

int getTileYMax(int zoom)

Parameters:

zoom - zoom level

Returns:

maximum Y index of tile for specified zoom level

getTileYMin

int getTileYMin(int zoom)

Parameters:

zoom - zoom level

Returns:

minimum Y index of tile for specified zoom level

isNoTileAtZoom

boolean isNoTileAtZoom(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers,
                       int statusCode,
                       byte[] content)

Determines, if the returned data from TileSource represent "no tile at this zoom level" situation. Detection algorithms differ per TileSource, so each TileSource should implement each own specific way.

Parameters:

headers - HTTP headers from response from TileSource server

statusCode - HTTP status code

content - byte array representing the data returned from the server

Returns:

true, if "no tile at this zoom level" situation detected

getMetadata

java.util.Map<java.lang.String,java.lang.String> getMetadata(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers)

Extracts metadata about the tile based on HTTP headers

Parameters:

headers - HTTP headers from Tile Source server

Returns:

tile metadata