Package io.jmix.mapsflowui.component.model.source

Class WmtsSource

java.lang.Object

io.jmix.mapsflowui.kit.component.model.MapObservableObject

io.jmix.mapsflowui.kit.component.model.source.Source

io.jmix.mapsflowui.kit.component.model.source.TileSource

io.jmix.mapsflowui.kit.component.model.source.UrlTileSource

io.jmix.mapsflowui.kit.component.model.source.TileImageSource

io.jmix.mapsflowui.kit.component.model.source.AbstractWmtsSource

io.jmix.mapsflowui.component.model.source.WmtsSource

All Implemented Interfaces:

AbstractWmtsSource.HasCapabilities, AbstractWmtsSource.HasDimensions, AbstractWmtsSource.HasFormat, AbstractWmtsSource.HasLayer, AbstractWmtsSource.HasMatrixSet, AbstractWmtsSource.HasRequestEncoding, AbstractWmtsSource.HasStyle, AbstractWmtsSource.HasTileGrid, AbstractWmtsSource.HasVersion, AbstractWmtsSource.HasWmtsSourceOptions, HasCrossOrigin, HasUrl, Source.HasAttributions, Source.HasAttributionsCollapsible, Source.HasProjection, Source.HasSourceOptions, Source.HasWrapX, TileSource.HasCacheSize, UrlTileSource.HasUrls, UrlTileSource.HasUrlTileSourceOptions, Serializable

public class WmtsSource
extends AbstractWmtsSource
implements Source.HasSourceOptions, TileSource.HasCacheSize, UrlTileSource.HasUrlTileSourceOptions, AbstractWmtsSource.HasWmtsSourceOptions, HasCrossOrigin

Source for tile data from WMTS (Web Map Tile Service) servers, configured manually. It can be used in TileLayer.

At minimum setLayer(String), setMatrixSet(String) and setTileGrid(WmtsTileGrid) must be set.

For more details see: WMTS docs

See Also:

• TileLayer
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractWmtsSource

AbstractWmtsSource.HasCapabilities, AbstractWmtsSource.HasDimensions, AbstractWmtsSource.HasFormat, AbstractWmtsSource.HasLayer, AbstractWmtsSource.HasMatrixSet, AbstractWmtsSource.HasRequestEncoding, AbstractWmtsSource.HasStyle, AbstractWmtsSource.HasTileGrid, AbstractWmtsSource.HasVersion, AbstractWmtsSource.HasWmtsSourceOptions

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.UrlTileSource

UrlTileSource.HasUrls, UrlTileSource.HasUrlTileSourceOptions

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.TileSource

TileSource.HasCacheSize, TileSource.HasOpaque, TileSource.HasTileSourceOptions

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

Source.HasAttributions, Source.HasAttributionsCollapsible, Source.HasProjection, Source.HasSourceOptions, Source.HasWrapX

Nested classes/interfaces inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

MapObservableObject.ObjectChangeEvent

Field Summary

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.AbstractWmtsSource

capabilities, dimensions, format, layer, matrixSet, requestEncoding, style, tileGrid, version

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.TileImageSource

crossOrigin

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.UrlTileSource

url, urls

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.TileSource

cacheSize, opaque

Fields inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

attributions, attributionsCollapsible, id, projection, wrapX

Fields inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

children, dirty, eventBus, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
WmtsSource()

Method Summary

