jfxtras.labs.map.tile

Class DefaultTileSource

java.lang.Object

jfxtras.labs.map.tile.DefaultTileSource

All Implemented Interfaces:

TileSource

Direct Known Subclasses:

BingTileSource, LocalTileSource

public class DefaultTileSource
extends java.lang.Object
implements TileSource

Abstract parent for tile sources.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	apiKey
protected java.lang.String	baseUrl
static int	DEFAULT_TILE_SIZE
protected java.lang.String	name

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	getApiKey()
javafx.scene.image.Image	getAttributionImage()
java.lang.String	getAttributionLinkURL()
java.lang.String	getAttributionText(int zoom, Coordinate topLeft, Coordinate botRight)
java.lang.String	getBaseUrl()
int	getMaxZoom() Specifies the maximum zoom value.
int	getMinZoom() Specifies the minimum zoom value.
java.lang.String	getName() A tile layer name has to be unique and has to consist only of characters valid for filenames.
java.lang.String	getTermsOfUseURL()
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.
boolean	isAttributionRequired()
double	latToTileY(double lat, int zoom)
double	lonToTileX(double lon, int zoom)
void	setApiKey(java.lang.String apiKey)
void	setAttributionImage(javafx.scene.image.Image attributionImage)
void	setAttributionLinkURL(java.lang.String attributionLinkURL)
void	setAttributionRequired(boolean required)
void	setAttributionText(java.lang.String attributionText)
protected void	setMaxZoom(int maxZoom)
protected void	setMinZoom(int minZoom)
void	setTermsOfUserURL(java.lang.String termsOfUserURL)
void	setTilePathBuilder(TilePathBuildable tilePathBuilder)
void	setUrlBuilder(TileUrlBuildable urlBuilder)
double	tileXToLon(int x, int zoom)
double	tileYToLat(int y, int zoom)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TILE_SIZE

public static final int DEFAULT_TILE_SIZE

See Also:

Constant Field Values

name

protected java.lang.String name

baseUrl

protected java.lang.String baseUrl

apiKey

protected java.lang.String apiKey

Constructor Detail

DefaultTileSource

public DefaultTileSource(java.lang.String name,
                 java.lang.String base_url)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: TileSource

A tile layer name has to be unique and has to consist only of characters valid for filenames.

Specified by:

getName in interface TileSource

Returns:

Name of the tile layer

getMaxZoom

public int getMaxZoom()

Description copied from interface: TileSource

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

Specified by:

getMaxZoom in interface TileSource

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.

Specified by:

getMinZoom in interface TileSource

Returns:

minimum zoom value - usually 0

getTilePath

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

Throws:

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

setUrlBuilder

public void setUrlBuilder(TileUrlBuildable urlBuilder)

getBaseUrl

public java.lang.String getBaseUrl()

getTileUrl

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

Description copied from interface: TileSource

Constructs the tile url.

Specified by:

getTileUrl in interface TileSource

Returns:

fully qualified url for downloading the specified tile image

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.

Specified by:

getTileSize in interface TileSource

Returns:

The size of a single tile in pixels.

getAttributionImage

public javafx.scene.image.Image getAttributionImage()

Specified by:

getAttributionImage in interface TileSource

Returns:

The URL for the attribution image. Null if no image should be displayed.

setAttributionImage

public void setAttributionImage(javafx.scene.image.Image attributionImage)

isAttributionRequired

public boolean isAttributionRequired()

Specified by:

isAttributionRequired in interface TileSource

Returns:

True if the tile source requires attribution in text or image form.

getAttributionText

public java.lang.String getAttributionText(int zoom,
                                  Coordinate topLeft,
                                  Coordinate botRight)

Specified by:

getAttributionText in interface TileSource

Parameters:

zoom - The optional zoom level for the view.

topLeft - The top left of the bounding box for attribution.

botRight - The bottom right of the bounding box for attribution.

Returns:

Attribution text for the image source.

setAttributionText

public void setAttributionText(java.lang.String attributionText)

getAttributionLinkURL

public java.lang.String getAttributionLinkURL()

Specified by:

getAttributionLinkURL in interface TileSource

Returns:

The URL to open when the user clicks the attribution image.

setAttributionLinkURL

public void setAttributionLinkURL(java.lang.String attributionLinkURL)

getTermsOfUseURL

public java.lang.String getTermsOfUseURL()

Specified by:

getTermsOfUseURL in interface TileSource

Returns:

The URL to open when the user clicks the attribution "Terms of Use" text.

setTermsOfUserURL

public void setTermsOfUserURL(java.lang.String termsOfUserURL)

latToTileY

public double latToTileY(double lat,
                int zoom)

Specified by:

latToTileY in interface TileSource

lonToTileX

public double lonToTileX(double lon,
                int zoom)

Specified by:

lonToTileX in interface TileSource

tileYToLat

public double tileYToLat(int y,
                int zoom)

Specified by:

tileYToLat in interface TileSource

tileXToLon

public double tileXToLon(int x,
                int zoom)

Specified by:

tileXToLon in interface TileSource

setMinZoom

protected final void setMinZoom(int minZoom)

setMaxZoom

protected final void setMaxZoom(int maxZoom)

setAttributionRequired

public void setAttributionRequired(boolean required)

getApiKey

protected java.lang.String getApiKey()

setApiKey

public void setApiKey(java.lang.String apiKey)

setTilePathBuilder

public void setTilePathBuilder(TilePathBuildable tilePathBuilder)