public class

WMTSServiceInfo

extends Object
java.lang.Object
   ↳ com.esri.core.ogc.wmts.WMTSServiceInfo

Class Overview

This class contains information on an OGC WMTS service. This includes the layers defined by the service and the tile matrices that define the layers. An instance of this class can be created by calling one of the static fetch methods that can be used to query service information from a given URL.

Summary

Public Constructors
WMTSServiceInfo(WebMapLayer layer)
WMTSServiceInfo()
Public Methods
void addLayer(String identifier, WMTSLayerInfo layer)
Internal use only.
void addTileMatrixSet(String identifier, WMTSTileMatrixSet tileMatrixSet)
Internal use only.
static WMTSServiceInfo fetch(String url)
Creates an instance of this class from information queried from the given URL.
static WMTSServiceInfo fetch(String url, UserCredentials credentials)
Creates an instance of this class from information queried from the given URL for a secured service.
static WMTSServiceInfo fetch(String url, UserCredentials credentials, WMTSServiceMode serviceMode)
Creates an instance of this class from information queried from the given URL for a secured service.
String getAbstract()
Gets abstract metadata from the WMTS service.
WMTSLayerInfo getLayerInfo(String identifier)
Retrieves the WMTSLayerInfo for the Layer specified by the identifier string.
List<WMTSLayerInfo> getLayerInfos()
Returns a WMTSLayerInfo for each Layer in the service.
String getServiceUrl()
WMTSTileMatrixSet getTileMatrixSet(String identifier)
Retrieves the WMTSTileMatrixSet for the Layer specified by the identifier string.
List<WMTSTileMatrixSet> getTileMatrixSets()
Get a list of tile matrix sets defined by the service.
String getTitle()
Gets title metadata of the WMTS service
String getVersion()
Gets the version of the WMTS service.
void setAbstract(String abstract1)
Internal use only.
void setKVPTileRequestURL(String requestUrl)
Internal use only.
void setTitle(String title)
Internal use only.
void setVersion(String version)
Internal use only.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public WMTSServiceInfo (WebMapLayer layer)

Parameters
layer WebMapLayer

public WMTSServiceInfo ()

Public Methods

public void addLayer (String identifier, WMTSLayerInfo layer)

Internal use only.

Parameters
identifier String
layer WMTSLayerInfo

public void addTileMatrixSet (String identifier, WMTSTileMatrixSet tileMatrixSet)

Internal use only.

Parameters
identifier String
tileMatrixSet WMTSTileMatrixSet

public static WMTSServiceInfo fetch (String url)

Creates an instance of this class from information queried from the given URL.

Note that if you are using the REST service mode rather than the KVP one, this URL should point to the service capabilities xml file. If you are using KVP mode, this should be the service base URL.

Parameters
url String: service URL
Returns
WMTSServiceInfo an instance of this class
Throws
Exception
Exception

public static WMTSServiceInfo fetch (String url, UserCredentials credentials)

Creates an instance of this class from information queried from the given URL for a secured service.

Note that if you are using the REST service mode rather than the KVP one, this URL should point to the service capabilities xml file. If you are using KVP mode, this should be the service base URL.

Parameters
url String: service URL
credentials UserCredentials: required to access the service
Returns
WMTSServiceInfo an instance of this class
Throws
Exception
Exception

public static WMTSServiceInfo fetch (String url, UserCredentials credentials, WMTSServiceMode serviceMode)

Creates an instance of this class from information queried from the given URL for a secured service. For a service that supports both REST and KVP modes, the mode can be set with the serviceMode parameter

Note that if you are using the REST service mode rather than the KVP one, the URL should point to the service capabilities xml file. If you are using KVP mode, this should be the service base URL.

Parameters
url String: service URL
credentials UserCredentials: required to access the service
serviceMode WMTSServiceMode: service mode to use
Returns
WMTSServiceInfo an instance of this class
Throws
Exception
Exception

public String getAbstract ()

Gets abstract metadata from the WMTS service.

Returns
String abstract metadata from the WMTS service

public WMTSLayerInfo getLayerInfo (String identifier)

Retrieves the WMTSLayerInfo for the Layer specified by the identifier string.

Parameters
identifier String: ID of layer info. to retrieve
Returns
WMTSLayerInfo requested layer info. or null if no match is found

public List<WMTSLayerInfo> getLayerInfos ()

Returns a WMTSLayerInfo for each Layer in the service.

Returns
List<WMTSLayerInfo> list of WMTSLayerInfo

public String getServiceUrl ()

Returns
String the service URL

public WMTSTileMatrixSet getTileMatrixSet (String identifier)

Retrieves the WMTSTileMatrixSet for the Layer specified by the identifier string.

Parameters
identifier String: ID of tile matrix set to retrieve
Returns
WMTSTileMatrixSet requested tile matrix set or null if no match is found

public List<WMTSTileMatrixSet> getTileMatrixSets ()

Get a list of tile matrix sets defined by the service.

Returns
List<WMTSTileMatrixSet> list of tile matrix sets defined by the service

public String getTitle ()

Gets title metadata of the WMTS service

Returns
String title metadata of the WMTS service

public String getVersion ()

Gets the version of the WMTS service. This will be 1.0.0 but may be others in future.

Returns
String version of the WMTS service

public void setAbstract (String abstract1)

Internal use only.

Parameters
abstract1 String

public void setKVPTileRequestURL (String requestUrl)

Internal use only.

Parameters
requestUrl String

public void setTitle (String title)

Internal use only.

Parameters
title String

public void setVersion (String version)

Internal use only.

Parameters
version String

public String toString ()

Returns
String