org.openstreetmap.gui.jmapviewer.tilesources

Class BingAerialTileSource

java.lang.Object

org.openstreetmap.gui.jmapviewer.tilesources.AbstractTileSource

org.openstreetmap.gui.jmapviewer.tilesources.AbstractTMSTileSource

org.openstreetmap.gui.jmapviewer.tilesources.TMSTileSource

org.openstreetmap.gui.jmapviewer.tilesources.BingAerialTileSource

All Implemented Interfaces:

Attributed, TileSource

Direct Known Subclasses:

CachedAttributionBingAerialTileSource

public class BingAerialTileSource
extends TMSTileSource

Tile source for the Bing Maps REST Imagery API.

See Also:

MSDN (1) and MSDN (2)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BingAerialTileSource.Attribution

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	API_KEY Original Bing API key created by Potlatch2 developers in 2010
static java.lang.String	API_KEY_PLACEHOLDER Placeholder to specify Bing API key in metadata API URL
static java.lang.String	API_KEY_SETTING Setting key for Bing API key
private static java.util.concurrent.Future<java.util.List<BingAerialTileSource.Attribution>>	attributions
private java.lang.String	brandLogoUri
private static java.util.regex.Pattern	culturePattern
private static java.lang.Integer	imageryZoomMax
private static java.lang.String	imageUrlTemplate
private static java.util.logging.Logger	LOG
static java.lang.String	METADATA_API_SETTING Setting key for Bing metadata API URL.
private static java.lang.String	METADATA_API_URL Bing Metadata API URL
private static java.util.regex.Pattern	quadkeyPattern
private static java.util.regex.Pattern	subdomainPattern
private static java.lang.String[]	subdomains

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

maxZoom, minZoom, osmMercator

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

baseUrl, id, modTileFeatures, name, tileSize

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

attributionImage, attributionImageURL, attributionLinkURL, attributionText, termsOfUseText, termsOfUseURL

Constructor Summary

Constructors

Constructor and Description
BingAerialTileSource() Constructs a new BingAerialTileSource.
BingAerialTileSource(TileSourceInfo info) Constructs a new BingAerialTileSource.

Method Summary

Modifier and Type	Method and Description
private static java.lang.String	computeQuadTree(int zoom, int tilex, int tiley)
protected java.util.List<BingAerialTileSource.Attribution>	getAttribution()
java.awt.Image	getAttributionImage()
java.lang.String	getAttributionImageURL()
java.lang.String	getAttributionLinkURL()
protected java.util.concurrent.Callable<java.util.List<BingAerialTileSource.Attribution>>	getAttributionLoaderCallable()
java.lang.String	getAttributionText(int zoom, ICoordinate topLeft, ICoordinate botRight)
protected java.net.URL	getAttributionUrl()
int	getMaxZoom() Specifies the maximum zoom value.
java.lang.String	getTermsOfUseText()
java.lang.String	getTermsOfUseURL()
java.lang.String	getTileUrl(int zoom, int tilex, int tiley) Constructs the tile url.
protected java.util.List<BingAerialTileSource.Attribution>	parseAttributionText(org.xml.sax.InputSource xml)
boolean	requiresAttribution()

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

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

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

getBaseUrl, getDefaultTileSize, getExtension, getId, getMetadata, getName, getTileId, getTilePath, getTileSize, getTileXMax, getTileXMin, getTileYMax, getTileYMin, isModTileFeatures, isNoTileAtZoom, latLonToTileXY, latLonToXY, tileXYToLatLon, tileXYToLatLon, toString, xyToLatLon

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

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

LOG

private static final java.util.logging.Logger LOG

METADATA_API_SETTING

public static final java.lang.String METADATA_API_SETTING

Setting key for Bing metadata API URL. Must contain API_KEY_PLACEHOLDER

See Also:

Constant Field Values

API_KEY_SETTING

public static final java.lang.String API_KEY_SETTING

