AbstractTiledLayerParams (Mapfish Print Core Module 0.20240416.140809.SNAPSHOT)

java.lang.Object
- org.mapfish.print.map.AbstractLayerParams
- - org.mapfish.print.map.tiled.AbstractTiledLayerParams

Direct Known Subclasses:

AbstractWMXLayerParams, OsmLayerParam
```
public abstract class AbstractTiledLayerParams
extends AbstractLayerParams
```
Contains the standard parameters for tiled layers.

Field Summary

Fields
Modifier and Type Field Description

java.lang.String rasterStyle
The name of the style (in Configuration or Template) to use when drawing the layer to the map.
- Fields inherited from class org.mapfish.print.map.AbstractLayerParams
  failOnError, name, opacity

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractTiledLayerParams()
Constructor.

protected AbstractTiledLayerParams(AbstractTiledLayerParams other)
Copy constructor.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract java.lang.String`	`createCommonUrl()`	Create a URL that is common to all image requests for this layer.
`abstract java.lang.String`	`getBaseUrl()`	Get the base url for all tile requests.
`abstract boolean`	`validateBaseUrl()`	Validates the provided base url.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - rasterStyle
```
public java.lang.String rasterStyle
```
    The name of the style (in Configuration or Template) to use when drawing the layer to the map. This is separate from the style in that it indicates how to draw the map. It allows one to apply any of the SLD raster styling.
- Constructor Detail
  - AbstractTiledLayerParams
```
protected AbstractTiledLayerParams()
```
    Constructor.
  - AbstractTiledLayerParams
```
protected AbstractTiledLayerParams(AbstractTiledLayerParams other)
```
    Copy constructor.
    
    Parameters:
    
    other - the object to copy
- Method Detail
  - getBaseUrl
```
public abstract java.lang.String getBaseUrl()
```
    Get the base url for all tile requests. For example it might be 'http://server .com/geoserver/gwc/service/wmts'.
  - validateBaseUrl
```
public abstract boolean validateBaseUrl()
```
    Validates the provided base url.
    
    Returns:
    
    True, if the url is valid.
  - createCommonUrl
```
public abstract java.lang.String createCommonUrl()
                                          throws java.net.URISyntaxException
```
    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.
    
    Throws:
    
    java.net.URISyntaxException