org.mapfish.print.config.OldApiConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of print-lib Show documentation

Library for generating PDFs and images from online webmapping services

There is a newer version: 3.22.0

package org.mapfish.print.config;

import java.util.List;

/**
 * Configuration options for how requests to the old API are handled.
 *
 * Example
 * 
 * oldApi: !oldApi
 *   layersFirstIsBaseLayer: false
 *   wmsReverseLayers: true
 * templates:
 *   ..
 */
public final class OldApiConfig implements ConfigurationObject {
    private boolean layersFirstIsBaseLayer = true;
    private boolean wmsReverseLayers = false;

    /**
     * If true then the first layer in the layers array in the JSON request is the bottom layer of the map.
     */
    public boolean isLayersFirstIsBaseLayer() {
        return this.layersFirstIsBaseLayer;
    }

    /**
     * If true then the first layer in the layers array in the JSON request is the bottom layer of the map.
     *
     * @param layersFirstIsBaseLayer If true then the first layer in the layers array in the JSON
     *         request is the bottom layer of the map.
     */
    public void setLayersFirstIsBaseLayer(final boolean layersFirstIsBaseLayer) {
        this.layersFirstIsBaseLayer = layersFirstIsBaseLayer;
    }

    @Override
    public void validate(final List validationErrors, final Configuration configuration) {
        // nothing to do
    }

    /**
     * If true then the layer order coming from the old API client will be reversed for the layers within a
     * WMS request.
     */
    public boolean isWmsReverseLayers() {
        return this.wmsReverseLayers;
    }

    /**
     * Set if the layer order coming from the old API client will be reversed for the layers within a WMS
     * request.
     *
     * @param wmsReverseLayers if true then the layer order will be reversed
     */
    public void setWmsReverseLayers(final boolean wmsReverseLayers) {
        this.wmsReverseLayers = wmsReverseLayers;
    }
}