org.openstreetmap.josm.data.imagery

Class WMTSTileSource

java.lang.Object

org.openstreetmap.gui.jmapviewer.tilesources.AbstractTileSource

org.openstreetmap.gui.jmapviewer.tilesources.AbstractTMSTileSource

org.openstreetmap.josm.data.imagery.WMTSTileSource

All Implemented Interfaces:

Attributed, TemplatedTileSource, TileSource

public class WMTSTileSource
extends AbstractTMSTileSource
implements TemplatedTileSource

Tile Source handling WMS providers

Since:

8526

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	WMTSTileSource.Layer
private static class	WMTSTileSource.SelectLayerDialog
private static class	WMTSTileSource.TileMatrix
private static class	WMTSTileSource.TileMatrixSet
private static class	WMTSTileSource.TileMatrixSetBuilder

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	ALL_PATTERNS
private double	crsScale
private WMTSTileSource.Layer	currentLayer
private WMTSTileSource.TileMatrixSet	currentTileMatrixSet
private WMTSDefaultLayer	defaultLayer
private java.util.Map<java.lang.String,java.lang.String>	headers
private java.util.Collection<WMTSTileSource.Layer>	layers
private NativeScaleLayer.ScaleList	nativeScaleList
private static java.lang.String	PATTERN_HEADER
private static javax.xml.namespace.QName	QN_CONTENTS
private static javax.xml.namespace.QName	QN_FORMAT
private static javax.xml.namespace.QName	QN_LAYER
private static javax.xml.namespace.QName	QN_MATRIX_HEIGHT
private static javax.xml.namespace.QName	QN_MATRIX_WIDTH
private static javax.xml.namespace.QName	QN_RESOURCE_URL
private static javax.xml.namespace.QName	QN_SCALE_DENOMINATOR
private static javax.xml.namespace.QName	QN_STYLE
private static javax.xml.namespace.QName	QN_TILE_HEIGHT
private static javax.xml.namespace.QName	QN_TILE_WIDTH
private static javax.xml.namespace.QName	QN_TILEMATRIX
private static javax.xml.namespace.QName	QN_TILEMATRIX_SET_LINK
private static javax.xml.namespace.QName	QN_TILEMATRIXSET
private static javax.xml.namespace.QName	QN_TOPLEFT_CORNER
private GetCapabilitiesParseHelper.TransferMode	transferMode
private static java.lang.String	URL_GET_ENCODING_PARAMS
static java.lang.String	WMTS_NS_URL WMTS namespace address

Fields inherited from class org.openstreetmap.gui.jmapviewer.tilesources.AbstractTMSTileSource

baseUrl, id, name, tileSize

Fields inherited from class org.openstreetmap.gui.jmapviewer.tilesources.AbstractTileSource

attributionImage, attributionImageURL, attributionLinkURL, attributionText, termsOfUseText, termsOfUseURL

Constructor Summary

Constructors

Constructor and Description
WMTSTileSource(ImageryInfo info) Creates a tile source based on imagery info

Method Summary

