Library: org.gvsig.sldtools

/*******************************************************************************

 *

 *   gvSIG. Desktop Geographic Information System.

 *  

 *   Copyright (C) 2007-2013 gvSIG Association.

 *  

 *   This program is free software; you can redistribute it and/or

 *   modify it under the terms of the GNU General Public License

 *   as published by the Free Software Foundation; either version 3

 *   of the License, or (at your option) any later version.

 *  

 *   This program 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 General Public License for more details.

 *  

 *   You should have received a copy of the GNU General Public License

 *   along with this program; if not, write to the Free Software

 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 *   MA  02110-1301, USA.

 *  

 *   For any additional information, do not hesitate to contact us

 *   at info AT gvsig.com, or visit our website www.gvsig.com.

 *   

 *******************************************************************************/

package org.gvsig.sldsupport.sld.symbol.misc;

import java.awt.Color;

import java.text.DecimalFormat;

import java.text.DecimalFormatSymbols;

import java.util.ArrayList;

import java.util.List;

import org.gvsig.sldsupport.sld.filter.expression.SLDExpression;

import org.gvsig.sldsupport.sld.filter.expression.operator.SLDLiteral;

import org.gvsig.sldsupport.sld.graphic.SLDGraphic;

public class SLDStroke {

        public static final int STROKE_TYPE_SOLID = 0;

        public static final int STROKE_TYPE_GRAPHIC_FILL = 1;

        public static final int STROKE_TYPE_GRAPHIC_STROKE = 2;

        protected int strokeType = STROKE_TYPE_SOLID;

        public static DecimalFormat df = null;

        static {

                DecimalFormatSymbols dformater_rules = new DecimalFormatSymbols();

                dformater_rules.setDecimalSeparator ('.');

                df = new DecimalFormat("##########.0##########", dformater_rules);

        }

        protected SLDExpression width = null;

        protected SLDExpression color = null;

        /*

         * 1 is opaque

         * 0.5 is semi-transparent

         * 0 is transparent

         * 

         */

        protected SLDExpression opacity = null;

        protected SLDExpression lineJoin = null;

        protected SLDExpression lineCap = null;

        protected SLDExpression dashOffset = null;

        protected List<Float> dashArray = new ArrayList<Float>();

        /**

         * Used for STROKE_TYPE_GRAPHIC_STROKE

         */

        protected Double graphicStrokeInitialGap = null;

        /**

         * Used for STROKE_TYPE_GRAPHIC_STROKE

         */

        protected Double graphicStrokeGap = null;

        /**

         * Used when not STROKE_TYPE_SOLID

         * Means a graphicFill or graphicStroke depending on the type

         * of stroke

         */

        protected SLDGraphic graphic = null;

        // ============================================

        public SLDStroke() {

                /*

                 * Defaults

                 */

                setStrokeType(STROKE_TYPE_SOLID);

                this.setColor(Color.BLACK);

                this.setOpacity(1);

                this.setWidth(1);

                /*

                 * These are valid but not standard defaults

                 * (standard does not declare default value)

                 */

                this.setLineCap(new SLDLiteral("round"));

                this.setLineJoin(new SLDLiteral("round"));

        }

        public void setStrokeType(int t) {

                this.strokeType = t;

        }

        public int getStrokeType() {

                return strokeType;

        }

        public List<Float> getDashArray() {

                return dashArray;

        }

        // ==============================

        public SLDExpression getWidth() {

                return width;

        }

        public void setWidth(SLDExpression w) {

                this.width = w;

        }

        public void setWidth(double w) {

                if (w >= 0) {

                        setWidth(new SLDLiteral(df.format(w)));

                }

        }

        public SLDExpression getColor() {

                return color;

        }

        public void setColor(SLDExpression c) {

                this.color = c;

        }

        public void setColor(Color c) {

                if (c != null) {

                        String colstr = toHexadecimal(c, 6, "#");

                        setColor(new SLDLiteral(colstr));

                }

        }

        public SLDExpression getOpacity() {

                return opacity;

        }

        public void setOpacity(SLDExpression o) {

                this.opacity = o;

        }

        public void setOpacity(double opa) {

                if (opa >= 0 && opa <= 1) {

                        setOpacity(new SLDLiteral(df.format(opa)));

                }

        }

        public SLDExpression getLineJoin() {

                return lineJoin;

        }

        public void setLineJoin(SLDExpression j) {

                this.lineJoin = j;

        }

        public SLDExpression getLineCap() {

                return lineCap;

        }

        public void setLineCap(SLDExpression c) {

                this.lineCap = c;

        }

        public SLDExpression getDashOffset() {

                return dashOffset;

        }

        public void setDashOffset(SLDExpression doff) {

                this.dashOffset = doff;

        }

        public Double getGraphicStrokeInitialGap() {

                return graphicStrokeInitialGap;

        }

        public void setGraphicStrokeInitialGap(Double g) {

                this.graphicStrokeInitialGap = g;

        }

        public Double getGraphicStrokeGap() {

                return graphicStrokeGap;

        }

        public void setGraphicStrokeGap(Double g) {

                this.graphicStrokeGap = g;

        }

        public SLDGraphic getGraphic() {

                if (strokeType == STROKE_TYPE_SOLID) {

                        /*

                         * graphic used when not STROKE_TYPE_SOLID

                         */

                        return null;

                } else {

                        return graphic;

                }

        }

        public void setGraphic(SLDGraphic g) {

                this.graphic = g;

        }

        /**

         * Examples:

         * #ff0000

         * 0x000000cd9983

         * 

         * Returns null is color is null

         * 

         * @param co

         * @param length

         * @param prefix

         * @return

         */

        public static String toHexadecimal(Color co, int length, String prefix) {

                if (co == null) {

                        return null;

                }

                int v = (co.getRed() << 16) + (co.getGreen() << 8) + co.getBlue();

                String resp = Integer.toHexString(v);

                int len = resp.length();

                for (int i=0; i<(length-len); i++) {

                        resp = "0" + resp;

                }

                resp = resp.substring(resp.length() - length);

                if (prefix != null) {

                        resp = prefix + resp;

                }

                return resp;

        }

}