org.osmdroid.tileprovider.tilesource

Interface ITileSource

All Known Implementing Classes:

BingMapTileSource, BitmapTileSourceBase, CloudmadeTileSource, FileBasedTileSource, HEREWeGoTileSource, MapBoxTileSource, MapQuestTileSource, OnlineTileSourceBase, QuadTreeTileSource, ThunderforestTileSource, TMSOnlineTileSourceBase, XYTileSource

public interface ITileSource

Method Summary

Modifier and Type	Method and Description
String	getCopyrightNotice() Returns an I18N sensitive string representing the copy right notice (if any) of the tile source
Drawable	getDrawable(InputStream aTileInputStream) Get a rendered Drawable from the specified InputStream.
Drawable	getDrawable(String aFilePath) Get a rendered Drawable from the specified file path.
int	getMaximumZoomLevel() Get the maximum zoom level this tile source can provide.
int	getMinimumZoomLevel() Get the minimum zoom level this tile source can provide.
String	getTileRelativeFilenameString(long pMapTileIndex) Get a unique file path for the tile.
int	getTileSizePixels() Get the tile size in pixels this tile source provides.
String	name() A human-friendly name for this tile source
int	ordinal() Deprecated.

Method Detail

ordinal

@Deprecated
int ordinal()

Deprecated.

An ordinal identifier for this tile source

Returns:

the ordinal value

name

String name()

A human-friendly name for this tile source

Returns:

the tile source name

getTileRelativeFilenameString

String getTileRelativeFilenameString(long pMapTileIndex)

Get a unique file path for the tile. This file path may be used to store the tile on a file system and performance considerations should be taken into consideration. It can include multiple paths. It should not begin with a leading path separator.

Parameters:

pMapTileIndex - the tile

Returns:

the unique file path

getDrawable

Drawable getDrawable(String aFilePath)
              throws BitmapTileSourceBase.LowMemoryException

Get a rendered Drawable from the specified file path.

Parameters:

aFilePath - a file path

Returns:

the rendered Drawable

Throws:

BitmapTileSourceBase.LowMemoryException

getDrawable

Drawable getDrawable(InputStream aTileInputStream)
              throws BitmapTileSourceBase.LowMemoryException

Get a rendered Drawable from the specified InputStream.

Parameters:

aTileInputStream - an InputStream

Returns:

the rendered Drawable

Throws:

BitmapTileSourceBase.LowMemoryException

getMinimumZoomLevel

int getMinimumZoomLevel()

Get the minimum zoom level this tile source can provide.

Returns:

the minimum zoom level

getMaximumZoomLevel

int getMaximumZoomLevel()

Get the maximum zoom level this tile source can provide.

Returns:

the maximum zoom level

getTileSizePixels

int getTileSizePixels()

Get the tile size in pixels this tile source provides.

Returns:

the tile size in pixels

getCopyrightNotice

String getCopyrightNotice()

Returns an I18N sensitive string representing the copy right notice (if any) of the tile source

Returns:

a string or null

Since:

5.6.1