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:

TMSTileSource, WMTSTileSource

public abstract class AbstractTMSTileSource
extends AbstractTileSource

Class generalizing all tile based tile sources

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseUrl
protected java.lang.String	id
private java.util.Map<java.lang.String,java.lang.String>	metadataHeaders
protected boolean	modTileFeatures
protected java.lang.String	name
private java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	noTileChecksums
private java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	noTileHeaders
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
java.lang.String	getBaseUrl()
int	getDefaultTileSize()
java.lang.String	getExtension()
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.
private static int	getTileMax(int zoom)
java.lang.String	getTilePath(int zoom, int tilex, int tiley)
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) Get maximum x index of tile for specified zoom level.
int	getTileXMin(int zoom) Get minimum x index of tile for specified zoom level.
int	getTileYMax(int zoom) Get maximum y index of tile for specified zoom level.
int	getTileYMin(int zoom) Get minimum y index of tile for specified zoom level
boolean	isModTileFeatures() Determines if this imagery supports "/dirty" mode (tile re-rendering).
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(ICoordinate point, int zoom) Transforms longitude and latitude to tile indices.
java.awt.Point	latLonToXY(ICoordinate point, int zoom) Transforms longitude and latitude to pixel space (as if all tiles at specified zoom level where joined).
ICoordinate	tileXYToLatLon(Tile tile) Determines to longitude and latitude of a tile.
ICoordinate	tileXYToLatLon(TileXY xy, int zoom) Transforms tile indices to longitude and latitude.
java.lang.String	toString()
ICoordinate	xyToLatLon(java.awt.Point point, int zoom) Transforms a point in pixel space to longitude/latitude (WGS84).

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

getCoveringTileRange, getDistance, getServerCRS, isInside, latLonToTileXY, latLonToXY, projectedToTileXY, tileXYToLatLon, tileXYtoProjected, xyToLatLon

Field Detail

name

protected java.lang.String name

baseUrl

protected java.lang.String baseUrl

id

protected java.lang.String id

noTileHeaders

private final java.util.Map<java.lang.String,java.util.Set<java.lang.String>> noTileHeaders

noTileChecksums

private final java.util.Map<java.lang.String,java.util.Set<java.lang.String>> noTileChecksums

metadataHeaders

private final java.util.Map<java.lang.String,java.lang.String> metadataHeaders

modTileFeatures

protected boolean modTileFeatures

tileSize

protected int tileSize

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 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()

Returns:

image extension, used for URL creation

getTilePath

public java.lang.String getTilePath(int zoom,
                                    int tilex,
                                    int tiley)
                             throws java.io.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:

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

getBaseUrl

public java.lang.String getBaseUrl()

Returns:

Base part of the URL of the tile source

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.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.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

latLonToXY

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

Description copied from interface: TileSource

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

Parameters:

point - point

zoom - zoom level

Returns:

the pixel coordinates

xyToLatLon

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

Description copied from interface: TileSource

Transforms a point in pixel space to longitude/latitude (WGS84).

Parameters:

point - point

zoom - zoom level

Returns:

WGS84 Coordinates of given point

latLonToTileXY

public TileXY latLonToTileXY(ICoordinate point,
                             int zoom)

Description copied from interface: TileSource

Transforms longitude and latitude to tile indices.

Parameters:

point - point

zoom - zoom level

Returns:

x and y tile indices

tileXYToLatLon

public ICoordinate tileXYToLatLon(TileXY xy,
                                  int zoom)

Description copied from interface: TileSource

Transforms tile indices to longitude and latitude.

Parameters:

xy - X/Y tile indices

zoom - zoom level

Returns:

WGS84 coordinates of given tile

tileXYToLatLon

public ICoordinate tileXYToLatLon(Tile tile)

Description copied from interface: TileSource

Determines to longitude and latitude of a tile. (Refers to the tile origin - upper left tile corner)

Parameters:

tile - Tile

Returns:

WGS84 coordinates of given tile

getTileXMax

public int getTileXMax(int zoom)

Description copied from interface: TileSource

Get maximum x index of tile for specified zoom level.

Parameters:

zoom - zoom level

Returns:

maximum x index of tile for specified zoom level

getTileXMin

public int getTileXMin(int zoom)

Description copied from interface: TileSource

Get minimum x index of tile for specified zoom level.

Parameters:

zoom - zoom level

Returns:

minimum x index of tile for specified zoom level

getTileYMax

public int getTileYMax(int zoom)

Description copied from interface: TileSource

Get maximum y index of tile for specified zoom level.

Parameters:

zoom - zoom level

Returns:

maximum y index of tile for specified zoom level

getTileYMin

public int getTileYMin(int zoom)

Description copied from interface: TileSource

Get minimum y index of tile for specified zoom level

Parameters:

zoom - zoom level

Returns:

minimum y index of tile for specified zoom level

isNoTileAtZoom

public boolean isNoTileAtZoom(java.util.Map<java.lang.String,java.util.List<java.lang.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 java.util.Map<java.lang.String,java.lang.String> getMetadata(java.util.Map<java.lang.String,java.util.List<java.lang.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 java.lang.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

isModTileFeatures

public boolean isModTileFeatures()

Description copied from interface: TileSource

Determines if this imagery supports "/dirty" mode (tile re-rendering).

Returns:

true if it supports "/dirty" mode (tile re-rendering)

getTileMax

private static int getTileMax(int zoom)