MapRasterTileSource (HERE Android Premium SDK)

java.lang.Object
- com.here.android.mpa.mapping.MapRasterTileSource

Direct Known Subclasses:: UrlMapRasterTileSourceBase

public abstract class MapRasterTileSource
extends java.lang.Object

Represents an interface for a map raster tile source, used to render custom tile images on top of a Map.

Default attribute values are as follows:

 
  Overlay type:      RasterTileOverlayType.BACKGROUND_REPLACEMENT
  Transparency:      Transparency.TRANSPARENCY_ON
  Fallback:          Enabled
  Tile size:         256x256 pixels
  Valid zoom levels: 0-20 (all zoom levels)
  Bounding area:     Top-Left coordinate: (-180.0, 90.0), Bottom-Right coordinate: (179.99, -90.0)

Note: the currently supported pixel format for the tile images is RGBA.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MapRasterTileSource.MapTileSystemHelper` Represents a helper class for converting raster tile coordinates to other tile system values.
`static class`	`MapRasterTileSource.TileResult` Result class for getting tile.
`static class`	`MapRasterTileSource.Transparency` Represents values describing the state of raster tile image transparency.

Field Summary

Fields
Modifier and Type Field and Description

protected com.nokia.maps.MapRasterTileSourceImpl m_impl

Fields
Modifier and Type	Field and Description
`protected com.nokia.maps.MapRasterTileSourceImpl`	`m_impl`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MapRasterTileSource()

Constructors
Modifier	Constructor and Description
`protected`	`MapRasterTileSource()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`GeoBoundingBox`	`getBoundingArea()` Gets the `GeoBoundingBox` representing the bounding area within which raster tiles are visible.
`int`	`getCacheExpiration()` Get the cache expiration time
`MapOverlayType`	`getOverlayType()` Gets the raster tile overlay type.
`int`	`getTileSize()` Gets the raster tile image size, in pixels.
`MapRasterTileSource.TileResult`	`getTileWithError(int x, int y, int zoomLevel)` Method to be overwritten by derived class to get a tile.
`int`	`getZIndex()` Gets the current z-index (stacking order) of the `MapObject`.
`abstract boolean`	`hasTile(int x, int y, int zoomLevel)` Abstract method to be overwritten by derived class to check if a tile exists.
`boolean`	`hasTransparency()` Determines whether raster tile images have transparency enabled.
`MapRasterTileSource`	`hideAtZoomLevel(int level)` Hides tiles at the specified zoom level of the `Map`.
`MapRasterTileSource`	`hideAtZoomRange(int beginZoomLevel, int endZoomLevel)` Hides tiles within a given zoom level range of the `Map`.
`boolean`	`isCachingEnabled()` Get whether tiles are cached to the file system
`boolean`	`isFallbackEnabled()` Get whether fallback enabled for this tile.
`boolean`	`isShownAtZoomLevel(int zoomLevel)` Determines whether raster tiles are shown at the specified zoom level of the `Map`.
`MapRasterTileSource`	`setBoundingArea(GeoBoundingBox boundingBox)` Sets a bounding area within which raster tiles are visible.
`MapRasterTileSource`	`setCacheExpiration(int expireSeconds)` Set the cache expiration time
`MapRasterTileSource`	`setCachePrefix(java.lang.String cache)` Set the cache file prefix
`MapRasterTileSource`	`setCachingEnabled(boolean enabled)` Set whether tiles are cached to the file system.
`MapRasterTileSource`	`setFallbackEnabled(boolean enabled)` Specifies whether tiles from lower zoom levels can be rendered at the current zoom level in case a tile for the current zoom level is unavailable.
`MapRasterTileSource`	`setOverlayType(MapOverlayType newValue)` Sets a `MapOverlayType` for the `MapRasterTileSource`.
`MapRasterTileSource`	`setTileSize(int newValue)` Sets a size, in pixels, for the raster tile image.
`MapRasterTileSource`	`setTransparency(MapRasterTileSource.Transparency value)` Sets a `Transparency` state for raster tile image.
`MapRasterTileSource`	`setZIndex(int zIndex)` Sets a z-index (stacking order) value for the `MapObject`.
`MapRasterTileSource`	`showAtZoomLevel(int level)` Shows tiles at the specified zoom level of the `Map`.
`MapRasterTileSource`	`showAtZoomRange(int beginZoomLevel, int endZoomLevel)` Shows tiles within a given zoom level range of the `Map`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - m_impl
```
protected com.nokia.maps.MapRasterTileSourceImpl m_impl
```
    Audience:
    
    internal