Modifier and Type	Method	Description
List<String>	getAttributions()	Source.HasAttributions.getAttributions()
Boolean	getAttributionsCollapsible()	Source.HasAttributionsCollapsible.getAttributionsCollapsible()
Integer	getCacheSize()	TileSource.HasCacheSize.getCacheSize()
String	getCapabilities()	See AbstractWmtsSource.HasCapabilities.getCapabilities().
String	getCrossOrigin()	HasCrossOrigin.getCrossOrigin()
Map<String,Object>	getDimensions()	See AbstractWmtsSource.HasDimensions.getDimensions().
String	getFormat()	See AbstractWmtsSource.HasFormat.getFormat().
String	getLayer()	See AbstractWmtsSource.HasLayer.getLayer().
String	getMatrixSet()	See AbstractWmtsSource.HasMatrixSet.getMatrixSet().
CRS	getProjection()	Source.HasProjection.getProjection()
RequestEncoding	getRequestEncoding()	See AbstractWmtsSource.HasRequestEncoding.getRequestEncoding().
String	getStyle()	See AbstractWmtsSource.HasStyle.getStyle().
WmtsTileGrid	getTileGrid()	See AbstractWmtsSource.HasTileGrid.getTileGrid().
protected String	getType()
String	getUrl()	HasUrl.getUrl()
List<String>	getUrls()	UrlTileSource.HasUrls.getUrls()
String	getVersion()	See AbstractWmtsSource.HasVersion.getVersion().
Boolean	getWrapX()	Source.HasWrapX.getWrapX()
void	setAttributions(List<String> attributions)	Source.HasAttributions.setAttributions(List)
void	setAttributionsCollapsible(Boolean collapsible)	Source.HasAttributionsCollapsible.setAttributionsCollapsible(Boolean)
void	setCacheSize(Integer cacheSize)	TileSource.HasCacheSize.setCacheSize(Integer)
void	setCapabilities(String capabilities)	See AbstractWmtsSource.HasCapabilities.setCapabilities(String).
void	setCrossOrigin(String crossOrigin)	HasCrossOrigin.setCrossOrigin(String)
void	setDimensions(Map<String,Object> dimensions)	See AbstractWmtsSource.HasDimensions.setDimensions(Map).
void	setFormat(String format)	See AbstractWmtsSource.HasFormat.setFormat(String).
void	setLayer(String layer)	See AbstractWmtsSource.HasLayer.setLayer(String).
void	setMatrixSet(String matrixSet)	See AbstractWmtsSource.HasMatrixSet.setMatrixSet(String).
void	setProjection(CRS projection)	Source.HasProjection.setProjection(CRS)
void	setRequestEncoding(RequestEncoding requestEncoding)	See AbstractWmtsSource.HasRequestEncoding.setRequestEncoding(RequestEncoding).
void	setStyle(String style)	See AbstractWmtsSource.HasStyle.setStyle(String).
void	setTileGrid(WmtsTileGrid tileGrid)	See AbstractWmtsSource.HasTileGrid.setTileGrid(WmtsTileGrid).
void	setUrl(String url)	HasUrl.setUrl(String)
void	setUrls(List<String> urls)	UrlTileSource.HasUrls.setUrls(List)
void	setVersion(String version)	See AbstractWmtsSource.HasVersion.setVersion(String).
void	setWrapX(Boolean wrapX)	Source.HasWrapX.setWrapX(Boolean)
WmtsSource	withAttributions(List<String> attributions)	See setAttributions(List).
WmtsSource	withAttributionsCollapsible(Boolean collapsible)	See setAttributionsCollapsible(Boolean).
WmtsSource	withCacheSize(Integer cacheSize)	See setCacheSize(Integer).
WmtsSource	withCapabilities(String capabilities)	See setCapabilities(String).
WmtsSource	withCrossOrigin(String crossOrigin)	See setCrossOrigin(String).
WmtsSource	withDimensions(Map<String,Object> dimensions)	See setDimensions(Map).
WmtsSource	withFormat(String format)	See setFormat(String).
WmtsSource	withLayer(String layer)	See setLayer(String).
WmtsSource	withMatrixSet(String matrixSet)	See setMatrixSet(String).
WmtsSource	withProjection(CRS projection)	See setProjection(CRS).
WmtsSource	withRequestEncoding(RequestEncoding requestEncoding)	See setRequestEncoding(RequestEncoding).
WmtsSource	withStyle(String style)	See setStyle(String).
WmtsSource	withTileGrid(WmtsTileGrid tileGrid)	See setTileGrid(WmtsTileGrid).
WmtsSource	withUrl(String url)	See setUrl(String).
WmtsSource	withUrls(List<String> urls)	See setUrls(List).
WmtsSource	withVersion(String version)	See setVersion(String).
WmtsSource	withWrapX(Boolean wrapX)	See setWrapX(Boolean).

Methods inherited from class io.jmix.mapsflowui.kit.component.model.source.TileSource

getOpaque, setOpaque

Methods inherited from class io.jmix.mapsflowui.kit.component.model.source.Source

getId, setId

Methods inherited from class io.jmix.mapsflowui.kit.component.model.MapObservableObject

addChild, addListener, clearRemovedChildren, clearRemovedChildrenInDepth, equals, fireChangeEvent, getChildren, getEventBus, getMetaProperties, getRemovedChildren, getSuperParent, getSyncId, hashCode, isAttachedToMap, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setMetaProperty, setParent, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WmtsSource

