org.geotools.ows.wmts.client

Class WMTSTileService

Object

TileService

WMTSTileService

All Implemented Interfaces:

ImageLoader

public class WMTSTileService
extends TileService

A tile service for a single matrix set of a WMTS servers.

An instance of this class is tied to a single layer, style and matrixset.

Use WebMapTileServer to negotiate capabilities, or specifying other properties

Author:

ian, Emanuele Tajariol (etj at geo-solutions dot it)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIMENSION_ELEVATION Deprecated.
static String	DIMENSION_TIME Deprecated.
static String	EXTRA_HEADERS
protected static Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
WMTSTileService(String templateURL, WMTSLayer layer, TileMatrixSet tileMatrixSet) Creates a WMTSTileService based on the templateURL.
WMTSTileService(String templateURL, WMTSLayer layer, TileMatrixSet tileMatrixSet, HTTPClient client) create a service directly with out parsing the capabilties again.
WMTSTileService(String templateURL, WMTSServiceType type, WMTSLayer layer, String styleName, TileMatrixSet tileMatrixSet) create a service directly with out parsing the capabilities again.
WMTSTileService(String templateURL, WMTSServiceType type, WMTSLayer layer, String styleName, TileMatrixSet tileMatrixSet, HTTPClient client) create a service directly with out parsing the capabilities again.

Method Summary

Modifier and Type	Method and Description
protected Tile	addTileToCache(Tile tile) Add a tile to the cache.
Set<Tile>	findTilesInExtent(ReferencedEnvelope requestedExtent, double scaleFactor, boolean recommendedZoomLevel, int maxNumberOfTiles)
ReferencedEnvelope	getBounds()
Map<String,String>	getDimensions() Deprecated. Dimensions should be a part of templateUrl
Map<String,Object>	getExtrainfo() A place to put any Header that should be sent in http calls.
String	getFormat() Deprecated.
String	getLayerName() Deprecated.
TileMatrixSet	getMatrixSet()
TileMatrixSetLink	getMatrixSetLink()
CoordinateReferenceSystem	getProjectedTileCrs() The projection the tiles are drawn in.
protected ReferencedEnvelope	getReqExtentInTileCrs(ReferencedEnvelope requestedExtent)
double[]	getScaleList() Returns a list that represents a mapping between zoom-levels and map scale.
String	getStyleName() Deprecated.
String	getTemplateURL() Deprecated.
TileFactory	getTileFactory() Returns the TileFactory which is used to call the method getTileFromCoordinate().
TileMatrix	getTileMatrix(int zoomLevel)
String	getTileMatrixSetName() Deprecated.
WMTSServiceType	getType() Deprecated.
WMTSZoomLevel	getZoomLevel(int zoom)
void	setFormat(String format) Deprecated. include in templateURL
void	setMatrixSet(TileMatrixSet matrixSet)
void	setStyleName(String styleName) Deprecated.
void	setTemplateURL(String templateURL) Deprecated.
void	setTileMatrixSetName(String tileMatrixSetName) Deprecated.
void	setType(WMTSServiceType type) Deprecated.

Methods inherited from class TileService

createSafeEnvelopeInWGS84, getBaseUrl, getHttpClient, getMaxZoomLevel, getMinZoomLevel, getName, getTileCrs, getTileHeight, getTileWidth, getZoomLevelFromMapScale, getZoomLevelToUse, loadImageTileImage, toString

Methods inherited from class Object

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

Field Detail

LOGGER

protected static final Logger LOGGER

DIMENSION_TIME

@Deprecated
public static final String DIMENSION_TIME

Deprecated.

See Also:

Constant Field Values

DIMENSION_ELEVATION

@Deprecated
public static final String DIMENSION_ELEVATION

Deprecated.

See Also:

Constant Field Values

EXTRA_HEADERS

public static final String EXTRA_HEADERS

See Also:

Constant Field Values

Constructor Detail

WMTSTileService

public WMTSTileService(String templateURL,
                       WMTSServiceType type,
                       WMTSLayer layer,
                       String styleName,
                       TileMatrixSet tileMatrixSet)

create a service directly with out parsing the capabilities again.

This constructor should not be used. A proper formatted templateURL should be used instead.

Parameters:

templateURL - - where to ask for tiles

type - - KVP or REST

layer - - the layer to request

styleName - - name of the style to use?

tileMatrixSet - - the tile matrix set to use

WMTSTileService

