Package org.mapfish.print.map.tiled

Class AbstractWMXLayerParams

    • Field Detail

      • customParams

        public PObject customParams
        Custom query parameters to use when making http requests. These are related to mergeableParams except they are the parameters that will prevent two layers from the same server from being merged into a single request with both layers. See mergeableParams for a more detailed example of the difference between mergeableParams and customParams.

        The json should look something like: 

        
 {
     "param1Name": "value",
     "param2Name": ["value1", "value2"]
 }

      • mergeableParams

        public PJsonObject mergeableParams
        Custom query parameters that can be merged if multiple layers are merged together into a single request.

        The json should look something like: 

        
 {
     "param1Name": "value",
     "param2Name": ["value1", "value2"]
 }
        For example in WMS the style parameter can be merged. If there are several wms layers that can be merged except they have different style parameters they can be merged because the style parameter can be merged.

        Compare that to DPI parameter (for QGIS wms mapserver). if two layers have different DPI then the layers cannot be merged. In this case the DPI should NOT be one of the mergeableParams it should be one of the customParams.

    • Constructor Detail

      • AbstractWMXLayerParams

        protected AbstractWMXLayerParams()
        Constructor.

      • AbstractWMXLayerParams

        protected AbstractWMXLayerParams​(AbstractWMXLayerParams other)
        Copy constructor.
        Parameters:
        other - the object to copy

    • Method Detail

      • getCustomParams

        public final com.google.common.collect.Multimap<java.lang.String,​java.lang.String> getCustomParams()
        Read the customParams into a Multimap.

      • getMergeableParams

        public final com.google.common.collect.Multimap<java.lang.String,​java.lang.String> getMergeableParams()
        Read the mergeableParams into a Multimap.

      • 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.
        Specified by:
        createCommonUrl in class AbstractTiledLayerParams
        Throws:
        java.net.URISyntaxException

      • setCustomParam

        public final void setCustomParam​(java.lang.String name,
                                 java.lang.String value)
        Set a custom parameter.
        Parameters:
        name - the parameter name
        value - the parameter value