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

Nested Class Summary

Nested classes/interfaces inherited from interface org.openstreetmap.gui.jmapviewer.interfaces.TileSource

TileSource.TileUpdate

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseUrl
protected java.lang.String	id
protected java.lang.String	name

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

attributionImage, attributionImageURL, attributionLinkURL, attributionText, termsOfUseText, termsOfUseURL

Constructor Summary

Constructors

Constructor and Description
AbstractTMSTileSource(java.lang.String name, java.lang.String base_url, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBaseUrl()
double	getDistance(double lat1, double lon1, double lat2, double lon2) Gets the distance using Spherical law of cosines.
java.lang.String	getExtension()
java.lang.String	getId() A unique id for this tile source.
int	getMaxZoom() Specifies the maximum zoom value.
int	getMinZoom() Specifies the minimum zoom value.
java.lang.String	getName() A tile layer name as displayed to the user.
java.lang.String	getTilePath(int zoom, int tilex, int tiley)
int	getTileSize() Specifies how large each tile is.
java.lang.String	getTileType() Specifies the tile image type.
java.lang.String	getTileUrl(int zoom, int tilex, int tiley) Constructs the tile url.
double	latToTileY(double lat, int zoom) Transforms latitude to Y tile coordinate.
int	LatToY(double lat, int zoom) Transforms latitude to pixelspace.
double	lonToTileX(double lon, int zoom) Transforms longitude to X tile coordinate.
int	LonToX(double lon, int zoom) Transform longitude to pixelspace.
double	tileXToLon(int x, int zoom) Transforms tile X coordinate to longitude.
double	tileYToLat(int y, int zoom) Transforms tile Y coordinate to latitude.
java.lang.String	toString()
double	XToLon(int x, int zoom) Transforms pixel coordinate X to longitude
double	YToLat(int y, int zoom) Transforms pixel coordinate Y to latitude.

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

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

getTileUpdate

Field Detail

name

protected java.lang.String name

baseUrl

protected java.lang.String baseUrl

id

protected java.lang.String id

Constructor Detail

AbstractTMSTileSource

public AbstractTMSTileSource(java.lang.String name,
                             java.lang.String base_url,
                             java.lang.String id)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: TileSource

A tile layer name as displayed to the user.

Returns:

Name of the tile layer

getId

public java.lang.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 java.lang.String getExtension()

getTilePath

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

Throws:

java.io.IOException - when subclass cannot return the tile URL

getBaseUrl

public java.lang.String getBaseUrl()

getTileUrl

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

Description copied from interface: TileSource

Constructs the tile url.

Returns:

fully qualified url for downloading the specified tile image

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTileType

public java.lang.String getTileType()

Description copied from interface: TileSource

Specifies the tile image type. For tiles rendered by Mapnik or Osmarenderer this is usually "png".

Returns:

file extension of the tile image type

getTileSize

public int getTileSize()

Description copied from interface: TileSource

Specifies how large each tile is.

Returns:

The size of a single tile in pixels.

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.

Returns:

the distance, m.

LonToX

public int LonToX(double lon,
                  int zoom)

Description copied from interface: TileSource

Transform longitude to pixelspace.

Returns:

[0..2^Zoomlevel*TILE_SIZE[

LatToY

public int LatToY(double lat,
                  int zoom)

Description copied from interface: TileSource

Transforms latitude to pixelspace.

Returns:

[0..2^Zoomlevel*TILE_SIZE[

XToLon

public double XToLon(int x,
                     int zoom)

Description copied from interface: TileSource

Transforms pixel coordinate X to longitude

Returns:

]-180..180[

YToLat

public double YToLat(int y,
                     int zoom)

Description copied from interface: TileSource

Transforms pixel coordinate Y to latitude.

Returns:

[MIN_LAT..MAX_LAT]

latToTileY

public double latToTileY(double lat,
                         int zoom)

Description copied from interface: TileSource

Transforms latitude to Y tile coordinate.

Returns:

[0..2^Zoomlevel[

lonToTileX

public double lonToTileX(double lon,
                         int zoom)

Description copied from interface: TileSource

Transforms longitude to X tile coordinate.

Returns:

[0..2^Zoomlevel[

tileYToLat

public double tileYToLat(int y,
                         int zoom)

Description copied from interface: TileSource

Transforms tile Y coordinate to latitude.

Returns:

[MIN_LAT..MAX_LAT]

tileXToLon

public double tileXToLon(int x,
                         int zoom)

Description copied from interface: TileSource

Transforms tile X coordinate to longitude.

Returns:

]-180..180[