Setting key for Bing API key

See Also:

Constant Field Values

API_KEY_PLACEHOLDER

public static final java.lang.String API_KEY_PLACEHOLDER

Placeholder to specify Bing API key in metadata API URL

See Also:

Constant Field Values

METADATA_API_URL

private static final java.lang.String METADATA_API_URL

Bing Metadata API URL

See Also:

Constant Field Values

API_KEY

private static final java.lang.String API_KEY

Original Bing API key created by Potlatch2 developers in 2010

See Also:

Constant Field Values

attributions

private static volatile java.util.concurrent.Future<java.util.List<BingAerialTileSource.Attribution>> attributions

imageUrlTemplate

private static java.lang.String imageUrlTemplate

imageryZoomMax

private static java.lang.Integer imageryZoomMax

subdomains

private static java.lang.String[] subdomains

subdomainPattern

private static final java.util.regex.Pattern subdomainPattern

quadkeyPattern

private static final java.util.regex.Pattern quadkeyPattern

culturePattern

private static final java.util.regex.Pattern culturePattern

brandLogoUri

private java.lang.String brandLogoUri

Constructor Detail

BingAerialTileSource

public BingAerialTileSource()

Constructs a new BingAerialTileSource.

BingAerialTileSource

public BingAerialTileSource(TileSourceInfo info)

Constructs a new BingAerialTileSource.

Parameters:

info - imagery info

Method Detail

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.

Specified by:

getTileUrl in interface TileSource

Overrides:

getTileUrl in class AbstractTMSTileSource

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

getAttributionUrl

protected java.net.URL getAttributionUrl()
                                  throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

parseAttributionText

protected java.util.List<BingAerialTileSource.Attribution> parseAttributionText(org.xml.sax.InputSource xml)
                                                                         throws java.io.IOException

Throws:

java.io.IOException

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

Overrides:

getMaxZoom in class TMSTileSource

Returns:

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

requiresAttribution

public boolean requiresAttribution()

Specified by:

requiresAttribution in interface Attributed

Overrides:

requiresAttribution in class AbstractTileSource

Returns:

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

getAttributionLinkURL

public java.lang.String getAttributionLinkURL()

Specified by:

getAttributionLinkURL in interface Attributed

Overrides:

getAttributionLinkURL in class AbstractTileSource

Returns:

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

getAttributionImage

public java.awt.Image getAttributionImage()

Specified by:

getAttributionImage in interface Attributed

Overrides:

getAttributionImage in class AbstractTileSource

Returns:

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

getAttributionImageURL

public java.lang.String getAttributionImageURL()

Specified by:

getAttributionImageURL in interface Attributed

Overrides:

getAttributionImageURL in class AbstractTileSource

Returns:

The URL to open when the user clicks the attribution image. When return value is null, the image is still displayed (provided getAttributionImage() returns a value other than null), but the image does not link to a website.

getTermsOfUseText

public java.lang.String getTermsOfUseText()

Specified by:

getTermsOfUseText in interface Attributed

Overrides:

getTermsOfUseText in class AbstractTileSource

Returns:

The attribution "Terms of Use" text. In case it returns null, but getTermsOfUseURL() is not null, a default terms of use text is used.

getTermsOfUseURL

public java.lang.String getTermsOfUseURL()

Specified by:

getTermsOfUseURL in interface Attributed

Overrides:

getTermsOfUseURL in class AbstractTileSource

Returns:

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

getAttributionLoaderCallable

protected java.util.concurrent.Callable<java.util.List<BingAerialTileSource.Attribution>> getAttributionLoaderCallable()

getAttribution

protected java.util.List<BingAerialTileSource.Attribution> getAttribution()

getAttributionText

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

Specified by:

getAttributionText in interface Attributed

Overrides:

getAttributionText in class AbstractTileSource

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.

computeQuadTree

private static java.lang.String computeQuadTree(int zoom,
                                                int tilex,
                                                int tiley)