org.geotools.tile

Class TileService

Object

TileService

Direct Known Subclasses:

WebMercatorTileService, WMTSTileService

public abstract class TileService
extends Object

A TileService represent the class of objects that serve map tiles.

TileServices must at least have a name and a base URL.

Since:

12

Author:

to.srwn, Ugo Taddei

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TileService(String name, String baseURL) Create a new TileService with a name and a base URL

Method Summary

Modifier and Type	Method and Description
protected Tile	addTileToCache(Tile tile) Add a tile to the cache.
static ReferencedEnvelope	createSafeEnvelopeInWGS84(ReferencedEnvelope _mapExtent)
Set<Tile>	findTilesInExtent(ReferencedEnvelope _mapExtent, int scaleFactor, boolean recommendedZoomLevel, int maxNumberOfTiles)
String	getBaseUrl() Returns the prefix of an tile-url, e.g.: http://tile.openstreetmap.org/
abstract ReferencedEnvelope	getBounds()
int	getMaxZoomLevel() Returns the highest zoom-level number from the scaleList.
int	getMinZoomLevel() Returns the lowest zoom-level number from the scaleList.
String	getName()
abstract CoordinateReferenceSystem	getProjectedTileCrs() The projection the tiles are drawn in.
abstract double[]	getScaleList() Returns a list that represents a mapping between zoom-levels and map scale.
CoordinateReferenceSystem	getTileCrs() Deprecated. is it really meaningful?
abstract TileFactory	getTileFactory() Returns the TileFactory which is used to call the method getTileFromCoordinate().
int	getTileHeight()
int	getTileWidth()
int	getZoomLevelFromMapScale(ScaleZoomLevelMatcher zoomLevelMatcher, int scaleFactor) Translates the map scale into a zoom-level for the map services.
int	getZoomLevelToUse(ScaleZoomLevelMatcher zoomLevelMatcher, int scaleFactor, boolean useRecommended) Returns the zoom-level that should be used to fetch the tiles.
String	toString()

Methods inherited from class Object

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

Field Detail

LOGGER

protected static final Logger LOGGER

Constructor Detail

TileService

protected TileService(String name,
                      String baseURL)

Create a new TileService with a name and a base URL

Parameters:

name - the name. Cannot be null.

baseURL - the base URL. This is a string representing the common part of the URL for all this service's tiles. Cannot be null. Note that this constructor doesn't ensure that the URL is well-formed.

Method Detail

getName

public String getName()

getTileWidth

public int getTileWidth()

getTileHeight

public int getTileHeight()

getBaseUrl

public String getBaseUrl()

Returns the prefix of an tile-url, e.g.: http://tile.openstreetmap.org/

Returns:

getTileCrs

@Deprecated
public CoordinateReferenceSystem getTileCrs()

Deprecated. is it really meaningful?

The CRS that is used when the extent is cut in tiles.

getZoomLevelFromMapScale

public int getZoomLevelFromMapScale(ScaleZoomLevelMatcher zoomLevelMatcher,
                                    int scaleFactor)

Translates the map scale into a zoom-level for the map services.

The scale-factor (0-100) decides whether the tiles will be scaled down (100) or scaled up (0).

Parameters:

scaleFactor - Scale-factor (0-100)

Returns:

Zoom-level

getZoomLevelToUse

public int getZoomLevelToUse(ScaleZoomLevelMatcher zoomLevelMatcher,
                             int scaleFactor,
                             boolean useRecommended)

Returns the zoom-level that should be used to fetch the tiles.

Parameters:

scale -

scaleFactor -

useRecommended - always use the calculated zoom-level, do not use the one the user selected

Returns:

getMinZoomLevel

public int getMinZoomLevel()

Returns the lowest zoom-level number from the scaleList.

Parameters:

scaleList -

Returns:

getMaxZoomLevel

public int getMaxZoomLevel()

Returns the highest zoom-level number from the scaleList.

Parameters:

scaleList -

Returns:

findTilesInExtent

public Set<Tile> findTilesInExtent(ReferencedEnvelope _mapExtent,
                                   int scaleFactor,
                                   boolean recommendedZoomLevel,
                                   int maxNumberOfTiles)

addTileToCache

protected Tile addTileToCache(Tile tile)

Add a tile to the cache.

The cache used here is a soft cache, which has an un-controllable time to live (could last a split seconds or 100 years).

Subclasses services (such as WMTS) may have some more hints about the tile TTL, so a more controllable cache should be implemented in these cases.

getScaleList

public abstract double[] getScaleList()

Returns a list that represents a mapping between zoom-levels and map scale.

Array index: zoom-level Value at index: map scale High zoom-level -> more detailed map Low zoom-level -> less detailed map

Returns:

mapping between zoom-levels and map scale

getBounds

public abstract ReferencedEnvelope getBounds()

getProjectedTileCrs

public abstract CoordinateReferenceSystem getProjectedTileCrs()

The projection the tiles are drawn in.

getTileFactory

public abstract TileFactory getTileFactory()

Returns the TileFactory which is used to call the method getTileFromCoordinate().

createSafeEnvelopeInWGS84

public static final ReferencedEnvelope createSafeEnvelopeInWGS84(ReferencedEnvelope _mapExtent)

toString

public String toString()

Overrides:

toString in class Object