org.osmdroid.tileprovider.tilesource.bing

Class BingMapTileSource

java.lang.Object

org.osmdroid.tileprovider.tilesource.BitmapTileSourceBase

org.osmdroid.tileprovider.tilesource.OnlineTileSourceBase

org.osmdroid.tileprovider.tilesource.QuadTreeTileSource

org.osmdroid.tileprovider.tilesource.bing.BingMapTileSource

All Implemented Interfaces:

IStyledTileSource<String>, ITileSource

public class BingMapTileSource
extends QuadTreeTileSource
implements IStyledTileSource<String>

BingMap tile source used with OSMDroid

This class builds the Bing REST services url to be requested to get a tile image.

Before to be used, the static method retrieveBingKey(android.content.Context) must be invoked.

See http://msdn.microsoft.com/en-us/library/ff701721.aspx for details on the Bing API.

Nested Class Summary

Nested classes/interfaces inherited from class org.osmdroid.tileprovider.tilesource.BitmapTileSourceBase

BitmapTileSourceBase.LowMemoryException

Field Summary

Fields

Modifier and Type	Field and Description
static String	IMAGERYSET_AERIAL Aerial imagery mode
static String	IMAGERYSET_AERIALWITHLABELS Aerial imagery with road overlay mode
static String	IMAGERYSET_ROAD Roads imagery mode

Fields inherited from class org.osmdroid.tileprovider.tilesource.BitmapTileSourceBase

mCopyright, mImageFilenameEnding, mName, random

Constructor Summary

Constructors

Constructor and Description
BingMapTileSource(String aLocale) Constructor. Warning, the static method retrieveBingKey(android.content.Context) should have been invoked once before constructor invocation

Method Summary

Modifier and Type	Method and Description
String	getBaseUrl() Get the base url, which will be a random one if there are more than one.
static String	getBingKey()
String	getCopyrightNotice() Returns an I18N sensitive string representing the copy right notice (if any) of the tile source
int	getMaximumZoomLevel() get maximum zoom level
int	getMinimumZoomLevel() get minimum zoom level
String	getStyle()
int	getTileSizePixels() get tile size in pixel
String	getTileURLString(long pMapTileIndex)
ImageryMetaDataResource	initMetaData() Fire this after you've set up your prefered tile styles and locale if you forget, it should fire on the first request for tiles.
String	pathBase() get the base path used for caching purpose
static void	retrieveBingKey(Context aContext) Read the API key from the manifest. This method should be invoked before class instantiation.
static void	setBingKey(String key)
void	setStyle(String pStyle)
protected void	updateBaseUrl() Resolves url patterns to update urls with current map view mode and available sub domain. When several subdomains are available, change current sub domain in a cycle manner

Methods inherited from class org.osmdroid.tileprovider.tilesource.QuadTreeTileSource

quadTree

Methods inherited from class org.osmdroid.tileprovider.tilesource.OnlineTileSourceBase

acquire, getTileSourcePolicy, release

Methods inherited from class org.osmdroid.tileprovider.tilesource.BitmapTileSourceBase

getDrawable, getDrawable, getTileRelativeFilenameString, imageFilenameEnding, name, ordinal, toString

Methods inherited from class java.lang.Object

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

Field Detail

IMAGERYSET_AERIAL

public static final String IMAGERYSET_AERIAL

Aerial imagery mode

See Also:

Constant Field Values

IMAGERYSET_AERIALWITHLABELS

public static final String IMAGERYSET_AERIALWITHLABELS

Aerial imagery with road overlay mode

See Also:

Constant Field Values

IMAGERYSET_ROAD

public static final String IMAGERYSET_ROAD

Roads imagery mode

See Also:

Constant Field Values

Constructor Detail

BingMapTileSource

public BingMapTileSource(String aLocale)

Constructor.
Warning, the static method retrieveBingKey(android.content.Context) should have been invoked once before constructor invocation

Parameters:

aLocale - The language used with BingMap REST service to retrieve tiles.
If null, the system default locale is used.

Method Detail

retrieveBingKey

public static void retrieveBingKey(Context aContext)

Read the API key from the manifest.
This method should be invoked before class instantiation.

getBingKey

public static String getBingKey()

setBingKey

public static void setBingKey(String key)

getBaseUrl

public String getBaseUrl()

Description copied from class: OnlineTileSourceBase

Get the base url, which will be a random one if there are more than one.
Updated around 6.1.1, if base url list is null or empty, empty string is returned

Overrides:

getBaseUrl in class OnlineTileSourceBase

getTileURLString

public String getTileURLString(long pMapTileIndex)

Overrides:

getTileURLString in class QuadTreeTileSource

getMinimumZoomLevel

public int getMinimumZoomLevel()

get minimum zoom level

Specified by:

getMinimumZoomLevel in interface ITileSource

Overrides:

getMinimumZoomLevel in class BitmapTileSourceBase

Returns:

minimum zoom level supported by Bing Map for current map view mode

getMaximumZoomLevel

public int getMaximumZoomLevel()

get maximum zoom level

Specified by:

getMaximumZoomLevel in interface ITileSource

Overrides:

getMaximumZoomLevel in class BitmapTileSourceBase

Returns:

maximum zoom level supported by Bing Map for current map view mode

getTileSizePixels

public int getTileSizePixels()

get tile size in pixel

Specified by:

getTileSizePixels in interface ITileSource

Overrides:

getTileSizePixels in class BitmapTileSourceBase

Returns:

tile size in pixel supported by Bing Map for current map view mode

pathBase

public String pathBase()

get the base path used for caching purpose

Overrides:

pathBase in class BitmapTileSourceBase

Returns:

a base path built on name given as constructor parameter and current style name

getCopyrightNotice

public String getCopyrightNotice()

Description copied from interface: ITileSource

Returns an I18N sensitive string representing the copy right notice (if any) of the tile source

Specified by:

getCopyrightNotice in interface ITileSource

Overrides:

getCopyrightNotice in class BitmapTileSourceBase

Returns:

a string or null

setStyle

public void setStyle(String pStyle)

Specified by:

setStyle in interface IStyledTileSource<String>

getStyle

public String getStyle()

Specified by:

getStyle in interface IStyledTileSource<String>

initMetaData

public ImageryMetaDataResource initMetaData()

Fire this after you've set up your prefered tile styles and locale if you forget, it should fire on the first request for tiles.

See issue https://github.com/osmdroid/osmdroid/issues/383 It was made public since v5.3

Returns:

Since:

5.3

updateBaseUrl

protected void updateBaseUrl()

Resolves url patterns to update urls with current map view mode and available sub domain.
When several subdomains are available, change current sub domain in a cycle manner