/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2011, Geomatys
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 */
package org.geotoolkit.ncwms;

import java.util.logging.Logger;
import org.geotoolkit.security.ClientSecurity;
import org.apache.sis.util.logging.Logging;
import org.geotoolkit.wms.AbstractGetLegend;


/**
 * Abstract implementation of {@link NcGetLegendRequest}, which defines the
 * parameters for a GetLegendGraphic request.
 *
 * @author olivier Terral (Geomatys)
 * @module
 */
public abstract class AbstractNcGetLegend extends AbstractGetLegend implements NcGetLegendRequest {

    /**
     * Default logger for all GetLegendGraphic requests.
     */
    protected static final Logger LOGGER = Logging.getLogger("org.geotoolkit.ncwms");

    protected Integer opacity = null;

    protected Integer numColorBands = null;

    protected Boolean logScale = null;

    protected String palette = null;

    /**
     * {@inheritDoc}
     */
    protected AbstractNcGetLegend(final String serverURL, final String version, final ClientSecurity security) {
        super(serverURL, version, security);
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public Integer getOpacity() {
        return opacity;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public void setOpacity(final Integer opacity) {
        this.opacity = opacity;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public Integer getNumColorBands() {
        return numColorBands;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public void setNumColorBands(final Integer numColorBands) {
        this.numColorBands = numColorBands;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public Boolean isLogScale() {
        return logScale;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public void setLogScale(final Boolean logScale) {
        this.logScale = logScale;
    }

    /**
     * {@inheritDoc }
     */
    @Override
    public String getPalette() {
        return palette;
    };

    /**
     * {@inheritDoc }
     */
    @Override
    public void setPalette(final String palette) {
        this.palette = palette;
    };

    /**
     * {@inheritDoc}
     */
    @Override
    protected void prepareParameters() {
        super.prepareParameters();

        if (opacity != null)
            requestParameters.put("OPACITY", String.valueOf(opacity));

        if (numColorBands != null)
            requestParameters.put("NUMCOLORBANDS", String.valueOf(numColorBands));

        if (logScale != null)
            requestParameters.put("LOGSCALE", String.valueOf(logScale));

        if (palette != null)
            requestParameters.put("PALETTE", palette);

    }

}