org.osmdroid.tileprovider.tilesource

Class BitmapTileSourceBase

java.lang.Object

org.osmdroid.tileprovider.tilesource.BitmapTileSourceBase

All Implemented Interfaces:

ITileSource

Direct Known Subclasses:

OnlineTileSourceBase

public abstract class BitmapTileSourceBase
extends Object
implements ITileSource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BitmapTileSourceBase.LowMemoryException

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mCopyright
protected String	mImageFilenameEnding
protected String	mName
protected Random	random

Constructor Summary

Constructors

Constructor and Description
BitmapTileSourceBase(String aName, int aZoomMinLevel, int aZoomMaxLevel, int aTileSizePixels, String aImageFilenameEnding) Constructor
BitmapTileSourceBase(String aName, int aZoomMinLevel, int aZoomMaxLevel, int aTileSizePixels, String aImageFilenameEnding, String aCopyrightNotice) Constructor

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 aFileInputStream) 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	imageFilenameEnding()
String	name() A human-friendly name for this tile source
int	ordinal() An ordinal identifier for this tile source
String	pathBase()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

mName

protected String mName

mCopyright

protected String mCopyright

mImageFilenameEnding

protected final String mImageFilenameEnding

random

protected final Random random

Constructor Detail

BitmapTileSourceBase

public BitmapTileSourceBase(String aName,
                            int aZoomMinLevel,
                            int aZoomMaxLevel,
                            int aTileSizePixels,
                            String aImageFilenameEnding)

Constructor

Parameters:

aName - a human-friendly name for this tile source. this name is also used on the file system, to keep the characters linux file system friendly

aZoomMinLevel - the minimum zoom level this tile source can provide

aZoomMaxLevel - the maximum zoom level this tile source can provide

aTileSizePixels - the tile size in pixels this tile source provides

aImageFilenameEnding - the file name extension used when constructing the filename

BitmapTileSourceBase

public BitmapTileSourceBase(String aName,
                            int aZoomMinLevel,
                            int aZoomMaxLevel,
                            int aTileSizePixels,
                            String aImageFilenameEnding,
                            String aCopyrightNotice)

Constructor

Parameters:

aName - a human-friendly name for this tile source. this name is also used on the file system, to keep the characters linux file system friendly

aZoomMinLevel - the minimum zoom level this tile source can provide

aZoomMaxLevel - the maximum zoom level this tile source can provide

aTileSizePixels - the tile size in pixels this tile source provides

aImageFilenameEnding - the file name extension used when constructing the filename

Method Detail

ordinal

public int ordinal()

Description copied from interface: ITileSource

An ordinal identifier for this tile source

Specified by:

ordinal in interface ITileSource

Returns:

the ordinal value

name

public String name()

Description copied from interface: ITileSource

A human-friendly name for this tile source

Specified by:

name in interface ITileSource

Returns:

the tile source name

pathBase

public String pathBase()

imageFilenameEnding

public String imageFilenameEnding()

getMinimumZoomLevel

public int getMinimumZoomLevel()

Description copied from interface: ITileSource

Get the minimum zoom level this tile source can provide.

Specified by:

getMinimumZoomLevel in interface ITileSource

Returns:

the minimum zoom level

getMaximumZoomLevel

public int getMaximumZoomLevel()

Description copied from interface: ITileSource

Get the maximum zoom level this tile source can provide.

Specified by:

getMaximumZoomLevel in interface ITileSource

Returns:

the maximum zoom level

getTileSizePixels

public int getTileSizePixels()

Description copied from interface: ITileSource

Get the tile size in pixels this tile source provides.

Specified by:

getTileSizePixels in interface ITileSource

Returns:

the tile size in pixels

toString

public String toString()

Overrides:

toString in class Object

getDrawable

public Drawable getDrawable(String aFilePath)
                     throws BitmapTileSourceBase.LowMemoryException

Description copied from interface: ITileSource

Get a rendered Drawable from the specified file path.

Specified by:

getDrawable in interface ITileSource

Parameters:

aFilePath - a file path

Returns:

the rendered Drawable

Throws:

BitmapTileSourceBase.LowMemoryException

getTileRelativeFilenameString

public String getTileRelativeFilenameString(long pMapTileIndex)

Description copied from interface: ITileSource

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.

Specified by:

getTileRelativeFilenameString in interface ITileSource

Parameters:

pMapTileIndex - the tile

Returns:

the unique file path

getDrawable

public Drawable getDrawable(InputStream aFileInputStream)
                     throws BitmapTileSourceBase.LowMemoryException

Description copied from interface: ITileSource

Get a rendered Drawable from the specified InputStream.

Specified by:

getDrawable in interface ITileSource

Parameters:

aFileInputStream - an InputStream

Returns:

the rendered Drawable

Throws:

BitmapTileSourceBase.LowMemoryException

getCopyrightNotice

public String getCopyrightNotice()

Description copied from interface: ITileSource

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

Specified by:

getCopyrightNotice in interface ITileSource

Returns:

a string or null