org.osmdroid.tileprovider

Class MapTileProviderArray

java.lang.Object

org.osmdroid.tileprovider.MapTileProviderBase

org.osmdroid.tileprovider.MapTileProviderArray

All Implemented Interfaces:

IMapTileProviderCallback, MapTileContainer

Direct Known Subclasses:

MapTileProviderBasic, OfflineTileProvider

public class MapTileProviderArray
extends MapTileProviderBase
implements MapTileContainer

This top-level tile provider allows a consumer to provide an array of modular asynchronous tile providers to be used to obtain map tiles. When a tile is requested, the MapTileProviderArray first checks the MapTileCache (synchronously) and returns the tile if available. If not, then the MapTileProviderArray returns null and sends the tile request through the asynchronous tile request chain. Each asynchronous tile provider returns success/failure to the MapTileProviderArray. If successful, the MapTileProviderArray passes the result to the base class. If failed, then the next asynchronous tile provider is called in the chain. If there are no more asynchronous tile providers in the chain, then the failure result is passed to the base class. The MapTileProviderArray provides a mechanism so that only one unique tile-request can be in the map tile request chain at a time.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<MapTileModuleProviderBase>	mTileProviderList

Fields inherited from class org.osmdroid.tileprovider.MapTileProviderBase

MAPTILE_FAIL_ID, MAPTILE_SUCCESS_ID, mTileCache, mTileNotFoundImage, mUseDataConnection

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapTileProviderArray(ITileSource pTileSource, IRegisterReceiver pRegisterReceiver) Creates an MapTileProviderArray with no tile providers.
	MapTileProviderArray(ITileSource pTileSource, IRegisterReceiver aRegisterReceiver, MapTileModuleProviderBase[] pTileProviderArray) Creates an MapTileProviderArray with the specified tile providers.

Method Summary

Modifier and Type	Method and Description
boolean	contains(long pTileIndex)
void	detach() classes that extend MapTileProviderBase must call this method to prevent memory leaks.
protected MapTileModuleProviderBase	findNextAppropriateProvider(MapTileRequestState aState) We want to not use a provider that doesn't exist anymore in the chain, and we want to not use a provider that requires a data connection when one is not available.
Drawable	getMapTile(long pMapTileIndex) Attempts to get a Drawable that represents a MapTileIndex.
int	getMaximumZoomLevel() Gets the maximum zoom level this tile provider can provide
int	getMinimumZoomLevel() Gets the minimum zoom level this tile provider can provide
boolean	getProviderExists(MapTileModuleProviderBase provider)
long	getQueueSize()
IFilesystemCache	getTileWriter()
protected boolean	isDowngradedMode() Deprecated. Not used anymore. Use isDowngradedMode(long) instead
protected boolean	isDowngradedMode(long pMapTileIndex)
void	mapTileRequestCompleted(MapTileRequestState aState, Drawable aDrawable) Called by implementation class methods indicating that they have completed the request as best it can.
void	mapTileRequestExpiredTile(MapTileRequestState aState, Drawable aDrawable) 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 aState) Called by implementation class methods indicating that they have failed to retrieve the requested map tile.
void	mapTileRequestFailedExceedsMaxQueueSize(MapTileRequestState aState) Called by implementation class methods indicating that they have failed to retrieve the requested map tile, because the max queue size has been reached
void	setTileSource(ITileSource aTileSource) Sets the tile source for this tile provider.

Methods inherited from class org.osmdroid.tileprovider.MapTileProviderBase

clearTileCache, createTileCache, ensureCapacity, expireInMemoryCache, getTileCache, getTileRequestCompleteHandlers, getTileSource, putExpiredTileIntoCache, putTileIntoCache, rescaleCache, setTileLoadFailureImage, setTileRequestCompleteHandler, setUseDataConnection, useDataConnection

Methods inherited from class java.lang.Object

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

Field Detail

mTileProviderList

protected final List<MapTileModuleProviderBase> mTileProviderList

Constructor Detail

MapTileProviderArray

