org.openstreetmap.gui.jmapviewer.tilesources

Class AbstractTMSTileSource

java.lang.Object

org.openstreetmap.gui.jmapviewer.tilesources.AbstractTileSource

org.openstreetmap.gui.jmapviewer.tilesources.AbstractTMSTileSource

All Implemented Interfaces:

Attributed, TileSource

Direct Known Subclasses:

AbstractOsmTileSource, BingAerialTileSource, TMSTileSource

public abstract class AbstractTMSTileSource
extends AbstractTileSource

Class generalizing all tile based tile sources

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseUrl
protected String	id
private Map<String,String>	metadataHeaders
protected String	name
private Map<String,String>	noTileHeaders
protected OsmMercator	osmMercator
protected int	tileSize

Fields inherited from class org.openstreetmap.gui.jmapviewer.tilesources.AbstractTileSource

attributionImage, attributionImageURL, attributionLinkURL, attributionText, termsOfUseText, termsOfUseURL

Constructor Summary

Constructors

Constructor and Description
AbstractTMSTileSource(TileSourceInfo info) Creates an instance based on TileSource information

Method Summary

Modifier and Type	Method and Description
String	getBaseUrl()
int	getDefaultTileSize()
double	getDistance(double lat1, double lon1, double lat2, double lon2) Gets the distance using Spherical law of cosines.
String	getExtension()
String	getId() A unique id for this tile source.
int	getMaxZoom() Specifies the maximum zoom value.
Map<String,String>	getMetadata(Map<String,List<String>> headers) Extracts metadata about the tile based on HTTP headers
int	getMinZoom() Specifies the minimum zoom value.
String	getName() A tile layer name as displayed to the user.
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.
private static int	getTileMax(int zoom)
String	getTilePath(int zoom, int tilex, int tiley)
int	getTileSize() Specifies how large each tile is.
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(Map<String,List<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)
Point	latLonToXY(double lat, double lon, int zoom)
Point	latLonToXY(ICoordinate point, int zoom)
ICoordinate	tileXYToLatLon(int x, int y, int zoom)
ICoordinate	tileXYToLatLon(Tile tile)
ICoordinate	tileXYToLatLon(TileXY xy, int zoom)
String	toString()
ICoordinate	xyToLatLon(int x, int y, int zoom)
ICoordinate	xyToLatLon(Point point, int zoom)

Methods inherited from class org.openstreetmap.gui.jmapviewer.tilesources.AbstractTileSource

getAttributionImage, getAttributionImageURL, getAttributionLinkURL, getAttributionText, getTermsOfUseText, getTermsOfUseURL, requiresAttribution, setAttributionImage, setAttributionImageURL, setAttributionLinkURL, setAttributionText, setTermsOfUseText, setTermsOfUseURL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

protected String name

baseUrl

protected String baseUrl

id

protected String id

noTileHeaders

private final Map<String,String> noTileHeaders

metadataHeaders

private final Map<String,String> metadataHeaders

tileSize

protected int tileSize

osmMercator

protected OsmMercator osmMercator

Constructor Detail

AbstractTMSTileSource

public AbstractTMSTileSource(TileSourceInfo info)

Creates an instance based on TileSource information

Parameters:

info - description of the Tile Source

Method Detail

getDefaultTileSize

public int getDefaultTileSize()

Returns:

default tile size to use, when not set in Imagery Preferences

getName

public String getName()

Description copied from interface: TileSource

A tile layer name as displayed to the user.

Returns:

Name of the tile layer

getId

public String getId()

Description copied from interface: TileSource

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

getMaxZoom

public int getMaxZoom()

Description copied from interface: TileSource

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

Returns:

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

getMinZoom

public int getMinZoom()

Description copied from interface: TileSource

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

getExtension

public String getExtension()

Returns:

image extension, used for URL creation

getTilePath

public String getTilePath(int zoom,
                          int tilex,
                          int tiley)
                   throws IOException

Parameters:

zoom - level of the tile

tilex - tile number in x axis

tiley - tile number in y axis

Returns:

String containg path part of URL of the tile

Throws:

IOException - when subclass cannot return the tile URL

getBaseUrl

public String getBaseUrl()

Returns:

Base part of the URL of the tile source

getTileUrl

public String getTileUrl(int zoom,
                         int tilex,
                         int tiley)
                  throws IOException

Description copied from interface: TileSource

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:

IOException - if any I/O error occurs

toString

public String toString()

Overrides:

toString in class Object

getTileSize

public int getTileSize()

Description copied from interface: TileSource

Specifies how large each tile is.

Returns:

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

getDistance

public double getDistance(double lat1,
                          double lon1,
                          double lat2,
                          double lon2)

Description copied from interface: TileSource

Gets the distance using Spherical law of cosines.

Parameters:

lat1 - latitude of first point

lon1 - longitude of first point

lat2 - latitude of second point

lon2 - longitude of second point

Returns:

the distance betwen first and second point, in m.

latLonToXY

public Point latLonToXY(double lat,
                        double lon,
                        int zoom)

Parameters:

lat - latitude

lon - longitude

zoom - zoom level

Returns:

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

latLonToXY

public 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

public ICoordinate xyToLatLon(Point point,
                              int zoom)

Parameters:

point - point

zoom - zoom level

Returns:

WGS84 Coordinates of given point

xyToLatLon

public 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

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

Parameters:

lat - latitude

lon - longitude

zoom - zoom level

Returns:

x and y tile indices

latLonToTileXY

public TileXY latLonToTileXY(ICoordinate point,
                             int zoom)

Parameters:

point - point

zoom - zoom level

Returns:

x and y tile indices

tileXYToLatLon

public ICoordinate tileXYToLatLon(TileXY xy,
                                  int zoom)

Parameters:

xy - X/Y coordinates

zoom - zoom level

Returns:

WGS84 coordinates of given tile

tileXYToLatLon

public ICoordinate tileXYToLatLon(Tile tile)

Parameters:

tile - Tile

Returns:

WGS84 coordinates of given tile

tileXYToLatLon

public 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

public int getTileXMax(int zoom)

Parameters:

zoom - zoom level

Returns:

maximum X index of tile for specified zoom level

getTileXMin

public int getTileXMin(int zoom)

Parameters:

zoom - zoom level

Returns:

minimum X index of tile for specified zoom level

getTileYMax

public int getTileYMax(int zoom)

Parameters:

zoom - zoom level

Returns:

maximum Y index of tile for specified zoom level

getTileYMin

public int getTileYMin(int zoom)

Parameters:

zoom - zoom level

Returns:

minimum Y index of tile for specified zoom level

isNoTileAtZoom

public boolean isNoTileAtZoom(Map<String,List<String>> headers,
                              int statusCode,
                              byte[] content)

Description copied from interface: TileSource

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.

Specified by:

isNoTileAtZoom in interface TileSource

Overrides:

isNoTileAtZoom in class AbstractTileSource

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

public Map<String,String> getMetadata(Map<String,List<String>> headers)

Description copied from interface: TileSource

Extracts metadata about the tile based on HTTP headers

Parameters:

headers - HTTP headers from Tile Source server

Returns:

tile metadata

getTileId

public String getTileId(int zoom,
                        int tilex,
                        int tiley)

Description copied from interface: TileSource

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

getTileMax

private static int getTileMax(int zoom)