Modifier and Type	Method and Description
static void	checkUrl(java.lang.String url) Checks if url is acceptable by this Tile Source
private java.util.Collection<WMTSTileSource.Layer>	getCapabilities()
double	getDistance(double lat1, double lon1, double lat2, double lon2) Gets the distance using Spherical law of cosines.
java.util.Map<java.lang.String,java.lang.String>	getHeaders()
private java.util.Collection<WMTSTileSource.Layer>	getLayers(WMTSDefaultLayer searchLayer, java.lang.String projectionCode)
int	getMaxZoom() Specifies the maximum zoom value.
NativeScaleLayer.ScaleList	getNativeScales() Get native scales of tile source.
java.util.Set<java.lang.String>	getSupportedProjections()
java.lang.String	getTileId(int zoom, int tilex, int tiley) Creates tile identifier that is unique among all tile sources, but the same tile will always get the same identifier.
private WMTSTileSource.TileMatrix	getTileMatrix(int zoom)
int	getTileSize() Specifies how large each tile is.
java.lang.String	getTileUrl(int zoom, int tilex, int tiley) Constructs the tile url.
int	getTileXMax(int zoom)
private int	getTileXMax(int zoom, Projection proj)
int	getTileXMin(int zoom)
int	getTileYMax(int zoom)
private int	getTileYMax(int zoom, Projection proj)
int	getTileYMin(int zoom)
private static java.util.List<java.util.Map.Entry<java.lang.String,java.util.List<WMTSTileSource.Layer>>>	groupLayersByName(java.util.Collection<WMTSTileSource.Layer> layers)
private java.lang.String	handleTemplate(java.lang.String url)
void	initProjection(Projection proj) Initializes projection for this TileSource with projection
TileXY	latLonToTileXY(double lat, double lon, int zoom)
TileXY	latLonToTileXY(ICoordinate point, int zoom)
java.awt.Point	latLonToXY(double lat, double lon, int zoom)
java.awt.Point	latLonToXY(ICoordinate point, int zoom)
private static java.util.Collection<WMTSTileSource.Layer>	parseContents(javax.xml.stream.XMLStreamReader reader) Parse Contents tag.
private static WMTSTileSource.Layer	parseLayer(javax.xml.stream.XMLStreamReader reader) Parse Layer tag.
private void	parseOperationMetadata(javax.xml.stream.XMLStreamReader reader) Parses OperationMetadata section.
private static WMTSTileSource.TileMatrix	parseTileMatrix(javax.xml.stream.XMLStreamReader reader, java.lang.String matrixCrs) Parses TileMatrix section.
private static WMTSTileSource.TileMatrixSet	parseTileMatrixSet(javax.xml.stream.XMLStreamReader reader) Parses TileMatrixSet section.
private static java.lang.String	praseTileMatrixSetLink(javax.xml.stream.XMLStreamReader reader) Gets TileMatrixSetLink value.
ICoordinate	tileXYToLatLon(int x, int y, int zoom)
ICoordinate	tileXYToLatLon(Tile tile)
ICoordinate	tileXYToLatLon(TileXY xy, int zoom)
DefaultLayer	userSelectLayer() Creates a dialog based on this tile source with all available layers and returns the name of selected layer
Coordinate	xyToLatLon(int x, int y, int zoom)
Coordinate	xyToLatLon(java.awt.Point point, int zoom)

Methods inherited from class org.openstreetmap.gui.jmapviewer.tilesources.AbstractTMSTileSource

getBaseUrl, getDefaultTileSize, getExtension, getId, getMetadata, getMinZoom, getName, getTilePath, isNoTileAtZoom, toString

Methods inherited from class org.openstreetmap.gui.jmapviewer.tilesources.AbstractTileSource

getAttributionImage, getAttributionImageURL, getAttributionLinkURL, getAttributionText, getTermsOfUseText, getTermsOfUseURL, requiresAttribution, setAttributionImage, setAttributionImageURL, setAttributionLinkURL, setAttributionText, setTermsOfUseText, setTermsOfUseURL

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstreetmap.gui.jmapviewer.interfaces.TileSource

getDefaultTileSize, getId, getMetadata, getMinZoom, getName, isNoTileAtZoom

Methods inherited from interface org.openstreetmap.gui.jmapviewer.interfaces.Attributed

getAttributionImage, getAttributionImageURL, getAttributionLinkURL, getAttributionText, getTermsOfUseText, getTermsOfUseURL, requiresAttribution

Field Detail

WMTS_NS_URL

public static final java.lang.String WMTS_NS_URL

WMTS namespace address

See Also:

Constant Field Values

QN_CONTENTS

private static final javax.xml.namespace.QName QN_CONTENTS

QN_FORMAT

private static final javax.xml.namespace.QName QN_FORMAT

QN_LAYER

private static final javax.xml.namespace.QName QN_LAYER

QN_MATRIX_WIDTH

private static final javax.xml.namespace.QName QN_MATRIX_WIDTH

QN_MATRIX_HEIGHT

private static final javax.xml.namespace.QName QN_MATRIX_HEIGHT

QN_RESOURCE_URL

private static final javax.xml.namespace.QName QN_RESOURCE_URL

QN_SCALE_DENOMINATOR

private static final javax.xml.namespace.QName QN_SCALE_DENOMINATOR

QN_STYLE

private static final javax.xml.namespace.QName QN_STYLE

QN_TILEMATRIX

