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

Class ImageWmsSource

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.ImageSource

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

io.jmix.mapsflowui.component.model.source.ImageWmsSource

All Implemented Interfaces:

AbstractImageWmsSource.HasImageWmsSourceOptions, AbstractImageWmsSource.HasRatio, HasCrossOrigin, HasParams, HasServerType, HasUrl, Source.HasAttributions, Source.HasProjection, Serializable

public class ImageWmsSource
extends AbstractImageWmsSource
implements AbstractImageWmsSource.HasImageWmsSourceOptions, Source.HasAttributions, Source.HasProjection

Source for WMS servers providing single, untiled images. It can be used in ImageLayer.

For more details see: ImageWMS docs

See Also:

• ImageLayer
• Serialized Form

Nested Class Summary

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

AbstractImageWmsSource.HasImageWmsSourceOptions, AbstractImageWmsSource.HasRatio

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.AbstractImageWmsSource

crossOrigin, params, ratio, serverType, url

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, listener, metaProperties, parent, removedChildren, syncId

Constructor Summary

Constructors

Constructor	Description
ImageWmsSource()

Method Summary

Modifier and Type	Method	Description
List<String>	getAttributions()	Source.HasAttributions.getAttributions()
String	getCrossOrigin()	HasCrossOrigin.getCrossOrigin()
Map<String,Object>	getParams()	HasParams.getParams()
CRS	getProjection()	Source.HasProjection.getProjection()
Double	getRatio()	AbstractImageWmsSource.HasRatio.getRatio()
ServerType	getServerType()	HasServerType.getServerType()
protected String	getType()
String	getUrl()	HasUrl.getUrl()
void	setAttributions(List<String> attributions)	Source.HasAttributions.setAttributions(List)
void	setCrossOrigin(String crossOrigin)	Sets the cross-origin attribute for loaded images.
void	setParams(Map<String,Object> params)	Sets WMS request parameters.
void	setProjection(CRS projection)	Source.HasProjection.setProjection(CRS)
void	setRatio(Double ratio)	AbstractImageWmsSource.HasRatio.setRatio(Double)
void	setServerType(ServerType serverType)	Sets the type of the remote WMS server.
void	setUrl(String url)	Sets WMS service URL.
ImageWmsSource	withAttributions(List<String> attributions)	See setAttributions(List).
ImageWmsSource	withCrossOrigin(String crossOrigin)	See setCrossOrigin(String).
ImageWmsSource	withParams(Map<String,Object> params)	See setParams(Map).
ImageWmsSource	withProjection(CRS projection)	See setProjection(CRS).
ImageWmsSource	withRatio(Double ratio)	See setRatio(Double).
ImageWmsSource	withServerType(ServerType serverType)	See setServerType(ServerType).
ImageWmsSource	withUrl(String url)	See setUrl(String).

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

getAttributionsCollapsible, getId, getWrapX, setAttributionsCollapsible, setId, setWrapX

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

ImageWmsSource

public ImageWmsSource()

Method Details

getType

protected String getType()

Specified by:

getType in class MapObservableObject

getAttributions

public List<String> getAttributions()

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)

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 ImageWmsSource withAttributions(List<String> attributions)

See setAttributions(List).

Parameters:

attributions - info about copyrights and licences

Returns:

current instance

getProjection

public CRS getProjection()

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)

Source.HasProjection.setProjection(CRS)

Specified by:

setProjection in interface Source.HasProjection

Overrides:

setProjection in class Source

Parameters:

projection - projection to set

withProjection

public ImageWmsSource withProjection(CRS projection)

See setProjection(CRS).

Parameters:

projection - projection to set

Returns:

current instance

getCrossOrigin

public String getCrossOrigin()

HasCrossOrigin.getCrossOrigin()

Specified by:

getCrossOrigin in interface HasCrossOrigin

Overrides:

getCrossOrigin in class AbstractImageWmsSource

Returns:

cross-origin or null if not set

setCrossOrigin

public void setCrossOrigin(String crossOrigin)

Sets the cross-origin attribute for loaded images.

Note, cross-origin is set only at creation time and cannot be changed at runtime.

For more details see: ImageWMS docs

Specified by:

setCrossOrigin in interface HasCrossOrigin

Overrides:

setCrossOrigin in class AbstractImageWmsSource

Parameters:

crossOrigin - cross-origin to set

withCrossOrigin

public ImageWmsSource withCrossOrigin(String crossOrigin)

See setCrossOrigin(String).

Parameters:

crossOrigin - cross-origin to set

Returns:

current instance

getServerType

public ServerType getServerType()

HasServerType.getServerType()

Specified by:

getServerType in interface HasServerType

Overrides:

getServerType in class AbstractImageWmsSource

Returns:

server type or null if not set

setServerType

public void setServerType(ServerType serverType)

Sets the type of the remote WMS server.

Note, serverType attribute is set only at creation time and cannot be changed at runtime.

For more details see: ImageWMS docs

Specified by:

setServerType in interface HasServerType

Overrides:

setServerType in class AbstractImageWmsSource

Parameters:

serverType - type of the remote server

withServerType

public ImageWmsSource withServerType(ServerType serverType)

See setServerType(ServerType).

Parameters:

serverType - type of the remote server

Returns:

current instance

getParams

public Map<String,Object> getParams()

HasParams.getParams()

Specified by:

getParams in interface HasParams

Overrides:

getParams in class AbstractImageWmsSource

Returns:

WMS request parameters or null if not set

setParams

public void setParams(Map<String,Object> params)

Sets WMS request parameters. At least a "LAYERS" parameter is required.

• "STYLES" parameter is '' by default;
• "VERSION" is 1.3.0 by default;
• "WIDTH", "HEIGHT", "BBOX" and "CRS" ("SRS" for WMS version < 1.3.0) will be set dynamically

Note, params attribute is set only at creation time and cannot be changed at runtime.

For more details see: ImageWMS docs

Specified by:

setParams in interface HasParams

Overrides:

setParams in class AbstractImageWmsSource

Parameters:

params - parameters to set

withParams

public ImageWmsSource withParams(Map<String,Object> params)

See setParams(Map).

Parameters:

params - parameters to set

Returns:

current instance

getRatio

public Double getRatio()

AbstractImageWmsSource.HasRatio.getRatio()

Specified by:

getRatio in interface AbstractImageWmsSource.HasRatio

Overrides:

getRatio in class AbstractImageWmsSource

Returns:

ratio or null if not set. null value means that default value is used: '1.5'

setRatio

public void setRatio(Double ratio)

AbstractImageWmsSource.HasRatio.setRatio(Double)

Specified by:

setRatio in interface AbstractImageWmsSource.HasRatio

Overrides:

setRatio in class AbstractImageWmsSource

Parameters:

ratio - ratio to set

withRatio

public ImageWmsSource withRatio(Double ratio)

See setRatio(Double).

Parameters:

ratio - ratio to set

Returns:

current instance

getUrl

public String getUrl()

Description copied from class: AbstractImageWmsSource

HasUrl.getUrl()

Specified by:

getUrl in interface HasUrl

Overrides:

getUrl in class AbstractImageWmsSource

Returns:

WMS URL or null if not set

setUrl

public void setUrl(String url)

Sets WMS service URL.

Note, URL attribute is set only at creation time and cannot be changed at runtime.

For more details see: ImageWMS docs

Specified by:

setUrl in interface HasUrl

Overrides:

setUrl in class AbstractImageWmsSource

Parameters:

url - url to set

withUrl

public ImageWmsSource withUrl(String url)

See setUrl(String).

Parameters:

url - WMS URL to set

Returns:

current instance