public WmtsSource()

Method Details

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getAttributions

public List<String> getAttributions()

Description copied from class: Source

Source.HasAttributions.getAttributions()

Specified by:

getAttributions in interface Source.HasAttributions

Overrides:

getAttributions in class Source

Returns:

the attributions of the source or null if not set

setAttributions

public void setAttributions(List<String> attributions)

Description copied from class: Source

Source.HasAttributions.setAttributions(List)

Specified by:

setAttributions in interface Source.HasAttributions

Overrides:

setAttributions in class Source

Parameters:

attributions - info about copyrights and licences

withAttributions

public WmtsSource withAttributions(List<String> attributions)

See setAttributions(List).

Parameters:

attributions - info about copyrights and licences

Returns:

current instance

getAttributionsCollapsible

public Boolean getAttributionsCollapsible()

Description copied from class: Source

Source.HasAttributionsCollapsible.getAttributionsCollapsible()

Specified by:

getAttributionsCollapsible in interface Source.HasAttributionsCollapsible

Overrides:

getAttributionsCollapsible in class Source

Returns:

whether attributions should always be visible or can be hidden by info icon, null value means that default value is used: true

setAttributionsCollapsible

public void setAttributionsCollapsible(Boolean collapsible)

Description copied from class: Source

Source.HasAttributionsCollapsible.setAttributionsCollapsible(Boolean)

Specified by:

setAttributionsCollapsible in interface Source.HasAttributionsCollapsible

Overrides:

setAttributionsCollapsible in class Source

Parameters:

collapsible - whether attributions should always be visible

withAttributionsCollapsible

public WmtsSource withAttributionsCollapsible(Boolean collapsible)

See setAttributionsCollapsible(Boolean).

Parameters:

collapsible - whether attributions should always be visible

Returns:

current instance

getProjection

public CRS getProjection()

Description copied from class: Source

Source.HasProjection.getProjection()

Specified by:

getProjection in interface Source.HasProjection

Overrides:

getProjection in class Source

Returns:

projection or null if not set

setProjection

public void setProjection(CRS projection)

Description copied from class: Source

Source.HasProjection.setProjection(CRS)

Specified by:

setProjection in interface Source.HasProjection

Overrides:

setProjection in class Source

Parameters:

projection - projection to set

withProjection

public WmtsSource withProjection(CRS projection)

See setProjection(CRS).

Parameters:

projection - projection to set

Returns:

current instance

getWrapX

public Boolean getWrapX()

Description copied from class: Source

Source.HasWrapX.getWrapX()

Specified by:

getWrapX in interface Source.HasWrapX

Overrides:

getWrapX in class Source

Returns:

whether the source should be looped along the X coordinate or null if not set

setWrapX

public void setWrapX(Boolean wrapX)

Description copied from class: Source

Source.HasWrapX.setWrapX(Boolean)

Specified by:

setWrapX in interface Source.HasWrapX

Overrides:

setWrapX in class Source

Parameters:

wrapX - whether the source should be looped along the X coordinate

withWrapX

public WmtsSource withWrapX(Boolean wrapX)

See setWrapX(Boolean).

Parameters:

wrapX - whether the source should be looped along the X coordinate

Returns:

current instance

getCacheSize

public Integer getCacheSize()

Description copied from class: TileSource

TileSource.HasCacheSize.getCacheSize()

Specified by:

getCacheSize in interface TileSource.HasCacheSize

Overrides:

getCacheSize in class TileSource

Returns:

tile cache size or null if not set

setCacheSize

public void setCacheSize(Integer cacheSize)

Description copied from class: TileSource

TileSource.HasCacheSize.setCacheSize(Integer)

Specified by:

setCacheSize in interface TileSource.HasCacheSize

Overrides:

setCacheSize in class TileSource

Parameters:

cacheSize - the cache size to set

withCacheSize

public WmtsSource withCacheSize(Integer cacheSize)

See setCacheSize(Integer).

Parameters:

cacheSize - the cache size to set

Returns:

current instance

getCrossOrigin

public String getCrossOrigin()

Description copied from class: TileImageSource

HasCrossOrigin.getCrossOrigin()

Specified by:

getCrossOrigin in interface HasCrossOrigin

Overrides:

getCrossOrigin in class TileImageSource

