org.osmdroid.tileprovider.cachemanager

Class CacheManager

java.lang.Object

org.osmdroid.tileprovider.cachemanager.CacheManager

public class CacheManager
extends Object

Provides various methods for managing the local filesystem cache of osmdroid tiles:
- Dowloading of tiles inside a specified area,
- Cleaning of tiles inside a specified area,
- Information about cache capacity and current cache usage.

Important note 1:
These methods only make sense for a MapView using an OnlineTileSourceBase: bitmap tiles downloaded from urls.

Important note 2 - about Bulk Downloading:
When using OSM Mapnik tile server as the tile source, take care about OSM Tile usage policy (http://wiki.openstreetmap.org/wiki/Tile_usage_policy). Do not let to end-users the ability to download significant areas of tiles.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CacheManager.CacheManagerAction Action to perform on a tile within a CacheManagerTask
static interface	CacheManager.CacheManagerCallback
static class	CacheManager.CacheManagerDialog
static class	CacheManager.CacheManagerTask generic class for common code related to AsyncTask management - performing an action - within a manager - on a list of tiles (potentially sorted by ascending zoom level) - and with callbacks for task progression

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mMaxZoomLevel
protected int	mMinZoomLevel
protected Set<CacheManager.CacheManagerTask>	mPendingTasks
protected ITileSource	mTileSource
protected IFilesystemCache	mTileWriter
protected boolean	verifyCancel

Constructor Summary

Constructors

Constructor and Description
CacheManager(ITileSource pTileSource, IFilesystemCache pWriter, int pMinZoomLevel, int pMaxZoomLevel)
CacheManager(MapTileProviderBase pTileProvider, IFilesystemCache pWriter, int pMinZoomLevel, int pMaxZoomLevel) See https://github.com/osmdroid/osmdroid/issues/619
CacheManager(MapView mapView)
CacheManager(MapView mapView, IFilesystemCache writer)

Method Summary

Modifier and Type	Method and Description
long	cacheCapacity()
void	cancelAllJobs() cancels all tasks
boolean	checkTile(long pMapTileIndex)
CacheManager.CacheManagerTask	cleanAreaAsync(Context ctx, ArrayList<GeoPoint> geoPoints, int zoomMin, int zoomMax) Remove all cached tiles covered by the GeoPoints list.
CacheManager.CacheManagerTask	cleanAreaAsync(Context ctx, BoundingBox bb, int zoomMin, int zoomMax) Remove all cached tiles in the specified area.
CacheManager.CacheManagerTask	cleanAreaAsync(Context ctx, List<Long> tiles, int zoomMin, int zoomMax) Remove all cached tiles in the specified area.
long	currentCacheUsage()
boolean	deleteTile(long pMapTileIndex)
long	directorySize(File pDirectory)
CacheManager.CacheManagerTask	downloadAreaAsync(Context ctx, ArrayList<GeoPoint> geoPoints, int zoomMin, int zoomMax) Download in background all tiles of the specified area in osmdroid cache.
CacheManager.CacheManagerTask	downloadAreaAsync(Context ctx, ArrayList<GeoPoint> geoPoints, int zoomMin, int zoomMax, CacheManager.CacheManagerCallback callback) Download in background all tiles covered by the GePoints list in osmdroid cache.
CacheManager.CacheManagerTask	downloadAreaAsync(Context ctx, BoundingBox bb, int zoomMin, int zoomMax) Download in background all tiles of the specified area in osmdroid cache.
CacheManager.CacheManagerTask	downloadAreaAsync(Context ctx, BoundingBox bb, int zoomMin, int zoomMax, CacheManager.CacheManagerCallback callback) Download in background all tiles of the specified area in osmdroid cache.
CacheManager.CacheManagerTask	downloadAreaAsync(Context ctx, List<Long> pTiles, int zoomMin, int zoomMax) Download in background all tiles of the specified area in osmdroid cache.
CacheManager.CacheManagerTask	downloadAreaAsyncNoUI(Context ctx, ArrayList<GeoPoint> geoPoints, int zoomMin, int zoomMax, CacheManager.CacheManagerCallback callback) Download in background all tiles covered by the GeoPoints list in osmdroid cache without a user interface.
CacheManager.CacheManagerTask	downloadAreaAsyncNoUI(Context ctx, BoundingBox bb, int zoomMin, int zoomMax, CacheManager.CacheManagerCallback callback) Download in background all tiles of the specified area in osmdroid cache without a user interface.
CacheManager.CacheManagerTask	execute(CacheManager.CacheManagerTask pTask)
BoundingBox	extendedBoundsFromGeoPoints(ArrayList<GeoPoint> geoPoints, int minZoomLevel)
boolean	forceLoadTile(OnlineTileSourceBase tileSource, long pMapTileIndex) Actual tile download, regardless of the tile being already present in the cache
CacheManager.CacheManagerAction	getCleaningAction()
CacheManager.CacheManagerDialog	getCleaningDialog(Context pCtx, CacheManager.CacheManagerTask pTask)
static GeoPoint	getCoordinatesFromMapTile(int x, int y, int zoom) Deprecated. Use TileSystem.getLatitudeFromTileY(int, int) and TileSystem.getLongitudeFromTileX(int, int) instead
CacheManager.CacheManagerAction	getDownloadingAction()
CacheManager.CacheManagerDialog	getDownloadingDialog(Context pCtx, CacheManager.CacheManagerTask pTask)
static File	getFileName(ITileSource tileSource, long pMapTileIndex)
static Point	getMapTileFromCoordinates(double aLat, double aLon, int zoom) Deprecated. Use TileSystem.getTileXFromLongitude(double, int) and TileSystem.getTileYFromLatitude(double, int) instead
int	getPendingJobs()
static Collection<Long>	getTilesCoverage(ArrayList<GeoPoint> pGeoPoints, int pZoomLevel) Computes the theoretical tiles covered by the list of points Calculation done based on http://www.movable-type.co.uk/scripts/latlong.html
static List<Long>	getTilesCoverage(ArrayList<GeoPoint> pGeoPoints, int pZoomMin, int pZoomMax) Computes the theoretical tiles covered by the list of points
static Collection<Long>	getTilesCoverage(BoundingBox pBB, int pZoomLevel) Computes the theoretical tiles covered by the bounding box
static List<Long>	getTilesCoverage(BoundingBox pBB, int pZoomMin, int pZoomMax) Computes the theoretical tiles covered by the bounding box
(package private) static IterableWithSize<Long>	getTilesCoverageIterable(BoundingBox pBB, int pZoomMin, int pZoomMax) Iterable returning tiles covered by the bounding box sorted by ascending zoom level
static Rect	getTilesRect(BoundingBox pBB, int pZoomLevel) Retrieve upper left and lower right points(exclusive) corresponding to the tiles coverage for the selected zoom level.
boolean	getVerifyCancel()
boolean	isTileToBeDownloaded(ITileSource pTileSource, long pMapTileIndex) "Should we download this tile?", either because it's not cached yet or because it's expired
boolean	loadTile(OnlineTileSourceBase tileSource, long pMapTileIndex)
int	possibleTilesCovered(ArrayList<GeoPoint> pGeoPoints, int pZoomMin, int pZoomMax)
int	possibleTilesInArea(BoundingBox pBB, int pZoomMin, int pZoomMax)
void	setTileDownloader(TileDownloader pTileDownloader)
void	setVerifyCancel(boolean state)

Methods inherited from class java.lang.Object

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

Field Detail

mTileSource

protected final ITileSource mTileSource

mTileWriter

protected final IFilesystemCache mTileWriter

mMinZoomLevel

protected final int mMinZoomLevel

mMaxZoomLevel

protected final int mMaxZoomLevel

mPendingTasks

protected Set<CacheManager.CacheManagerTask> mPendingTasks

verifyCancel

protected boolean verifyCancel

Constructor Detail

CacheManager

public CacheManager(MapView mapView)
             throws TileSourcePolicyException

Throws:

TileSourcePolicyException

CacheManager

public CacheManager(MapView mapView,
                    IFilesystemCache writer)
             throws TileSourcePolicyException

Throws:

TileSourcePolicyException

CacheManager

public CacheManager(MapTileProviderBase pTileProvider,
                    IFilesystemCache pWriter,
                    int pMinZoomLevel,
                    int pMaxZoomLevel)
             throws TileSourcePolicyException

See https://github.com/osmdroid/osmdroid/issues/619

Throws:

TileSourcePolicyException

Since:

5.6.5

CacheManager

public CacheManager(ITileSource pTileSource,
                    IFilesystemCache pWriter,
                    int pMinZoomLevel,
                    int pMaxZoomLevel)
             throws TileSourcePolicyException

Throws:

TileSourcePolicyException

Since:

6.0

Method Detail

getPendingJobs

public int getPendingJobs()

Returns:

Since:

5.6.3

getMapTileFromCoordinates

@Deprecated
public static Point getMapTileFromCoordinates(double aLat,
                                                           double aLon,
                                                           int zoom)

Deprecated. Use TileSystem.getTileXFromLongitude(double, int) and TileSystem.getTileYFromLatitude(double, int) instead

getCoordinatesFromMapTile

@Deprecated
public static GeoPoint getCoordinatesFromMapTile(int x,
                                                              int y,
                                                              int zoom)

Deprecated. Use TileSystem.getLatitudeFromTileY(int, int) and TileSystem.getLongitudeFromTileX(int, int) instead

getFileName

public static File getFileName(ITileSource tileSource,
                               long pMapTileIndex)

loadTile

public boolean loadTile(OnlineTileSourceBase tileSource,
                        long pMapTileIndex)

Returns:

true if success, false if error

forceLoadTile

public boolean forceLoadTile(OnlineTileSourceBase tileSource,
                             long pMapTileIndex)

Actual tile download, regardless of the tile being already present in the cache

Returns:

true if success, false if error

Since:

5.6.5

deleteTile

public boolean deleteTile(long pMapTileIndex)

checkTile

public boolean checkTile(long pMapTileIndex)

isTileToBeDownloaded

public boolean isTileToBeDownloaded(ITileSource pTileSource,
                                    long pMapTileIndex)

"Should we download this tile?", either because it's not cached yet or because it's expired

Since:

5.6.5

getTilesCoverage

public static List<Long> getTilesCoverage(BoundingBox pBB,
                                          int pZoomMin,
                                          int pZoomMax)

Computes the theoretical tiles covered by the bounding box

Returns:

list of tiles, sorted by ascending zoom level

getTilesCoverage

public static Collection<Long> getTilesCoverage(BoundingBox pBB,
                                                int pZoomLevel)

Computes the theoretical tiles covered by the bounding box

Returns:

list of tiles for that zoom level, without any specific order

getTilesCoverageIterable

static IterableWithSize<Long> getTilesCoverageIterable(BoundingBox pBB,
                                                       int pZoomMin,
                                                       int pZoomMax)

Iterable returning tiles covered by the bounding box sorted by ascending zoom level

Parameters:

pBB - the given bounding box

pZoomMin - the given minimum zoom level

pZoomMax - the given maximum zoom level

Returns:

the iterable described above

getTilesRect

public static Rect getTilesRect(BoundingBox pBB,
                                int pZoomLevel)

Retrieve upper left and lower right points(exclusive) corresponding to the tiles coverage for the selected zoom level.

Parameters:

pBB - the given bounding box

pZoomLevel - the given zoom level

Returns:

the Rect reflecting the tiles coverage

getTilesCoverage

public static List<Long> getTilesCoverage(ArrayList<GeoPoint> pGeoPoints,
                                          int pZoomMin,
                                          int pZoomMax)

Computes the theoretical tiles covered by the list of points

Returns:

list of tiles, sorted by ascending zoom level

getTilesCoverage

public static Collection<Long> getTilesCoverage(ArrayList<GeoPoint> pGeoPoints,
                                                int pZoomLevel)

Computes the theoretical tiles covered by the list of points Calculation done based on http://www.movable-type.co.uk/scripts/latlong.html

possibleTilesInArea

public int possibleTilesInArea(BoundingBox pBB,
                               int pZoomMin,
                               int pZoomMax)

Returns:

the theoretical number of tiles in the specified area

possibleTilesCovered

public int possibleTilesCovered(ArrayList<GeoPoint> pGeoPoints,
                                int pZoomMin,
                                int pZoomMax)

Returns:

the theoretical number of tiles covered by the list of points Calculation done based on http://www.movable-type.co.uk/scripts/latlong.html

execute

public CacheManager.CacheManagerTask execute(CacheManager.CacheManagerTask pTask)

downloadAreaAsync

public CacheManager.CacheManagerTask downloadAreaAsync(Context ctx,
                                                       BoundingBox bb,
                                                       int zoomMin,
                                                       int zoomMax)

Download in background all tiles of the specified area in osmdroid cache.

Parameters:

ctx -

bb -

zoomMin -

zoomMax -

downloadAreaAsync

public CacheManager.CacheManagerTask downloadAreaAsync(Context ctx,
                                                       ArrayList<GeoPoint> geoPoints,
                                                       int zoomMin,
                                                       int zoomMax)

Download in background all tiles of the specified area in osmdroid cache.

Parameters:

ctx -

geoPoints -

zoomMin -

zoomMax -

downloadAreaAsync

public CacheManager.CacheManagerTask downloadAreaAsync(Context ctx,
                                                       BoundingBox bb,
                                                       int zoomMin,
                                                       int zoomMax,
                                                       CacheManager.CacheManagerCallback callback)

Download in background all tiles of the specified area in osmdroid cache.

Parameters:

ctx -

bb -

zoomMin -

zoomMax -

downloadAreaAsync

public CacheManager.CacheManagerTask downloadAreaAsync(Context ctx,
                                                       ArrayList<GeoPoint> geoPoints,
                                                       int zoomMin,
                                                       int zoomMax,
                                                       CacheManager.CacheManagerCallback callback)

Download in background all tiles covered by the GePoints list in osmdroid cache.

Parameters:

ctx -

geoPoints -

zoomMin -

zoomMax -

downloadAreaAsyncNoUI

public CacheManager.CacheManagerTask downloadAreaAsyncNoUI(Context ctx,
                                                           ArrayList<GeoPoint> geoPoints,
                                                           int zoomMin,
                                                           int zoomMax,
                                                           CacheManager.CacheManagerCallback callback)

Download in background all tiles covered by the GeoPoints list in osmdroid cache without a user interface.

Parameters:

ctx -

geoPoints -

zoomMin -

zoomMax -

Since:

downloadAreaAsyncNoUI

public CacheManager.CacheManagerTask downloadAreaAsyncNoUI(Context ctx,
                                                           BoundingBox bb,
                                                           int zoomMin,
                                                           int zoomMax,
                                                           CacheManager.CacheManagerCallback callback)

Download in background all tiles of the specified area in osmdroid cache without a user interface.

Parameters:

ctx -

bb -

zoomMin -

zoomMax -

Since:

5.3

cancelAllJobs

public void cancelAllJobs()

cancels all tasks

Since:

5.6.3

downloadAreaAsync

public CacheManager.CacheManagerTask downloadAreaAsync(Context ctx,
                                                       List<Long> pTiles,
                                                       int zoomMin,
                                                       int zoomMax)

Download in background all tiles of the specified area in osmdroid cache.

Parameters:

ctx -

pTiles -

zoomMin -

zoomMax -

setVerifyCancel

public void setVerifyCancel(boolean state)

getVerifyCancel

public boolean getVerifyCancel()

getDownloadingDialog

public CacheManager.CacheManagerDialog getDownloadingDialog(Context pCtx,
                                                            CacheManager.CacheManagerTask pTask)

getCleaningDialog

public CacheManager.CacheManagerDialog getCleaningDialog(Context pCtx,
                                                         CacheManager.CacheManagerTask pTask)

getDownloadingAction

public CacheManager.CacheManagerAction getDownloadingAction()

getCleaningAction

public CacheManager.CacheManagerAction getCleaningAction()

cleanAreaAsync

public CacheManager.CacheManagerTask cleanAreaAsync(Context ctx,
                                                    BoundingBox bb,
                                                    int zoomMin,
                                                    int zoomMax)

Remove all cached tiles in the specified area.

Parameters:

ctx -

bb -

zoomMin -

zoomMax -

cleanAreaAsync

public CacheManager.CacheManagerTask cleanAreaAsync(Context ctx,
                                                    ArrayList<GeoPoint> geoPoints,
                                                    int zoomMin,
                                                    int zoomMax)

Remove all cached tiles covered by the GeoPoints list.

Parameters:

ctx -

geoPoints -

zoomMin -

zoomMax -

cleanAreaAsync

public CacheManager.CacheManagerTask cleanAreaAsync(Context ctx,
                                                    List<Long> tiles,
                                                    int zoomMin,
                                                    int zoomMax)

Remove all cached tiles in the specified area.

extendedBoundsFromGeoPoints

public BoundingBox extendedBoundsFromGeoPoints(ArrayList<GeoPoint> geoPoints,
                                               int minZoomLevel)

currentCacheUsage

public long currentCacheUsage()

Returns:

volume currently use in the osmdroid local filesystem cache, in bytes. Note that this method currently takes a while.

cacheCapacity

public long cacheCapacity()

Returns:

the capacity of the osmdroid local filesystem cache, in bytes. This capacity is currently a hard-coded constant inside osmdroid.

directorySize

public long directorySize(File pDirectory)

Returns:

the total size of a directory and of its whole content, recursively

setTileDownloader

public void setTileDownloader(TileDownloader pTileDownloader)

Since:

6.0.2