public WMTSTileService(String templateURL,
                       WMTSServiceType type,
                       WMTSLayer layer,
                       String styleName,
                       TileMatrixSet tileMatrixSet,
                       HTTPClient client)

create a service directly with out parsing the capabilities again.

This constructor should not be used. A proper formatted templateURL should be used instead.

Parameters:

templateURL - - where to ask for tiles

type - - KVP or REST

layer - - layer to request

styleName - - name of the style to use?

tileMatrixSet - - matrixset

client - - HttpClient instance to use for Tile requests.

WMTSTileService

public WMTSTileService(String templateURL,
                       WMTSLayer layer,
                       TileMatrixSet tileMatrixSet)

Creates a WMTSTileService based on the templateURL. Using extent given by layer and tileMatrixSet.

Parameters:

templateURL -

layer -

tileMatrixSet -

WMTSTileService

public WMTSTileService(String templateURL,
                       WMTSLayer layer,
                       TileMatrixSet tileMatrixSet,
                       HTTPClient client)

create a service directly with out parsing the capabilties again.

Parameters:

templateURL - - where to ask for tiles

layer - - layer to request

tileMatrixSet - - matrixset

client - - HttpClient instance to use for Tile requests.

Method Detail

getReqExtentInTileCrs

protected ReferencedEnvelope getReqExtentInTileCrs(ReferencedEnvelope requestedExtent)

findTilesInExtent

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

Overrides:

findTilesInExtent in class TileService

addTileToCache

protected Tile addTileToCache(Tile tile)

Add a tile to the cache.

At the moment we are delegating the cache to the super class, which handles the cache as a soft cache. The soft cache has an un-controllable time to live, could last a split seconds or 100 years. However, WMTS services normally come with caching headers of some sort, e.g., do not cache, or keep for 1 hour, or 6 months and so on.

TODO: The code should account for that.

Overrides:

addTileToCache in class TileService

getType

@Deprecated
public WMTSServiceType getType()

Deprecated.

Returns:

the type

setType

@Deprecated
public void setType(WMTSServiceType type)

Deprecated.

Parameters:

type - the type to set

getLayerName

@Deprecated
public String getLayerName()

Deprecated.

Returns:

the layerName

getStyleName

@Deprecated
public String getStyleName()

Deprecated.

Returns:

the styleName

setStyleName

@Deprecated
public void setStyleName(String styleName)

Deprecated.

Parameters:

styleName - the styleName to set

getScaleList

public double[] getScaleList()

Description copied from class: TileService

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

Specified by:

getScaleList in class TileService

Returns:

mapping between zoom-levels and map scale

getBounds

public ReferencedEnvelope getBounds()

Specified by:

getBounds in class TileService

getProjectedTileCrs

public CoordinateReferenceSystem getProjectedTileCrs()

Description copied from class: TileService

The projection the tiles are drawn in.

Specified by:

getProjectedTileCrs in class TileService

getTileFactory

public TileFactory getTileFactory()

Description copied from class: TileService

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

Specified by:

getTileFactory in class TileService

getTileMatrixSetName

@Deprecated
public String getTileMatrixSetName()

Deprecated.

Returns:

the tileMatrixSetName

setTileMatrixSetName

@Deprecated
public void setTileMatrixSetName(String tileMatrixSetName)

Deprecated.

Parameters:

tileMatrixSetName - the tileMatrixSetName to set

getMatrixSetLink

public TileMatrixSetLink getMatrixSetLink()

getTemplateURL

@Deprecated
public String getTemplateURL()

Deprecated.

Returns:

the templateURL

setTemplateURL

@Deprecated
public void setTemplateURL(String templateURL)

Deprecated.

Parameters:

templateURL - the templateURL to set

getTileMatrix

public TileMatrix getTileMatrix(int zoomLevel)

getMatrixSet

public TileMatrixSet getMatrixSet()

Returns:

the matrixSet

setMatrixSet

public void setMatrixSet(TileMatrixSet matrixSet)

Parameters:

matrixSet - the matrixSet to set

getFormat

@Deprecated
public String getFormat()

Deprecated.

Returns:

setFormat

@Deprecated
public void setFormat(String format)

Deprecated. include in templateURL

Parameters:

format - the format to set

getZoomLevel

public WMTSZoomLevel getZoomLevel(int zoom)

getDimensions

@Deprecated
public Map<String,String> getDimensions()

Deprecated. Dimensions should be a part of templateUrl

getExtrainfo

public Map<String,Object> getExtrainfo()

A place to put any Header that should be sent in http calls.

Returns: