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.impl.sld.parsing;

import java.io.IOException;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import org.xmlpull.v1.XmlPullParser;

import org.xmlpull.v1.XmlPullParserException;

import org.gvsig.sldsupport.exception.InvalidSLDObjectException;

import org.gvsig.sldsupport.exception.SLDReadException;

import org.gvsig.sldsupport.exception.UnsupportedSLDObjectException;

import org.gvsig.sldsupport.impl.util.SLDUtils;

import org.gvsig.sldsupport.impl.util.XmlBuilder;

import org.gvsig.sldsupport.sld.SLDTags;

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

import org.gvsig.sldsupport.sld.symbol.misc.SLDFill;

import org.gvsig.sldsupport.sld.symbol.misc.SLDStroke;

public class MarkElement {

    public static List<String> WELL_KNOWN_NAMES = null;

    static {

        WELL_KNOWN_NAMES = new ArrayList<String>();

        WELL_KNOWN_NAMES.add("square");

        WELL_KNOWN_NAMES.add("circle");

        WELL_KNOWN_NAMES.add("triangle");

        WELL_KNOWN_NAMES.add("star");

        WELL_KNOWN_NAMES.add("cross");

        WELL_KNOWN_NAMES.add("x");

    }

    public static void append(SLDMark obj, XmlBuilder xb, String version)

        throws InvalidSLDObjectException, UnsupportedSLDObjectException {

        xb.openTag(SLDTags.MARK);

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

        if ((version != null)

            && (version.compareToIgnoreCase(SLDUtils.VERSION_1_1_0) == 0)) {

            appendMarkTypev110(obj, xb);

        } else {

            appendMarkTypev100(obj, xb);

        }

        // =============== fill, stroke

        if (obj.getFill() != null) {

            FillElement.append(obj.getFill(), xb, version);

        }

        // =====

        if (obj.getStroke() != null) {

            StrokeElement.append(obj.getStroke(), xb, version);

        }

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

        xb.closeTag();

    }

    private static void appendMarkTypev100(SLDMark obj, XmlBuilder xb)

        throws InvalidSLDObjectException, UnsupportedSLDObjectException {

        if (obj.getMarkType() == SLDMark.MARK_TYPE_WELL_KNOWN_NAME) {

            if (obj.getWellKnownName() == null) {

                throw new InvalidSLDObjectException(SLDTags.MARK,

                    "No well-known name found");

            }

            checkWellKnownName(obj.getWellKnownName());

            xb.writeTag(SLDTags.WELLKNOWNNAME, obj.getWellKnownName());

        }

    }

    private static void checkWellKnownName(String name)

        throws UnsupportedSLDObjectException {

        if (!WELL_KNOWN_NAMES.contains(name.toLowerCase())) {

            throw new UnsupportedSLDObjectException(SLDTags.MARK,

                "Unsupported well-known name for mark: " + name);

        }

    }

    private static void appendMarkTypev110(SLDMark obj, XmlBuilder xb)

        throws InvalidSLDObjectException, UnsupportedSLDObjectException {

        boolean online_inlne = false;

        switch (obj.getMarkType()) {

        case SLDMark.MARK_TYPE_WELL_KNOWN_NAME:

            if (obj.getWellKnownName() == null) {

                throw new InvalidSLDObjectException(SLDTags.MARK,

                    "No well-known name found");

            }

            checkWellKnownName(obj.getWellKnownName());

            xb.writeTag(SLDTags.WELLKNOWNNAME, obj.getWellKnownName());

            break;

        case SLDMark.MARK_TYPE_INLINE_CONTENT:

            online_inlne = true;

            if (obj.getInlineContent() == null) {

                throw new InvalidSLDObjectException(SLDTags.MARK,

                    "No inline content found");

            }

            xb.openTag(SLDTags.INLINE_CONTENT);

            xb.writeRaw(new String(obj.getInlineContent()));

            xb.closeTag();

            break;

        case SLDMark.MARK_TYPE_ONLINE_RESOURCE:

            online_inlne = true;

            if (obj.getOnlineResource() == null) {

                throw new InvalidSLDObjectException(SLDTags.MARK,

                    "No online resource URL found");

            }

            Map<String, String> atts = new HashMap<String, String>();

            atts.put(SLDTags.XLINK_HREF, obj.getOnlineResource());

            xb.writeTag(SLDTags.ONLINE_RESOURCE, atts);

            break;

        default:

            // Simple, nothing to do

            break;

        }

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

        if (online_inlne) {

            if (obj.getFormat() == null) {

                throw new InvalidSLDObjectException(SLDTags.MARK,

                    "Format entity is mandatory in this case");

            }

            xb.writeTag(SLDTags.FORMAT, obj.getFormat());

            // =========

            if (obj.getMarkIndex() != -1) {

                xb.writeTag(SLDTags.MARK_INDEX,

                    Integer.toString(obj.getMarkIndex()));

            }

        }

    }

