LegendTemplate.java

/*
 *    Constellation - An open source and standard compliant SDI
 *    http://www.constellation-sdi.org
 *
 * Copyright 2014 Geomatys.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.constellation.configuration;

import org.geotoolkit.display2d.ext.BackgroundTemplate;
import org.geotoolkit.display2d.ext.legend.DefaultLegendTemplate;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import java.awt.*;
import java.io.Serializable;

/**
 * WMS Portrayal legend template configuration.
 * 
 * @author Quentin Boileau (Geomatys).
 */
@XmlAccessorType(XmlAccessType.FIELD)
public class LegendTemplate implements Serializable {
    
    @XmlElement(name="Background")
    private Background background;
    
    @XmlElement(name="Gap")
    private Float gap;
    
    @XmlElement(name="MainFont")
    private String mainFont;

    @XmlElement(name="MainFontColor")
    private String mainFontColor;

    @XmlElement(name="MainFontOpacity")
    private Float mainFontOpacity;
    
    @XmlElement(name="SecondFont")
    private String secondFont;
    
    @XmlElement(name="LayerVisible")
    private Boolean layerVisible;

    @XmlElement(name="GlyphWidth")
    private Integer glyphWidth;
    
    @XmlElement(name="GlyphHeight")
    private Integer glyphHeight;

    /**
     * Default LegendTemplate.
     */
    public LegendTemplate() {
        this(new Background(), 2.0f, "Arial-BOLD-14", "Arial-ITALIC-11", true, 20, 30);
    }

    public LegendTemplate(final Background background, final Float gap, final String mainFont, final String secondFont, 
            final Boolean layerName, final Integer glyphWidth, final Integer glyphHeight) {
        this.background = background;
        this.gap = gap;
        this.mainFont = mainFont;
        this.secondFont = secondFont;
        this.layerVisible = layerName;
        this.glyphWidth = glyphWidth;
        this.glyphHeight = glyphHeight;
    }

    public LegendTemplate (final org.geotoolkit.display2d.ext.legend.LegendTemplate displayLegendTemplate) {
        this.gap = displayLegendTemplate.getGapSize();
        this.mainFont = displayLegendTemplate.getLayerFont().toString();
        this.secondFont = displayLegendTemplate.getRuleFont().toString();
        this.layerVisible = displayLegendTemplate.isLayerVisible();
        this.glyphWidth = displayLegendTemplate.getGlyphSize().width;
        this.glyphHeight = displayLegendTemplate.getGlyphSize().height;
        this.background = new Background(displayLegendTemplate.getBackground());
        
    }
    
    public Background getBackground() {
        return background;
    }

    public void setBackground(Background background) {
        this.background = background;
    }

    public Float getGap() {
        return gap;
    }

    public void setGap(Float gap) {
        this.gap = gap;
    }

    public String getMainFont() {
        return mainFont;
    }

    public void setMainFont(String mainFont) {
        this.mainFont = mainFont;
    }

    public String getMainFontColor() {
        return mainFontColor;
    }

    public void setMainFontColor(String mainFontColor) {
        this.mainFontColor = mainFontColor;
    }

    public Float getMainFontOpacity() {
        return mainFontOpacity;
    }

    public void setMainFontOpacity(Float mainFontOpacity) {
        this.mainFontOpacity = mainFontOpacity;
    }

    public String getSecondFont() {
        return secondFont;
    }

    public void setSecondFont(String secondFont) {
        this.secondFont = secondFont;
    }

    public Boolean getLayerVisible() {
        return layerVisible;
    }

    public void setLayerVisible(Boolean layerName) {
        this.layerVisible = layerName;
    }

    public Integer getGlyphWidth() {
        return glyphWidth;
    }

    public void setGlyphWidth(Integer glyphWidth) {
        this.glyphWidth = glyphWidth;
    }

    public Integer getGlyphHeight() {
        return glyphHeight;
    }

    public void setGlyphHeight(Integer glyphHeight) {
        this.glyphHeight = glyphHeight;
    }
    
    /**
     * Convert to a displayable geotoolkit LegendTemplate .
     * @return org.geotoolkit.display2d.ext.legend.LegendTemplate
     */
    public org.geotoolkit.display2d.ext.legend.LegendTemplate toDisplayLegendTemplate() {
        final BackgroundTemplate dispBackground = background.toBackgroundTemplate();
        final Font mainF = Font.decode(mainFont);
        final Font secondF = Font.decode(secondFont);
        
        final Dimension glyphSize;
        if(glyphWidth != null && glyphHeight != null){
            glyphSize = new Dimension( glyphWidth , glyphHeight ) ;
        }else{
            glyphSize = null;
        }

        if (mainFontColor != null && !mainFontColor.isEmpty()) {
            final Color mainColor = Color.decode(mainFontColor);
            return new DefaultLegendTemplate(dispBackground, gap, glyphSize, secondF, layerVisible, mainF, mainColor,
                    mainFontOpacity != null ? mainFontOpacity : 255f, false);
        }
        return new DefaultLegendTemplate(dispBackground, gap, glyphSize, secondF, layerVisible, mainF);
    }
    
}