Returns:

cross-origin or null if not set

setCrossOrigin

public void setCrossOrigin(String crossOrigin)

Description copied from class: TileImageSource

HasCrossOrigin.setCrossOrigin(String)

Specified by:

setCrossOrigin in interface HasCrossOrigin

Overrides:

setCrossOrigin in class TileImageSource

Parameters:

crossOrigin - cross-origin to set

withCrossOrigin

public WmtsSource withCrossOrigin(String crossOrigin)

See setCrossOrigin(String).

Parameters:

crossOrigin - cross-origin to set

Returns:

current instance

getUrl

public String getUrl()

Description copied from class: UrlTileSource

HasUrl.getUrl()

Specified by:

getUrl in interface HasUrl

Overrides:

getUrl in class UrlTileSource

Returns:

URL or null if not set

setUrl

public void setUrl(String url)

Description copied from class: UrlTileSource

HasUrl.setUrl(String)

Specified by:

setUrl in interface HasUrl

Overrides:

setUrl in class UrlTileSource

Parameters:

url - url to set

withUrl

public WmtsSource withUrl(String url)

See setUrl(String).

Parameters:

url - url to set

Returns:

current instance

getUrls

public List<String> getUrls()

Description copied from class: UrlTileSource

UrlTileSource.HasUrls.getUrls()

Specified by:

getUrls in interface UrlTileSource.HasUrls

Overrides:

getUrls in class UrlTileSource

Returns:

list of URL patterns or null if not set

setUrls

public void setUrls(List<String> urls)

Description copied from class: UrlTileSource

UrlTileSource.HasUrls.setUrls(List)

Specified by:

setUrls in interface UrlTileSource.HasUrls

Overrides:

setUrls in class UrlTileSource

Parameters:

urls - url patterns to set

withUrls

public WmtsSource withUrls(List<String> urls)

See setUrls(List).

Parameters:

urls - urls to set

Returns:

current instance

getLayer

public String getLayer()

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasLayer.getLayer().

Specified by:

getLayer in interface AbstractWmtsSource.HasLayer

Overrides:

getLayer in class AbstractWmtsSource

Returns:

the layer identifier, or null if not set

setLayer

public void setLayer(String layer)

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasLayer.setLayer(String).

Specified by:

setLayer in interface AbstractWmtsSource.HasLayer

Overrides:

setLayer in class AbstractWmtsSource

Parameters:

layer - layer identifier to set

withLayer

public WmtsSource withLayer(String layer)

See setLayer(String).

Parameters:

layer - layer identifier to set

Returns:

current instance

getMatrixSet

public String getMatrixSet()

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasMatrixSet.getMatrixSet().

Specified by:

getMatrixSet in interface AbstractWmtsSource.HasMatrixSet

Overrides:

getMatrixSet in class AbstractWmtsSource

Returns:

the matrix set identifier, or null if not set

setMatrixSet

public void setMatrixSet(String matrixSet)

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasMatrixSet.setMatrixSet(String).

Specified by:

setMatrixSet in interface AbstractWmtsSource.HasMatrixSet

Overrides:

setMatrixSet in class AbstractWmtsSource

Parameters:

matrixSet - matrix set identifier to set

withMatrixSet

public WmtsSource withMatrixSet(String matrixSet)

See setMatrixSet(String).

Parameters:

matrixSet - matrix set identifier to set

Returns:

current instance

getFormat

public String getFormat()

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasFormat.getFormat().

Specified by:

getFormat in interface AbstractWmtsSource.HasFormat

Overrides:

getFormat in class AbstractWmtsSource

Returns:

the image format (e.g. image/png), or null if not set

setFormat

public void setFormat(String format)

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasFormat.setFormat(String).

Specified by:

setFormat in interface AbstractWmtsSource.HasFormat

Overrides:

setFormat in class AbstractWmtsSource

Parameters:

format - image format to set

withFormat

public WmtsSource withFormat(String format)

See setFormat(String).

Parameters:

format - image format to set

Returns:

current instance

getStyle

public String getStyle()

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasStyle.getStyle().

Specified by:

getStyle in interface AbstractWmtsSource.HasStyle

Overrides:

getStyle in class AbstractWmtsSource

Returns:

the style identifier, or null if not set

setStyle

public void setStyle(String style)

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasStyle.setStyle(String).

Specified by:

