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.BingAerialTileSource

All Implemented Interfaces:

Attributed, TileSource

Direct Known Subclasses:

CachedAttributionBingAerialTileSource

public class BingAerialTileSource
extends AbstractTMSTileSource

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 String	API_KEY
private static Future<List<BingAerialTileSource.Attribution>>	attributions
private String	brandLogoUri
private static Pattern	culturePattern
private static Integer	imageryZoomMax
private static String	imageUrlTemplate
private static Pattern	quadkeyPattern
private static Pattern	subdomainPattern
private static String[]	subdomains

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

baseUrl, id, name, osmMercator, 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 String	computeQuadTree(int zoom, int tilex, int tiley)
protected List<BingAerialTileSource.Attribution>	getAttribution()
Image	getAttributionImage()
String	getAttributionImageURL()
String	getAttributionLinkURL()
protected Callable<List<BingAerialTileSource.Attribution>>	getAttributionLoaderCallable()
String	getAttributionText(int zoom, ICoordinate topLeft, ICoordinate botRight)
protected URL	getAttributionUrl()
int	getMaxZoom() Specifies the maximum zoom value.
String	getTermsOfUseText()
String	getTermsOfUseURL()
String	getTileUrl(int zoom, int tilex, int tiley) Constructs the tile url.
protected List<BingAerialTileSource.Attribution>	parseAttributionText(InputSource xml)
boolean	requiresAttribution()

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

getBaseUrl, getDefaultTileSize, getDistance, getExtension, getId, getMetadata, getMinZoom, getName, getTileId, getTilePath, getTileSize, getTileXMax, getTileXMin, getTileYMax, getTileYMin, isNoTileAtZoom, latLonToTileXY, latLonToTileXY, latLonToXY, latLonToXY, tileXYToLatLon, tileXYToLatLon, tileXYToLatLon, toString, xyToLatLon, 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

API_KEY

private static final String API_KEY

See Also:

Constant Field Values

attributions

private static volatile Future<List<BingAerialTileSource.Attribution>> attributions

imageUrlTemplate

private static String imageUrlTemplate

imageryZoomMax

private static Integer imageryZoomMax

subdomains

private static String[] subdomains

subdomainPattern

private static final Pattern subdomainPattern

quadkeyPattern

private static final Pattern quadkeyPattern

culturePattern

private static final Pattern culturePattern

brandLogoUri

private 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 String getTileUrl(int zoom,
                         int tilex,
                         int tiley)
                  throws 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:

IOException - if any I/O error occurs

getAttributionUrl

protected URL getAttributionUrl()
                         throws MalformedURLException

Throws:

MalformedURLException

parseAttributionText

protected List<BingAerialTileSource.Attribution> parseAttributionText(InputSource xml)
                                                               throws IOException

Throws:

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 AbstractTMSTileSource

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 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 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 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 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 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 Callable<List<BingAerialTileSource.Attribution>> getAttributionLoaderCallable()

getAttribution

protected List<BingAerialTileSource.Attribution> getAttribution()

getAttributionText

public 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 String computeQuadTree(int zoom,
                                      int tilex,
                                      int tiley)