Package org.mapfish.print.map.tiled.wmts

Class WMTSLayerParam

  • public final class WMTSLayerParam
extends AbstractWMXLayerParams
    The parameters for configuration a WMTS layer.

    • Field Detail

      • baseURL

        public java.lang.String baseURL
        The ‘ResourceURL’ available in the WMTS capabilities.

        Example (for requestEncoding: "KVP"): 

        
 baseUrl: "http://domain.com/wmts"
        Example (for requestEncoding: "REST"): 
        
 baseUrl: "http://domain.com/wmts/roads/{TileMatrixSet}/{TileMatrix}/{TileCol}/{TileRow}.png"
        The following URL template variables are replaced:
        • {Layer}
        • {style}
        • {TileMatrixSet}
        • {TileMatrix}
        • {TileRow}
        • {TileCol}
        • {[DIMENSION.IDENTIFIER]}

      • layer

        public java.lang.String layer
        The layer name.

      • version

        public java.lang.String version
        The WMTS protocol version to use.

      • requestEncoding

        public RequestEncoding requestEncoding
        The way to make the requests. Either KVP or REST (default).

      • style

        public java.lang.String style
        The style name (for styles on the WMTS server).

      • dimensions

        public java.lang.String[] 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

        public PObject dimensionParams
        Dictionary of dimensions name (Must be uppercase) => value.

      • imageFormat

        public java.lang.String imageFormat
        The format of the image. for example image/png, image/jpeg, etc...

      • matrixSet

        public java.lang.String matrixSet
        Reference/Identifier to a tileMatrixSet and limits.

      • matrices

        public Matrix[] matrices
        Array of matrix ids.

        Example: 

        
 [{
   "identifier": "0",
   "matrixSize": [1, 1],
   "scaleDenominator": 4000,
   "tileSize": [256, 256],
   "topLeftCorner": [420000, 350000]
   }, ...]

    • Constructor Detail

      • WMTSLayerParam

        public WMTSLayerParam()

    • Method Detail

      • postConstruct

        public void postConstruct()
        Validate some of the properties of this layer.

      • createCommonUrl

        public java.lang.String createCommonUrl()
                                 throws java.net.URISyntaxException
        Description copied from class: AbstractTiledLayerParams
        Create 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:
        createCommonUrl in class AbstractWMXLayerParams
        Throws:
        java.net.URISyntaxException