org.osmdroid.tileprovider

Class MapTileProviderBase

java.lang.Object

org.osmdroid.tileprovider.MapTileProviderBase

All Implemented Interfaces:

IMapTileProviderCallback

Direct Known Subclasses:

MapTileProviderArray

public abstract class MapTileProviderBase
extends Object
implements IMapTileProviderCallback

This is an abstract class. The tile provider is responsible for:

• determining if a map tile is available,
• notifying the client, via a callback handler

see MapTileIndex for an overview of how tiles are served by this provider.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAPTILE_FAIL_ID
static int	MAPTILE_SUCCESS_ID
protected MapTileCache	mTileCache
protected Drawable	mTileNotFoundImage
protected boolean	mUseDataConnection

Constructor Summary

Constructors

Constructor and Description
MapTileProviderBase(ITileSource pTileSource)
MapTileProviderBase(ITileSource pTileSource, Handler pDownloadFinishedListener)

Method Summary

Modifier and Type	Method and Description
void	clearTileCache() purges the cache of all tiles (default is the in memory cache)
MapTileCache	createTileCache() Creates a MapTileCache to be used to cache tiles in memory.
void	detach() classes that extend MapTileProviderBase must call this method to prevent memory leaks.
void	ensureCapacity(int pCapacity)
void	expireInMemoryCache(long pMapTileIndex) Expire a tile that is in the memory cache Typical use is for mapsforge, where the contents of the tile can evolve, depending on the neighboring tiles that have been displayed so far.
abstract Drawable	getMapTile(long pMapTileIndex) Attempts to get a Drawable that represents a MapTileIndex.
abstract int	getMaximumZoomLevel() Gets the maximum zoom level this tile provider can provide
abstract int	getMinimumZoomLevel() Gets the minimum zoom level this tile provider can provide
abstract long	getQueueSize()
MapTileCache	getTileCache()
Collection<Handler>	getTileRequestCompleteHandlers()
ITileSource	getTileSource() Gets the tile source for this tile provider.
abstract IFilesystemCache	getTileWriter()
void	mapTileRequestCompleted(MapTileRequestState pState, Drawable pDrawable) Called by implementation class methods indicating that they have completed the request as best it can.
void	mapTileRequestExpiredTile(MapTileRequestState pState, Drawable pDrawable) Called by implementation class methods indicating that they have produced an expired result that can be used but better results may be delivered later.
void	mapTileRequestFailed(MapTileRequestState pState) Called by implementation class methods indicating that they have failed to retrieve the requested map tile.
void	mapTileRequestFailedExceedsMaxQueueSize(MapTileRequestState pState) Called by implementation class methods indicating that they have failed to retrieve the requested map tile, because the max queue size has been reached
protected void	putExpiredTileIntoCache(MapTileRequestState pState, Drawable pDrawable) Deprecated. Use putTileIntoCache(long, Drawable, int)} instead
protected void	putTileIntoCache(long pMapTileIndex, Drawable pDrawable, int pState)
void	rescaleCache(Projection pProjection, double pNewZoomLevel, double pOldZoomLevel, Rect pViewPort) Recreate the cache using scaled versions of the tiles currently in it
static void	setApproximationBackgroundColor(int pColor) Sets the default color for approximated tiles.
void	setTileLoadFailureImage(Drawable drawable) Sets the "sorry we can't load a tile for this location" image.
void	setTileRequestCompleteHandler(Handler handler) Deprecated. Use getTileRequestCompleteHandlers() instead
void	setTileSource(ITileSource pTileSource) Sets the tile source for this tile provider.
void	setUseDataConnection(boolean pMode) Set whether to use the network connection if it's available.
boolean	useDataConnection() Whether to use the network connection if it's available.

Methods inherited from class java.lang.Object

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

Field Detail

MAPTILE_SUCCESS_ID

public static final int MAPTILE_SUCCESS_ID

See Also:

Constant Field Values

MAPTILE_FAIL_ID

public static final int MAPTILE_FAIL_ID

See Also:

Constant Field Values

mTileCache

protected final MapTileCache mTileCache

mUseDataConnection

protected boolean mUseDataConnection

mTileNotFoundImage

protected Drawable mTileNotFoundImage

Constructor Detail

MapTileProviderBase

public MapTileProviderBase(ITileSource pTileSource)

MapTileProviderBase

public MapTileProviderBase(ITileSource pTileSource,
                           Handler pDownloadFinishedListener)

Method Detail

getMapTile

public abstract Drawable getMapTile(long pMapTileIndex)

Attempts to get a Drawable that represents a MapTileIndex. If the tile is not immediately available this will return null and attempt to get the tile from known tile sources for subsequent future requests. Note that this may return a ReusableBitmapDrawable in which case you should follow proper handling procedures for using that Drawable or it may reused while you are working with it.

See Also:

ReusableBitmapDrawable

detach

public void detach()

classes that extend MapTileProviderBase must call this method to prevent memory leaks. Updated 5.2+

setApproximationBackgroundColor

public static void setApproximationBackgroundColor(int pColor)