private static final javax.xml.namespace.QName QN_TILEMATRIX

QN_TILEMATRIXSET

private static final javax.xml.namespace.QName QN_TILEMATRIXSET

QN_TILEMATRIX_SET_LINK

private static final javax.xml.namespace.QName QN_TILEMATRIX_SET_LINK

QN_TILE_WIDTH

private static final javax.xml.namespace.QName QN_TILE_WIDTH

QN_TILE_HEIGHT

private static final javax.xml.namespace.QName QN_TILE_HEIGHT

QN_TOPLEFT_CORNER

private static final javax.xml.namespace.QName QN_TOPLEFT_CORNER

PATTERN_HEADER

private static final java.lang.String PATTERN_HEADER

See Also:

Constant Field Values

URL_GET_ENCODING_PARAMS

private static final java.lang.String URL_GET_ENCODING_PARAMS

See Also:

Constant Field Values

ALL_PATTERNS

private static final java.lang.String[] ALL_PATTERNS

headers

private final java.util.Map<java.lang.String,java.lang.String> headers

layers

private final java.util.Collection<WMTSTileSource.Layer> layers

currentLayer

private WMTSTileSource.Layer currentLayer

currentTileMatrixSet

private WMTSTileSource.TileMatrixSet currentTileMatrixSet

crsScale

private double crsScale

transferMode

private GetCapabilitiesParseHelper.TransferMode transferMode

nativeScaleList

private NativeScaleLayer.ScaleList nativeScaleList

defaultLayer

private final WMTSDefaultLayer defaultLayer

Constructor Detail

WMTSTileSource

public WMTSTileSource(ImageryInfo info)
               throws java.io.IOException

Creates a tile source based on imagery info

Parameters:

info - imagery info

Throws:

java.io.IOException - if any I/O error occurs

java.lang.IllegalArgumentException - if any other error happens for the given imagery info

Method Detail

userSelectLayer

public DefaultLayer userSelectLayer()

Creates a dialog based on this tile source with all available layers and returns the name of selected layer

Returns:

Name of selected layer

handleTemplate

private java.lang.String handleTemplate(java.lang.String url)

groupLayersByName

private static java.util.List<java.util.Map.Entry<java.lang.String,java.util.List<WMTSTileSource.Layer>>> groupLayersByName(java.util.Collection<WMTSTileSource.Layer> layers)

getCapabilities

private java.util.Collection<WMTSTileSource.Layer> getCapabilities()
                                                            throws java.io.IOException

Returns:

capabilities

Throws:

java.io.IOException - in case of any I/O error

java.lang.IllegalArgumentException - in case of any other error

parseContents

private static java.util.Collection<WMTSTileSource.Layer> parseContents(javax.xml.stream.XMLStreamReader reader)
                                                                 throws javax.xml.stream.XMLStreamException

Parse Contents tag. Returns when reader reaches Contents closing tag

Parameters:

reader - StAX reader instance

Returns:

collection of layers within contents with properly linked TileMatrixSets

Throws:

javax.xml.stream.XMLStreamException - See XMLStreamReader

parseLayer

private static WMTSTileSource.Layer parseLayer(javax.xml.stream.XMLStreamReader reader)
                                        throws javax.xml.stream.XMLStreamException

Parse Layer tag. Returns when reader will reach Layer closing tag

Parameters:

reader - StAX reader instance

Returns:

Layer object, with tileMatrixSetLinks and no tileMatrixSet attribute set.

Throws:

javax.xml.stream.XMLStreamException - See XMLStreamReader

praseTileMatrixSetLink

private static java.lang.String praseTileMatrixSetLink(javax.xml.stream.XMLStreamReader reader)
                                                throws javax.xml.stream.XMLStreamException

Gets TileMatrixSetLink value. Returns when reader is on TileMatrixSetLink closing tag

Parameters:

reader - StAX reader instance

Returns:

TileMatrixSetLink identifier

Throws:

javax.xml.stream.XMLStreamException - See XMLStreamReader

parseTileMatrixSet

private static WMTSTileSource.TileMatrixSet parseTileMatrixSet(javax.xml.stream.XMLStreamReader reader)
                                                        throws javax.xml.stream.XMLStreamException

