com.here.android.mpa.mapping

Class UrlMapRasterTileSourceBase

java.lang.Object

com.here.android.mpa.mapping.MapRasterTileSource

com.here.android.mpa.mapping.UrlMapRasterTileSourceBase

public abstract class UrlMapRasterTileSourceBase
extends MapRasterTileSource

Represents an abstract base class for URL map raster tile sources. Extend this class and implement the getUrl(int, int, int) method to create custom URL raster tile sources.

Nested Class Summary

Nested classes/interfaces inherited from class com.here.android.mpa.mapping.MapRasterTileSource

MapRasterTileSource.MapTileSystemHelper, MapRasterTileSource.TileResult

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UrlMapRasterTileSourceBase()

Method Summary

Modifier and Type	Method and Description
MapRasterTileSource.TileResult	getTileWithError(int x, int y, int zoomLevel) UrlMapRasterTileSourceBase will only retrieve tile data using the source URL.
abstract java.lang.String	getUrl(int x, int y, int zoomLevel) Gets the URL representing the source of the specified raster tile image.
boolean	hasTile(int x, int y, int zoomLevel) UrlMapRasterTileSourceBase will only retrieve tile data using the source URL.

Methods inherited from class com.here.android.mpa.mapping.MapRasterTileSource

getBoundingArea, getCacheExpiration, getZIndex, hideAtZoomLevel, hideAtZoomRange, isCachingEnabled, isShownAtZoomLevel, setBoundingArea, setCacheExpiration, setCachePrefix, setCachingEnabled, setZIndex, showAtZoomLevel, showAtZoomRange

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlMapRasterTileSourceBase

protected UrlMapRasterTileSourceBase()

Method Detail

getUrl

public abstract java.lang.String getUrl(int x,
                                        int y,
                                        int zoomLevel)

Gets the URL representing the source of the specified raster tile image.

Note: implementations of raster tile sources must override this method to provide a complete URL string pointing to the raster tile image.

Parameters:

x - A current raster tile's X-coordinate

y - A current raster tile's Y-coordinate

zoomLevel - A current raster tile's zoom level

Returns:

The URL source for the raster tile image. Return null if an URL cannot be created.

hasTile

public final boolean hasTile(int x,
                             int y,
                             int zoomLevel)

UrlMapRasterTileSourceBase will only retrieve tile data using the source URL. So hasTile always returned false.

Specified by:

hasTile in class MapRasterTileSource

Parameters:

x - X coordinate

y - Y coordinate

zoomLevel - zoom level

Returns:

true if the tile exists, false otherwise

getTileWithError

public final MapRasterTileSource.TileResult getTileWithError(int x,
                                                             int y,
                                                             int zoomLevel)

UrlMapRasterTileSourceBase will only retrieve tile data using the source URL. A TileResult.getData() always returns null and TileResult.getError() always returns MapRasterTileSource.TileResult.Error.NONE.

Overrides:

getTileWithError in class MapRasterTileSource

Parameters:

x - X coordinate

y - Y coordinate

zoomLevel - zoom level

Returns:

A TileResult representing tile data and operation error. Check TileResult#getError() to check for error. Check TileResult#getData() to get RasterTile