Sets the default color for approximated tiles.

Parameters:

pColor - the default color that will be shown for approximated tiles

getMinimumZoomLevel

public abstract int getMinimumZoomLevel()

Gets the minimum zoom level this tile provider can provide

Returns:

the minimum zoom level

getMaximumZoomLevel

public abstract int getMaximumZoomLevel()

Gets the maximum zoom level this tile provider can provide

Returns:

the maximum zoom level

setTileSource

public void setTileSource(ITileSource pTileSource)

Sets the tile source for this tile provider.

Parameters:

pTileSource - the tile source

getTileSource

public ITileSource getTileSource()

Gets the tile source for this tile provider.

Returns:

the tile source

createTileCache

public MapTileCache createTileCache()

Creates a MapTileCache to be used to cache tiles in memory.

setTileLoadFailureImage

public void setTileLoadFailureImage(Drawable drawable)

Sets the "sorry we can't load a tile for this location" image. If it's null, the default view is shown, which is the standard grey grid controlled by the tiles overlay TilesOverlay.setLoadingLineColor(int) and TilesOverlay.setLoadingBackgroundColor(int)

Parameters:

drawable -

Since:

5.2+

mapTileRequestCompleted

public void mapTileRequestCompleted(MapTileRequestState pState,
                                    Drawable pDrawable)

Called by implementation class methods indicating that they have completed the request as best it can. The tile is added to the cache, and a MAPTILE_SUCCESS_ID message is sent.

Specified by:

mapTileRequestCompleted in interface IMapTileProviderCallback

Parameters:

pState - the map tile request state object

pDrawable - the Drawable of the map tile

mapTileRequestFailed

public void mapTileRequestFailed(MapTileRequestState pState)

Called by implementation class methods indicating that they have failed to retrieve the requested map tile. a MAPTILE_FAIL_ID message is sent.

Specified by:

mapTileRequestFailed in interface IMapTileProviderCallback

Parameters:

pState - the map tile request state object

mapTileRequestFailedExceedsMaxQueueSize

public void mapTileRequestFailedExceedsMaxQueueSize(MapTileRequestState pState)

Called by implementation class methods indicating that they have failed to retrieve the requested map tile, because the max queue size has been reached

Specified by:

mapTileRequestFailedExceedsMaxQueueSize in interface IMapTileProviderCallback

Parameters:

pState - the map tile request state object

mapTileRequestExpiredTile

public void mapTileRequestExpiredTile(MapTileRequestState pState,
                                      Drawable pDrawable)

Called by implementation class methods indicating that they have produced an expired result that can be used but better results may be delivered later. The tile is added to the cache, and a MAPTILE_SUCCESS_ID message is sent.

Specified by:

mapTileRequestExpiredTile in interface IMapTileProviderCallback

Parameters:

pState - the map tile request state object

pDrawable - the Drawable of the map tile

putTileIntoCache

protected void putTileIntoCache(long pMapTileIndex,
                                Drawable pDrawable,
                                int pState)

Since:

5.6.5

putExpiredTileIntoCache

@Deprecated
protected void putExpiredTileIntoCache(MapTileRequestState pState,
                                                    Drawable pDrawable)

Deprecated. Use putTileIntoCache(long, Drawable, int)} instead

setTileRequestCompleteHandler

@Deprecated
public void setTileRequestCompleteHandler(Handler handler)

Deprecated. Use getTileRequestCompleteHandlers() instead

getTileRequestCompleteHandlers

public Collection<Handler> getTileRequestCompleteHandlers()

Since:

6.1.0

ensureCapacity

public void ensureCapacity(int pCapacity)

getTileCache

public MapTileCache getTileCache()

Since:

6.0.0

clearTileCache

public void clearTileCache()

purges the cache of all tiles (default is the in memory cache)

useDataConnection

public boolean useDataConnection()

Whether to use the network connection if it's available.

Specified by:

useDataConnection in interface IMapTileProviderCallback

Returns:

true if data connection should be used, false otherwise

setUseDataConnection

public void setUseDataConnection(boolean pMode)

Set whether to use the network connection if it's available.

Parameters:

pMode - if true use the network connection if it's available. if false don't use the network connection even if it's available.

rescaleCache

public void rescaleCache(Projection pProjection,
                         double pNewZoomLevel,
                         double pOldZoomLevel,
                         Rect pViewPort)

Recreate the cache using scaled versions of the tiles currently in it

Parameters:

pNewZoomLevel - the zoom level that we need now

pOldZoomLevel - the previous zoom level that we should get the tiles to rescale

pViewPort - the view port we need tiles for

getTileWriter

public abstract IFilesystemCache getTileWriter()

getQueueSize

public abstract long getQueueSize()

Returns:

the number of tile requests currently in the queue

Since:

5.6

expireInMemoryCache

public void expireInMemoryCache(long pMapTileIndex)

Expire a tile that is in the memory cache Typical use is for mapsforge, where the contents of the tile can evolve, depending on the neighboring tiles that have been displayed so far.

Since:

6.0.3