org.osmdroid.tileprovider.constants

Class OpenStreetMapTileProviderConstants

java.lang.Object

org.osmdroid.tileprovider.constants.OpenStreetMapTileProviderConstants

public class OpenStreetMapTileProviderConstants
extends Object

This class contains constants used by the tile provider.

Author:

Neil Boyd

Field Summary

Fields

Modifier and Type	Field and Description
static int	CACHE_MAPTILECOUNT_DEFAULT Initial tile cache size.
static boolean	DEBUG_TILE_PROVIDERS
static boolean	DEBUGMODE
static long	DEFAULT_MAXIMUM_CACHED_FILE_AGE
static String	HTTP_EXPIRES_HEADER
static String	HTTP_EXPIRES_HEADER_FORMAT
static SimpleDateFormat	HTTP_HEADER_SDF used for HTTP expires headers
static int	MINIMUM_ZOOMLEVEL Minimum Zoom Level
static short	NUMBER_OF_TILE_FILESYSTEM_THREADS
static long	ONE_DAY
static long	ONE_HOUR
static long	ONE_MINUTE
static long	ONE_SECOND
static long	ONE_WEEK
static long	ONE_YEAR
static short	TILE_DOWNLOAD_MAXIMUM_QUEUE_SIZE
static long	TILE_EXPIRY_TIME_MILLISECONDS 30 days
static short	TILE_FILESYSTEM_MAXIMUM_QUEUE_SIZE
static long	TILE_MAX_CACHE_SIZE_BYTES default is 600 Mb
static File	TILE_PATH_BASE Base path for tiles.
static String	TILE_PATH_EXTENSION add an extension to files on sdcard so that gallery doesn't index them
static long	TILE_TRIM_CACHE_SIZE_BYTES default is 500 Mb
static String	USER_AGENT

Constructor Summary

Constructors

Constructor and Description
OpenStreetMapTileProviderConstants()

Method Summary

Methods

Modifier and Type	Method and Description
static File	getBasePath()
static int	getNumberOfTileDownloadThreads()
static String	getUserAgentValue() Enables you to get the value for HTTP user agents.
static void	setCachePath(String newFullPath) Change the root path of the osmdroid cache.
static void	setCacheSizes(long maxCacheSize, long trimCacheSize) Change the osmdroid tiles cache sizes.
void	setNumberOfTileDownloadThreads(int threads) Overrides the number of tile download threads.
static void	setOfflineMapsPath(String path) allows for altering the osmdroid_path variable, which controls the location of where to search for offline tile sources
static void	setUserAgentValue(String val) Enables you to override the default "osmdroid" value for HTTP user agents.

Methods inherited from class java.lang.Object

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

Field Detail

TILE_PATH_BASE

public static File TILE_PATH_BASE

Base path for tiles. /sdcard/osmdroid/tiles

DEBUGMODE

public static boolean DEBUGMODE

DEBUG_TILE_PROVIDERS

public static boolean DEBUG_TILE_PROVIDERS

USER_AGENT

public static String USER_AGENT

MINIMUM_ZOOMLEVEL

public static final int MINIMUM_ZOOMLEVEL

Minimum Zoom Level

See Also:

Constant Field Values

TILE_PATH_EXTENSION

public static final String TILE_PATH_EXTENSION

add an extension to files on sdcard so that gallery doesn't index them

See Also:

Constant Field Values

CACHE_MAPTILECOUNT_DEFAULT

public static final int CACHE_MAPTILECOUNT_DEFAULT

Initial tile cache size. The size will be increased as required by calling LRUMapTileCache.ensureCapacity(int) The tile cache will always be at least 3x3.

See Also:

Constant Field Values

NUMBER_OF_TILE_FILESYSTEM_THREADS

public static final short NUMBER_OF_TILE_FILESYSTEM_THREADS

See Also:

Constant Field Values

ONE_SECOND

public static final long ONE_SECOND

See Also:

Constant Field Values

ONE_MINUTE

public static final long ONE_MINUTE

See Also:

Constant Field Values

ONE_HOUR

public static final long ONE_HOUR

See Also:

Constant Field Values

ONE_DAY

public static final long ONE_DAY

See Also:

Constant Field Values

ONE_WEEK

public static final long ONE_WEEK

See Also:

Constant Field Values

ONE_YEAR

public static final long ONE_YEAR

See Also:

Constant Field Values

DEFAULT_MAXIMUM_CACHED_FILE_AGE

public static final long DEFAULT_MAXIMUM_CACHED_FILE_AGE

See Also:

Constant Field Values

TILE_DOWNLOAD_MAXIMUM_QUEUE_SIZE

public static final short TILE_DOWNLOAD_MAXIMUM_QUEUE_SIZE

See Also:

Constant Field Values

TILE_FILESYSTEM_MAXIMUM_QUEUE_SIZE

public static final short TILE_FILESYSTEM_MAXIMUM_QUEUE_SIZE

See Also:

Constant Field Values

TILE_EXPIRY_TIME_MILLISECONDS

public static final long TILE_EXPIRY_TIME_MILLISECONDS

30 days

See Also:

Constant Field Values

TILE_MAX_CACHE_SIZE_BYTES

public static long TILE_MAX_CACHE_SIZE_BYTES

default is 600 Mb

TILE_TRIM_CACHE_SIZE_BYTES

public static long TILE_TRIM_CACHE_SIZE_BYTES

default is 500 Mb

HTTP_EXPIRES_HEADER

public static final String HTTP_EXPIRES_HEADER

Since:

5.1

See Also:

Constant Field Values

HTTP_EXPIRES_HEADER_FORMAT

public static final String HTTP_EXPIRES_HEADER_FORMAT

Since:

5.1

See Also:

Constant Field Values

HTTP_HEADER_SDF

public static final SimpleDateFormat HTTP_HEADER_SDF

used for HTTP expires headers

Since:

5.1

Constructor Detail

OpenStreetMapTileProviderConstants

public OpenStreetMapTileProviderConstants()

Method Detail

getBasePath

public static File getBasePath()

getUserAgentValue

public static String getUserAgentValue()

Enables you to get the value for HTTP user agents. Used when downloading tiles

Returns:

Since:

5.0

setUserAgentValue

public static void setUserAgentValue(String val)

Enables you to override the default "osmdroid" value for HTTP user agents. Used when downloading tiles

Parameters:

val -

Since:

5.0

getNumberOfTileDownloadThreads

public static int getNumberOfTileDownloadThreads()

setNumberOfTileDownloadThreads

public void setNumberOfTileDownloadThreads(int threads)

Overrides the number of tile download threads. The default value is '2' conforming to OSM policy: http://wiki.openstreetmap.org/wiki/Tile_usage_policy Only use the value of '2' when connecting to OSM tile sources.

Parameters:

threads -

Since:

5.1

setCachePath

public static void setCachePath(String newFullPath)

Change the root path of the osmdroid cache. By default, it is defined in SD card, osmdroid directory.

Parameters:

newFullPath -

setCacheSizes

public static void setCacheSizes(long maxCacheSize,
                 long trimCacheSize)

Change the osmdroid tiles cache sizes. (note this represents size of the cache on disk, not in memory)

Parameters:

maxCacheSize - in Mb. Default is 600 Mb.

trimCacheSize - When the cache size exceeds maxCacheSize, tiles will be automatically removed to reach this target. In Mb. Default is 500 Mb.

Since:

4.4

setOfflineMapsPath

public static void setOfflineMapsPath(String path)

allows for altering the osmdroid_path variable, which controls the location of where to search for offline tile sources

Parameters:

path -