    public static SLDMark parse(XmlPullParser parser, String version)

        throws XmlPullParserException, IOException, SLDReadException {

        parser.require(XmlPullParser.START_TAG, null, SLDTags.MARK);

        int tag = 0;

        /*

         * Default type is SLDMark.MARK_TYPE_SIMPLE

         */

        SLDMark resp = new SLDMark();

        tag = parser.nextTag();

        String name = parser.getName();

        String txt = null;

        while (!(SLDUtils.isStr(name, SLDTags.MARK) && (tag == XmlPullParser.END_TAG))) {

            switch (tag) {

            case XmlPullParser.START_TAG:

                if (SLDUtils.isStr(name, SLDTags.WELLKNOWNNAME)) {

                    txt = parser.nextText();

                    resp.setMarkType(SLDMark.MARK_TYPE_WELL_KNOWN_NAME);

                    resp.setWellKnownName(txt);

                    parser.nextTag();

                    break;

                }

                if (SLDUtils.isStr(name, SLDTags.ONLINE_RESOURCE)) {

                    // xlink:href="http://somesite.com/something.xml"

                    txt = parser.getAttributeValue(null, SLDTags.XLINK_HREF);

                    if (txt == null) {

                        throw new SLDReadException(

                            "URL not found (xlink:href att is missing) in online resource entity");

                    }

                    resp.setOnlineResource(txt);

                    resp.setMarkType(SLDMark.MARK_TYPE_ONLINE_RESOURCE);

                    resp.setOnlineResource(txt);

                    parser.nextTag();

                    parser.nextTag();

                    break;

                }

                if (SLDUtils.isStr(name, SLDTags.INLINE_CONTENT)) {

                    /*

                     * This is unlikely to work if content is binary

                     */

                    txt = parser.nextText();

                    resp.setMarkType(SLDMark.MARK_TYPE_INLINE_CONTENT);

                    resp.setInlineContent(txt.getBytes());

                    parser.nextTag();

                    break;

                }

                if (SLDUtils.isStr(name, SLDTags.FORMAT)) {

                    txt = parser.nextText();

                    resp.setFormat(txt);

                    parser.nextTag();

                    break;

                }

                if (SLDUtils.isStr(name, SLDTags.MARK_INDEX)) {

                    txt = parser.nextText();

                    int ind = SLDUtils.parseInteger(txt);

                    resp.setMarkIndex(ind);

                    parser.nextTag();

                    break;

                }

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

                if (SLDUtils.isStr(name, SLDTags.FILL)) {

                    SLDFill fil = FillElement.parse(parser, version);

                    resp.setFill(fil);

                    break;

                }

                if (SLDUtils.isStr(name, SLDTags.STROKE)) {

                    SLDStroke stro = StrokeElement.parse(parser, version);

                    resp.setStroke(stro);

                    break;

                }

                /*

                 * Any other entity causes parsing error

                 */

                throw new SLDReadException(

                    "Bad SLD file. Unexpected entity in Mark: " + name);

            case XmlPullParser.END_TAG:

                break;

            case XmlPullParser.TEXT:

                break;

            }

            tag = parser.getEventType();

            name = parser.getName();

        }

        parser.nextTag();

        return resp;

    }

}