Parses TileMatrixSet section. Returns when reader is on TileMatrixSet closing tag

Parameters:

reader - StAX reader instance

Returns:

TileMatrixSet object

Throws:

javax.xml.stream.XMLStreamException - See XMLStreamReader

parseTileMatrix

private static WMTSTileSource.TileMatrix parseTileMatrix(javax.xml.stream.XMLStreamReader reader,
                                                         java.lang.String matrixCrs)
                                                  throws javax.xml.stream.XMLStreamException

Parses TileMatrix section. Returns when reader is on TileMatrix closing tag.

Parameters:

reader - StAX reader instance

matrixCrs - projection used by this matrix

Returns:

TileMatrix object

Throws:

javax.xml.stream.XMLStreamException - See XMLStreamReader

parseOperationMetadata

private void parseOperationMetadata(javax.xml.stream.XMLStreamReader reader)
                             throws javax.xml.stream.XMLStreamException

Parses OperationMetadata section. Returns when reader is on OperationsMetadata closing tag. Sets this.baseUrl and this.transferMode

Parameters:

reader - StAX reader instance

Throws:

javax.xml.stream.XMLStreamException - See XMLStreamReader

initProjection

public void initProjection(Projection proj)

Initializes projection for this TileSource with projection

Parameters:

proj - projection to be used by this TileSource

getLayers

private java.util.Collection<WMTSTileSource.Layer> getLayers(WMTSDefaultLayer searchLayer,
                                                             java.lang.String projectionCode)

Parameters:

searchLayer - which layer do we look for

projectionCode - projection code to match

Returns:

Collection of layers matching the name of the layer and projection, or only projection if name is not provided

getTileSize

public int getTileSize()

Description copied from interface: TileSource

Specifies how large each tile is.

Specified by:

getTileSize in interface TileSource

Overrides:

getTileSize in class AbstractTMSTileSource

Returns:

The size of a single tile in pixels. -1 if default size should be used

getTileUrl

public java.lang.String getTileUrl(int zoom,
                                   int tilex,
                                   int tiley)

Description copied from interface: TileSource

Constructs the tile url.

Specified by:

getTileUrl in interface TileSource

Overrides:

getTileUrl in class AbstractTMSTileSource

Parameters:

zoom - zoom level

tilex - X coordinate

tiley - Y coordinate

Returns:

fully qualified url for downloading the specified tile image

getTileMatrix

private WMTSTileSource.TileMatrix getTileMatrix(int zoom)

Parameters:

zoom - zoom level

Returns:

TileMatrix that's working on this zoom level

getDistance

public double getDistance(double lat1,
                          double lon1,
                          double lat2,
                          double lon2)

Description copied from interface: TileSource

Gets the distance using Spherical law of cosines.

Specified by:

getDistance in interface TileSource

Parameters:

lat1 - latitude of first point

lon1 - longitude of first point

lat2 - latitude of second point

lon2 - longitude of second point

Returns:

the distance betwen first and second point, in m.

tileXYToLatLon

public ICoordinate tileXYToLatLon(Tile tile)

Specified by:

tileXYToLatLon in interface TileSource

Overrides:

tileXYToLatLon in class AbstractTMSTileSource

Parameters:

tile - Tile

Returns:

WGS84 coordinates of given tile

tileXYToLatLon

public ICoordinate tileXYToLatLon(TileXY xy,
                                  int zoom)

Specified by:

tileXYToLatLon in interface TileSource

Overrides:

tileXYToLatLon in class AbstractTMSTileSource

Parameters:

xy - X/Y coordinates

zoom - zoom level

Returns:

WGS84 coordinates of given tile

tileXYToLatLon

public ICoordinate tileXYToLatLon(int x,
                                  int y,
                                  int zoom)

Specified by:

tileXYToLatLon in interface TileSource

Parameters:

x - X coordinate

y - Y coordinate

zoom - zoom level

Returns:

WGS84 coordinates of given tile

latLonToTileXY

public TileXY latLonToTileXY(double lat,
                             double lon,
                             int zoom)

Specified by:

latLonToTileXY in interface TileSource

Parameters:

lat - latitude

lon - longitude

zoom - zoom level

Returns:

x and y tile indices

latLonToTileXY

