Package org.mapfish.print.map.tiled.wmts
Class WMTSLayerParam
java.lang.Object
org.mapfish.print.map.AbstractLayerParams
org.mapfish.print.map.tiled.AbstractTiledLayerParams
org.mapfish.print.map.tiled.AbstractWMXLayerParams
org.mapfish.print.map.tiled.wmts.WMTSLayerParam
The parameters for configuration a WMTS layer.
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe ‘ResourceURL’ available in the WMTS capabilities.Dictionary of dimensions name (Must be uppercase) => value.String[]The "sample" dimensions or image color bands to retrieve.The format of the image.The layer name.Matrix[]Array of matrix ids.Reference/Identifier to a tileMatrixSet and limits.The way to make the requests.The style name (for styles on the WMTS server).The WMTS protocol version to use.Fields inherited from class org.mapfish.print.map.tiled.AbstractWMXLayerParams
customParams, mergeableParamsFields inherited from class org.mapfish.print.map.tiled.AbstractTiledLayerParams
rasterStyleFields inherited from class org.mapfish.print.map.AbstractLayerParams
failOnError, name, opacity -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreate a URL that is common to all image requests for this layer.Get the base url for all tile requests.voidValidate some of the properties of this layer.booleanValidates the provided base url.Methods inherited from class org.mapfish.print.map.tiled.AbstractWMXLayerParams
getCustomParams, getMergeableParams, setCustomParam
-
Field Details
-
baseURL
The ‘ResourceURL’ available in the WMTS capabilities.Example (for
requestEncoding: "KVP"):
Example (forbaseUrl: "http://domain.com/wmts"requestEncoding: "REST"):
The following URL template variables are replaced:baseUrl: "http://domain.com/wmts/roads/{TileMatrixSet}/{TileMatrix}/{TileCol}/{TileRow}.png"- {Layer}
- {style}
- {TileMatrixSet}
- {TileMatrix}
- {TileRow}
- {TileCol}
- {[DIMENSION.IDENTIFIER]}
-
layer
The layer name. -
version
The WMTS protocol version to use. -
requestEncoding
The way to make the requests. EitherKVPorREST(default). -
style
The style name (for styles on the WMTS server). -
dimensions
The "sample" dimensions or image color bands to retrieve.This can be null, if so then the default dimensions will be returned. If specified they must be dimensions supported by the server.
These are keys to the
dimensionParams. -
dimensionParams
Dictionary of dimensions name (Must be uppercase) => value. -
imageFormat
The format of the image. for example image/png, image/jpeg, etc... -
matrixSet
Reference/Identifier to a tileMatrixSet and limits. -
matrices
Array of matrix ids.Example:
[{ "identifier": "0", "matrixSize": [1, 1], "scaleDenominator": 4000, "tileSize": [256, 256], "topLeftCorner": [420000, 350000] }, ...]
-
-
Constructor Details
-
WMTSLayerParam
public WMTSLayerParam()
-
-
Method Details
-
getBaseUrl
Description copied from class:AbstractTiledLayerParamsGet the base url for all tile requests. For example it might be 'http://server .com/geoserver/gwc/service/wmts'.- Specified by:
getBaseUrlin classAbstractTiledLayerParams
-
postConstruct
public void postConstruct()Validate some of the properties of this layer. -
createCommonUrl
Description copied from class:AbstractTiledLayerParamsCreate a URL that is common to all image requests for this layer. It will take the base url and append all mergeable and custom params to the base url.- Overrides:
createCommonUrlin classAbstractWMXLayerParams- Throws:
URISyntaxException
-
validateBaseUrl
public boolean validateBaseUrl()Description copied from class:AbstractTiledLayerParamsValidates the provided base url.- Overrides:
validateBaseUrlin classAbstractWMXLayerParams- Returns:
- True, if the url is valid.
-