- Constructor Detail
  - MapRasterTileSource
```
protected MapRasterTileSource()
```
- Method Detail
  - setOverlayType
```
public MapRasterTileSource setOverlayType(MapOverlayType newValue)
```
    Sets a MapOverlayType for the MapRasterTileSource.
    
    Parameters:
    
    newValue - A MapOverlayType value representing the desired raster tile overlay type
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - getOverlayType
```
public MapOverlayType getOverlayType()
```
    Gets the raster tile overlay type.
    
    Returns:
    
    The raster tile overlay type, a MapOverlayType value
  - setTransparency
```
public MapRasterTileSource setTransparency(MapRasterTileSource.Transparency value)
```
    Sets a Transparency state for raster tile image.
    
    Parameters:
    
    value - A Transparency value representing the desired raster tile image transparency
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - hasTransparency
```
public boolean hasTransparency()
```
    Determines whether raster tile images have transparency enabled.
    
    Returns:
    
    True if raster tile images are set to Transparency.TRANSPARENCY_ON, false otherwise
  - setTileSize
```
public MapRasterTileSource setTileSize(int newValue)
```
    Sets a size, in pixels, for the raster tile image.
    
    Parameters:
    
    newValue - Desired size of the raster tile image
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - getTileSize
```
public int getTileSize()
```
    Gets the raster tile image size, in pixels.
    
    Returns:
    
    The size of the raster tile image
  - setBoundingArea
```
public MapRasterTileSource setBoundingArea(GeoBoundingBox boundingBox)
```
    Sets a bounding area within which raster tiles are visible.
    
    Parameters:
    
    boundingBox - A GeoBoundingBox representing the bounding area of visible raster tiles
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - getBoundingArea
```
public GeoBoundingBox getBoundingArea()
```
    Gets the GeoBoundingBox representing the bounding area within which raster tiles are visible.
    
    Returns:
    
    The raster tile bounding area
  - hideAtZoomLevel
```
public MapRasterTileSource hideAtZoomLevel(int level)
```
    Hides tiles at the specified zoom level of the Map.
    
    Parameters:
    
    level - Zoom level at which tiles are to be hidden (see Map.getMaxZoomLevel() and Map.getMinZoomLevel() to retrieve the supported zoom level range)
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - showAtZoomLevel
```
public MapRasterTileSource showAtZoomLevel(int level)
```
    Shows tiles at the specified zoom level of the Map.
    
    Parameters:
    
    level - Zoom level at which tiles are to be shown (see Map.getMaxZoomLevel() and Map.getMinZoomLevel() to retrieve the supported zoom level range).
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - hideAtZoomRange
```
public MapRasterTileSource hideAtZoomRange(int beginZoomLevel,
                                           int endZoomLevel)
```
    Hides tiles within a given zoom level range of the Map.
    
    Parameters:
    
    beginZoomLevel - Zoom level representing the beginning of the range within which tiles are to be hidden (see Map.getMaxZoomLevel() and Map.getMinZoomLevel() to retrieve the supported zoom level range).
    
    endZoomLevel - Zoom level representing the end of the range within which tiles are to be hidden
    
    Returns:
    
    The updated MapRasterTileSource itself (see Map.getMaxZoomLevel() and Map.getMinZoomLevel() to retrieve the supported zoom level range).
  - showAtZoomRange