public TileXY latLonToTileXY(ICoordinate point,
                             int zoom)

Specified by:

latLonToTileXY in interface TileSource

Overrides:

latLonToTileXY in class AbstractTMSTileSource

Parameters:

point - point

zoom - zoom level

Returns:

x and y tile indices

getTileXMax

public int getTileXMax(int zoom)

Specified by:

getTileXMax in interface TileSource

Overrides:

getTileXMax in class AbstractTMSTileSource

Parameters:

zoom - zoom level

Returns:

maximum X index of tile for specified zoom level

getTileXMin

public int getTileXMin(int zoom)

Specified by:

getTileXMin in interface TileSource

Overrides:

getTileXMin in class AbstractTMSTileSource

Parameters:

zoom - zoom level

Returns:

minimum X index of tile for specified zoom level

getTileYMax

public int getTileYMax(int zoom)

Specified by:

getTileYMax in interface TileSource

Overrides:

getTileYMax in class AbstractTMSTileSource

Parameters:

zoom - zoom level

Returns:

maximum Y index of tile for specified zoom level

getTileYMin

public int getTileYMin(int zoom)

Specified by:

getTileYMin in interface TileSource

Overrides:

getTileYMin in class AbstractTMSTileSource

Parameters:

zoom - zoom level

Returns:

minimum Y index of tile for specified zoom level

latLonToXY

public java.awt.Point latLonToXY(double lat,
                                 double lon,
                                 int zoom)

Specified by:

latLonToXY in interface TileSource

Parameters:

lat - latitude

lon - longitude

zoom - zoom level

Returns:

transforms longitude and latitude to pixel space (as if all tiles at specified zoom level where joined)

latLonToXY

public java.awt.Point latLonToXY(ICoordinate point,
                                 int zoom)

Specified by:

latLonToXY in interface TileSource

Overrides:

latLonToXY in class AbstractTMSTileSource

Parameters:

point - point

zoom - zoom level

Returns:

transforms longitude and latitude to pixel space (as if all tiles at specified zoom level where joined)

xyToLatLon

public Coordinate xyToLatLon(java.awt.Point point,
                             int zoom)

Specified by:

xyToLatLon in interface TileSource

Overrides:

xyToLatLon in class AbstractTMSTileSource

Parameters:

point - point

zoom - zoom level

Returns:

WGS84 Coordinates of given point

xyToLatLon

public Coordinate xyToLatLon(int x,
                             int y,
                             int zoom)

Specified by:

xyToLatLon in interface TileSource

Parameters:

x - X coordinate

y - Y coordinate

zoom - zoom level

Returns:

WGS84 Coordinates of given point

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

Specified by:

getHeaders in interface TemplatedTileSource

Returns:

headers to be sent with http requests

getMaxZoom

public int getMaxZoom()

Description copied from interface: TileSource

Specifies the maximum zoom value. The number of zoom levels is [0.. TileSource.getMaxZoom()].

Specified by:

getMaxZoom in interface TileSource

Overrides:

getMaxZoom in class AbstractTMSTileSource

Returns:

maximum zoom value that has to be smaller or equal to JMapViewer.MAX_ZOOM

getTileId

public java.lang.String getTileId(int zoom,
                                  int tilex,
                                  int tiley)

Description copied from interface: TileSource

Creates tile identifier that is unique among all tile sources, but the same tile will always get the same identifier. Used for creation of cache key.

Specified by:

getTileId in interface TileSource

Overrides:

getTileId in class AbstractTMSTileSource

Parameters:

zoom - zoom level

tilex - X coordinate

tiley - Y coordinate

Returns:

tile identifier

checkUrl

public static void checkUrl(java.lang.String url)

Checks if url is acceptable by this Tile Source

Parameters:

url - URL to check

getSupportedProjections

public java.util.Set<java.lang.String> getSupportedProjections()

Returns:

set of projection codes that this TileSource supports

getTileYMax

private int getTileYMax(int zoom,
                        Projection proj)

getTileXMax

private int getTileXMax(int zoom,
                        Projection proj)

getNativeScales

public NativeScaleLayer.ScaleList getNativeScales()

Get native scales of tile source.

Returns:

NativeScaleLayer.ScaleList of native scales