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.CacheManagerCallback
protected class	CacheManager.CacheManagerTask generic class for common code related to AsyncTask management
protected class	CacheManager.CleaningTask
protected class	CacheManager.DownloadingTask

Field Summary

Fields

Modifier and Type	Field and Description
protected MapView	mMapView
protected MapTileProviderBase	mTileProvider
protected IFilesystemCache	mTileWriter

Constructor Summary

Constructors

Constructor and Description
CacheManager(MapView mapView)
CacheManager(MapView mapView, IFilesystemCache writer)

Method Summary

Modifier and Type	Method and Description
long	cacheCapacity()
void	cleanAreaAsync(Context ctx, ArrayList<GeoPoint> geoPoints, int zoomMin, int zoomMax) Remove all cached tiles covered by the GeoPoints list.
void	cleanAreaAsync(Context ctx, BoundingBox bb, int zoomMin, int zoomMax) Remove all cached tiles in the specified area.
long	currentCacheUsage()
long	directorySize(File pDirectory)
void	downloadAreaAsync(Context ctx, ArrayList<GeoPoint> geoPoints, int zoomMin, int zoomMax) Download in background all tiles of the specified area in osmdroid cache.
void	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.
void	downloadAreaAsync(Context ctx, BoundingBox bb, int zoomMin, int zoomMax) Download in background all tiles of the specified area in osmdroid cache.
void	downloadAreaAsync(Context ctx, BoundingBox bb, int zoomMin, int zoomMax, CacheManager.CacheManagerCallback callback) Download in background all tiles of the specified area in osmdroid cache.
void	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.
void	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.
BoundingBox	extendedBoundsFromGeoPoints(ArrayList<GeoPoint> geoPoints, int minZoomLevel)
static GeoPoint	getCoordinatesFromMapTile(int x, int y, int zoom)
static File	getFileName(ITileSource tileSource, MapTile tile)
static Point	getMapTileFromCoordinates(double aLat, double aLon, int zoom)
boolean	loadTile(OnlineTileSourceBase tileSource, MapTile tile)
int	possibleTilesCovered(ArrayList<GeoPoint> geoPoints, int zoomMin, int zoomMax)
int	possibleTilesInArea(BoundingBox bb, int zoomMin, int zoomMax)
protected String	zoomMessage(int zoomLevel, int zoomMin, int zoomMax)

Methods inherited from class java.lang.Object

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

Field Detail

mTileProvider

protected final MapTileProviderBase mTileProvider

mTileWriter

protected final IFilesystemCache mTileWriter

mMapView

protected final MapView mMapView

Constructor Detail

CacheManager

public CacheManager(MapView mapView)

CacheManager

public CacheManager(MapView mapView,
                    IFilesystemCache writer)

Method Detail

getMapTileFromCoordinates

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

getCoordinatesFromMapTile

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

getFileName

public static File getFileName(ITileSource tileSource,
                               MapTile tile)

loadTile

public boolean loadTile(OnlineTileSourceBase tileSource,
                        MapTile tile)

Returns:

true if success, false if error

possibleTilesInArea

public int possibleTilesInArea(BoundingBox bb,
                               int zoomMin,
                               int zoomMax)

Returns:

the theoretical number of tiles in the specified area

possibleTilesCovered

public int possibleTilesCovered(ArrayList<GeoPoint> geoPoints,
                                int zoomMin,
                                int zoomMax)

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

zoomMessage

protected String zoomMessage(int zoomLevel,
                             int zoomMin,
                             int zoomMax)

downloadAreaAsync

public void 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 void 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 void 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 void 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 void 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 void 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

cleanAreaAsync

public void cleanAreaAsync(Context ctx,
                           BoundingBox bb,
                           int zoomMin,
                           int zoomMax)

Remove all cached tiles in the specified area.

Parameters:

ctx -

bb -

zoomMin -

zoomMax -

cleanAreaAsync

public void cleanAreaAsync(Context ctx,
                           ArrayList<GeoPoint> geoPoints,
                           int zoomMin,
                           int zoomMax)

Remove all cached tiles covered by the GeoPoints list.

Parameters:

ctx -

geoPoints -

zoomMin -

zoomMax -

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