setStyle in interface AbstractWmtsSource.HasStyle

Overrides:

setStyle in class AbstractWmtsSource

Parameters:

style - style identifier to set

withStyle

public WmtsSource withStyle(String style)

See setStyle(String).

Parameters:

style - style identifier to set

Returns:

current instance

getVersion

public String getVersion()

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasVersion.getVersion().

Specified by:

getVersion in interface AbstractWmtsSource.HasVersion

Overrides:

getVersion in class AbstractWmtsSource

Returns:

the protocol version, or null if not set

setVersion

public void setVersion(String version)

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasVersion.setVersion(String).

Specified by:

setVersion in interface AbstractWmtsSource.HasVersion

Overrides:

setVersion in class AbstractWmtsSource

Parameters:

version - version to set

withVersion

public WmtsSource withVersion(String version)

See setVersion(String).

Parameters:

version - version to set

Returns:

current instance

getRequestEncoding

public RequestEncoding getRequestEncoding()

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasRequestEncoding.getRequestEncoding().

Specified by:

getRequestEncoding in interface AbstractWmtsSource.HasRequestEncoding

Overrides:

getRequestEncoding in class AbstractWmtsSource

Returns:

the request encoding, or null if not set

setRequestEncoding

public void setRequestEncoding(RequestEncoding requestEncoding)

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasRequestEncoding.setRequestEncoding(RequestEncoding).

Specified by:

setRequestEncoding in interface AbstractWmtsSource.HasRequestEncoding

Overrides:

setRequestEncoding in class AbstractWmtsSource

Parameters:

requestEncoding - request encoding to set

withRequestEncoding

public WmtsSource withRequestEncoding(RequestEncoding requestEncoding)

See setRequestEncoding(RequestEncoding).

Parameters:

requestEncoding - request encoding to set

Returns:

current instance

getDimensions

public Map<String,Object> getDimensions()

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasDimensions.getDimensions().

Specified by:

getDimensions in interface AbstractWmtsSource.HasDimensions

Overrides:

getDimensions in class AbstractWmtsSource

Returns:

the request dimensions, or null if not set

setDimensions

public void setDimensions(Map<String,Object> dimensions)

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasDimensions.setDimensions(Map).

Specified by:

setDimensions in interface AbstractWmtsSource.HasDimensions

Overrides:

setDimensions in class AbstractWmtsSource

Parameters:

dimensions - dimensions to set

withDimensions

public WmtsSource withDimensions(Map<String,Object> dimensions)

See setDimensions(Map).

Parameters:

dimensions - dimensions to set

Returns:

current instance

getTileGrid

public WmtsTileGrid getTileGrid()

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasTileGrid.getTileGrid().

Specified by:

getTileGrid in interface AbstractWmtsSource.HasTileGrid

Overrides:

getTileGrid in class AbstractWmtsSource

Returns:

the tile grid, or null if not set

setTileGrid

public void setTileGrid(WmtsTileGrid tileGrid)

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasTileGrid.setTileGrid(WmtsTileGrid).

When a WebMercatorTileGrid is assigned and no projection has been set, the source projection defaults to EPSG:3857.

Specified by:

setTileGrid in interface AbstractWmtsSource.HasTileGrid

Overrides:

setTileGrid in class AbstractWmtsSource

Parameters:

tileGrid - tile grid to set

withTileGrid

public WmtsSource withTileGrid(WmtsTileGrid tileGrid)

See setTileGrid(WmtsTileGrid).

Parameters:

tileGrid - tile grid to set

Returns:

current instance

getCapabilities

public String getCapabilities()

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasCapabilities.getCapabilities().

Specified by:

getCapabilities in interface AbstractWmtsSource.HasCapabilities

Overrides:

getCapabilities in class AbstractWmtsSource

Returns:

the raw GetCapabilities XML or null if not set

setCapabilities

public void setCapabilities(String capabilities)

Description copied from class: AbstractWmtsSource

See AbstractWmtsSource.HasCapabilities.setCapabilities(String).

Specified by:

setCapabilities in interface AbstractWmtsSource.HasCapabilities

Overrides:

setCapabilities in class AbstractWmtsSource

Parameters:

capabilities - GetCapabilities XML to set

withCapabilities

public WmtsSource withCapabilities(String capabilities)

See setCapabilities(String).

Parameters:

capabilities - GetCapabilities XML to set

Returns:

current instance