```
public MapRasterTileSource showAtZoomRange(int beginZoomLevel,
                                           int endZoomLevel)
```
    Shows tiles within a given zoom level range of the Map.
    
    Parameters:
    
    beginZoomLevel - Zoom level representing the beginning of the range within which tiles are to be shown (see Map.getMaxZoomLevel() and Map.getMinZoomLevel() to retrieve the supported zoom level range).
    
    endZoomLevel - Zoom level representing the end of the range within which tiles are to be shown
    
    Returns:
    
    The updated MapRasterTileSource itself (see Map.getMaxZoomLevel() and Map.getMinZoomLevel() to retrieve the supported zoom level range).
    
    Note:
    
    By default, tiles are shown for all zoom levels. Use MapRasterTileSource.hideAtZoomRange(int, int) to hide tiles on unnecessary zoom levels.
  - isShownAtZoomLevel
```
public boolean isShownAtZoomLevel(int zoomLevel)
```
    Determines whether raster tiles are shown at the specified zoom level of the Map.
    
    Parameters:
    
    zoomLevel - Zoom level to check for raster tile visibility (see Map.getZoomLevel() to retrieve the current zoom level of the Map).
    
    Returns:
    
    True if raster tiles are shown at the specified zoom level, false otherwise
  - setCachingEnabled
```
public MapRasterTileSource setCachingEnabled(boolean enabled)
```
    Set whether tiles are cached to the file system.
    
    Parameters:
    
    enabled - True to cache, False otherwise
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - isCachingEnabled
```
public boolean isCachingEnabled()
```
    Get whether tiles are cached to the file system
    
    Returns:
    
    True of tiles are cached. False otherwise.
  - setCachePrefix
```
public MapRasterTileSource setCachePrefix(java.lang.String cache)
```
    Set the cache file prefix
    
    Parameters:
    
    cache - Prefix tag
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - setCacheExpiration
```
public MapRasterTileSource setCacheExpiration(int expireSeconds)
```
    Set the cache expiration time
    
    Parameters:
    
    expireSeconds - Expire time in seconds
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - getCacheExpiration
```
public int getCacheExpiration()
```
    Get the cache expiration time
    
    Returns:
    
    Expire time in seconds
  - getZIndex
```
public int getZIndex()
```
    Gets the current z-index (stacking order) of the MapObject.
    
    Returns:
    
    The current ordinal z-index number
  - setZIndex
```
public MapRasterTileSource setZIndex(int zIndex)
```
    Sets a z-index (stacking order) value for the MapObject.
    
    Parameters:
    
    zIndex - A new z-index value for the MapObject, a 16-bit int within the range of [0..655xx]
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - setFallbackEnabled
```
public MapRasterTileSource setFallbackEnabled(boolean enabled)
```
    Specifies whether tiles from lower zoom levels can be rendered at the current zoom level in case a tile for the current zoom level is unavailable.
    
    Parameters:
    
    enabled - True to enable fallback, False otherwise.
    
    Returns:
    
    The updated MapRasterTileSource itself.
  - isFallbackEnabled
```
public boolean isFallbackEnabled()
```
    Get whether fallback enabled for this tile.
    
    Returns:
    
    True if fallback enabled, False otherwise.
  - hasTile
```
public abstract boolean hasTile(int x,
                                int y,
                                int zoomLevel)
```
    Abstract method to be overwritten by derived class to check if a tile exists.
    
    Parameters:
    
    x - X coordinate
    
    y - Y coordinate
    
    zoomLevel - zoom level
    
    Returns:
    
    true if the tile exists, false otherwise
  - getTileWithError
```
public MapRasterTileSource.TileResult getTileWithError(int x,
                                                       int y,
                                                       int zoomLevel)
```
    Method to be overwritten by derived class to get a tile.
    
    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

Class MapRasterTileSource

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_impl

Constructor Detail

MapRasterTileSource

Method Detail

setOverlayType

getOverlayType

setTransparency

hasTransparency

setTileSize

getTileSize

setBoundingArea

getBoundingArea

hideAtZoomLevel

showAtZoomLevel

hideAtZoomRange

showAtZoomRange

isShownAtZoomLevel

setCachingEnabled

isCachingEnabled

setCachePrefix

setCacheExpiration

getCacheExpiration

getZIndex

setZIndex

setFallbackEnabled

isFallbackEnabled

hasTile

getTileWithError