protected MapTileProviderArray(ITileSource pTileSource,
                               IRegisterReceiver pRegisterReceiver)

Creates an MapTileProviderArray with no tile providers.

Parameters:

pRegisterReceiver - a IRegisterReceiver

MapTileProviderArray

public MapTileProviderArray(ITileSource pTileSource,
                            IRegisterReceiver aRegisterReceiver,
                            MapTileModuleProviderBase[] pTileProviderArray)

Creates an MapTileProviderArray with the specified tile providers.

Parameters:

aRegisterReceiver - a IRegisterReceiver

pTileProviderArray - an array of MapTileModuleProviderBase

Method Detail

detach

public void detach()

Description copied from class: MapTileProviderBase

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

Overrides:

detach in class MapTileProviderBase

contains

public boolean contains(long pTileIndex)

Specified by:

contains in interface MapTileContainer

Since:

6.0.2

isDowngradedMode

@Deprecated
protected boolean isDowngradedMode()

Deprecated. Not used anymore. Use isDowngradedMode(long) instead

Since:

6.0

isDowngradedMode

protected boolean isDowngradedMode(long pMapTileIndex)

Since:

6.0.3

getMapTile

public Drawable getMapTile(long pMapTileIndex)

Description copied from class: MapTileProviderBase

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.

Specified by:

getMapTile in class MapTileProviderBase

See Also:

ReusableBitmapDrawable

mapTileRequestCompleted

public void mapTileRequestCompleted(MapTileRequestState aState,
                                    Drawable aDrawable)

Description copied from class: MapTileProviderBase

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

Overrides:

mapTileRequestCompleted in class MapTileProviderBase

Parameters:

aState - the map tile request state object

aDrawable - the Drawable of the map tile

mapTileRequestFailed

public void mapTileRequestFailed(MapTileRequestState aState)

Description copied from class: MapTileProviderBase

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

Overrides:

mapTileRequestFailed in class MapTileProviderBase

Parameters:

aState - the map tile request state object

mapTileRequestFailedExceedsMaxQueueSize

public void mapTileRequestFailedExceedsMaxQueueSize(MapTileRequestState aState)

Description copied from class: MapTileProviderBase

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

Overrides:

mapTileRequestFailedExceedsMaxQueueSize in class MapTileProviderBase

Parameters:

aState - the map tile request state object

mapTileRequestExpiredTile

public void mapTileRequestExpiredTile(MapTileRequestState aState,
                                      Drawable aDrawable)

Description copied from class: MapTileProviderBase

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

Overrides:

mapTileRequestExpiredTile in class MapTileProviderBase

Parameters:

aState - the map tile request state object

aDrawable - the Drawable of the map tile

getTileWriter

public IFilesystemCache getTileWriter()

Specified by:

getTileWriter in class MapTileProviderBase

getQueueSize

public long getQueueSize()

Specified by:

getQueueSize in class MapTileProviderBase

Returns:

the number of tile requests currently in the queue

findNextAppropriateProvider

protected MapTileModuleProviderBase findNextAppropriateProvider(MapTileRequestState aState)

We want to not use a provider that doesn't exist anymore in the chain, and we want to not use a provider that requires a data connection when one is not available.

getProviderExists

public boolean getProviderExists(MapTileModuleProviderBase provider)

getMinimumZoomLevel

public int getMinimumZoomLevel()

Description copied from class: MapTileProviderBase

Gets the minimum zoom level this tile provider can provide

Specified by:

getMinimumZoomLevel in class MapTileProviderBase

Returns:

the minimum zoom level

getMaximumZoomLevel

public int getMaximumZoomLevel()

Description copied from class: MapTileProviderBase

Gets the maximum zoom level this tile provider can provide

Specified by:

getMaximumZoomLevel in class MapTileProviderBase

Returns:

the maximum zoom level

setTileSource

public void setTileSource(ITileSource aTileSource)

Description copied from class: MapTileProviderBase

Sets the tile source for this tile provider.

Overrides:

setTileSource in class MapTileProviderBase

Parameters:

aTileSource - the tile source