public class

WMTSLayerInfo

extends OwsDescription
java.lang.Object
   ↳ com.esri.core.ogc.OwsItem
     ↳ com.esri.core.ogc.OwsDescription
       ↳ com.esri.core.ogc.wmts.WMTSLayerInfo

Class Overview

This class contains information on a single WMTS layer provided by a WMTS service. Instances of the class can be retrieved by calling getLayerInfos() to get a list of all the layers or getLayerInfo(String) to get a specific layer's information by its ID.

Summary

Fields
protected WMSExtent latlonExtent The full extent of the layer in latitude and longitude.
protected WMSExtent mCurWgs84Extent The full extent of the layer in latitude and longitude.
[Expand]
Inherited Fields
From class com.esri.core.ogc.OwsItem
Public Constructors
WMTSLayerInfo(WMTSServiceInfo serviceInfo)
Internal use only.
WMTSLayerInfo(WMTSServiceInfo serviceInfo, WebMapLayer layer)
Create an instance of this class from a Webmap layer referencing a layer in a WMTS service.
Public Methods
void characters(char[] ch, int start, int length)
Called whenever there is any text associated with an element (rather than its attributes).
void endElement(String localName)
This method is called when we reach the end of the XML element with the given name.
WMTSStyle getDefaultStyle()
Gets the style marked as default for this layer.
WMSExtent getExtentByWkid(int wkid)
Gets the extent of this layer for the given spatial reference WKID.
List<WMSExtent> getExtents()
Gets a list of extents for this layer.
List<String> getFormats()
Get a list of resource mime types supported by this layer.
String getIdentifier()
Gets this layer's ID.
ResourceUrlInfo getResourceUrlByTypeAndFormat(String resourceType, String format)
Used to get a template URL for a specific resource with the given mime type.
List<ResourceUrlInfo> getResourceUrls()
Get a list of all resource URL templates associated with this layer.
WMTSServiceInfo getServiceInfo()
Gets the WMTSServiceInfo that this layer belongs to.
WMTSStyle getStyleById(String styleId)
Get a specific style with the given ID.
List<String> getStyleIds()
Gets a list of IDs for styles defined for this layer.
List<WMTSStyle> getStyles()
Gets a list of the styles defined for this layer.
List<WMTSLayerInfo> getSubLayers()
List<String> getTileMatrixSetIds()
Returns a list of Identifier strings of supported tile matrix sets for this layer.
WMTSTileMatrixSetLink getTileMatrixSetLinkById(String tileMatrixSetId)
Return a specific WMTSTileMatrixSetLink to match the given ID.
List<WMTSTileMatrixSetLink> getTileMatrixSetLinks()
Returns a list of WMTSTileMatrixSetLinks associated with this layer.
List<WMSExtent> getWgs84Extents()
Gets a list of extents for this layer that use the WGS84 spatial reference.
void startElement(String localName, Attributes atts)
This method is called to start processing the XML element with the given name.
[Expand]
Inherited Methods
From class com.esri.core.ogc.OwsDescription
From class com.esri.core.ogc.OwsItem
From class java.lang.Object

Fields

protected WMSExtent latlonExtent

The full extent of the layer in latitude and longitude.

protected WMSExtent mCurWgs84Extent

The full extent of the layer in latitude and longitude.

Public Constructors

public WMTSLayerInfo (WMTSServiceInfo serviceInfo)

Internal use only.

Parameters
serviceInfo WMTSServiceInfo: associated parent service

public WMTSLayerInfo (WMTSServiceInfo serviceInfo, WebMapLayer layer)

Create an instance of this class from a Webmap layer referencing a layer in a WMTS service.

Parameters
serviceInfo WMTSServiceInfo: service info of WMTS service
layer WebMapLayer: webmap layer referencing a layer in serviceInfo

Public Methods

public void characters (char[] ch, int start, int length)

Called whenever there is any text associated with an element (rather than its attributes). Note that this method may be called repeatedly for any particular element so any text here will be appended to the end of the previous text.

Parameters
ch char: characters to process
start int: start point of text relevant to this call
length int: length of text

public void endElement (String localName)

This method is called when we reach the end of the XML element with the given name. Note that this method will be called for subsequent child elements as well as sibling elements. Use the contents of the stack to determine where we are in the XML being parsed.

public WMTSStyle getDefaultStyle ()

Gets the style marked as default for this layer.

Returns
WMTSStyle the style marked as default for this layer

public WMSExtent getExtentByWkid (int wkid)

Gets the extent of this layer for the given spatial reference WKID.

Parameters
wkid int: WKID of a spatial reference supported by this layer
Returns
WMSExtent an extent to match the wkid parameter or null if no match is found

public List<WMSExtent> getExtents ()

Gets a list of extents for this layer. There will be one for each supported spatial reference.

Returns
List<WMSExtent> list of extents for this layer

public List<String> getFormats ()

Get a list of resource mime types supported by this layer. This information can be used with getResourceUrlByTypeAndFormat(String, String) to get a template URL to access a resource of a given type.

Returns
List<String> list of resource mime types supported by this layer

public String getIdentifier ()

Gets this layer's ID.

Returns
String this layer's ID

public ResourceUrlInfo getResourceUrlByTypeAndFormat (String resourceType, String format)

Used to get a template URL for a specific resource with the given mime type. The returned template URL may contain tokens delimited with '{' and '}' that will need to be replaced before the URL is used.

Parameters
resourceType String: resource to be accessed, eg. "tile"
format String: supported mime type of resource
Returns
ResourceUrlInfo template URL that can be used to access the given resource with the given mime type

public List<ResourceUrlInfo> getResourceUrls ()

Get a list of all resource URL templates associated with this layer. Each ResourceUrlInfo instance contains the resource type, mime type and template URL used to access the resource.

Returns
List<ResourceUrlInfo> list of all resource URL templates associated with this layer

public WMTSServiceInfo getServiceInfo ()

Gets the WMTSServiceInfo that this layer belongs to.

Returns
WMTSServiceInfo the WMTSServiceInfo instance that this layer belongs to

public WMTSStyle getStyleById (String styleId)

Get a specific style with the given ID.

Parameters
styleId String
Returns
WMTSStyle styleId WMTSStyle instance with the given ID or null if no match is found

public List<String> getStyleIds ()

Gets a list of IDs for styles defined for this layer.

Returns
List<String> list of IDs for styles defined for this layer

public List<WMTSStyle> getStyles ()

Gets a list of the styles defined for this layer.

Returns
List<WMTSStyle> list of the styles defined for this layer

public List<WMTSLayerInfo> getSubLayers ()

Returns
List<WMTSLayerInfo>

public List<String> getTileMatrixSetIds ()

Returns a list of Identifier strings of supported tile matrix sets for this layer. Once of these IDs can be used with getTileMatrixSet(String) to get a specific WMTSTileMatrixSet that will work with this layer.

Returns
List<String> list of Identifier strings of supported tile matrix sets for this layer

public WMTSTileMatrixSetLink getTileMatrixSetLinkById (String tileMatrixSetId)

Return a specific WMTSTileMatrixSetLink to match the given ID.

Parameters
tileMatrixSetId String
Returns
WMTSTileMatrixSetLink tileMatrixSetId a specific WMTSTileMatrixSetLink for the given id, or null if the id is not found

public List<WMTSTileMatrixSetLink> getTileMatrixSetLinks ()

Returns a list of WMTSTileMatrixSetLinks associated with this layer. Each WMTSTileMatrixSetLink instance indicates a supported WMTSTileMatrixSet and an associated optional WMTSTileMatrixLimits instance that defines a subset of tiles with the tile matrix set that define this layer.

Returns
List<WMTSTileMatrixSetLink> list of WMTSTileMatrixSetLinks associated with this layer

public List<WMSExtent> getWgs84Extents ()

Gets a list of extents for this layer that use the WGS84 spatial reference.

Returns
List<WMSExtent> list of extents for this layer that use the WGS84 spatial reference

public void startElement (String localName, Attributes atts)

This method is called to start processing the XML element with the given name. Any attributes of the element are provided here. Any text contained within the element will be available on the next call to characters(char[], int, int).

Parameters
localName String
atts Attributes: attributes of the current element, if any