Application: gvSIG desktop » gvSIG geoprocess

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2012 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 2

 * 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.geoprocess.lib.sextante;

import java.io.File;

import java.io.InputStream;

import java.net.URL;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Iterator;

import java.util.List;

import java.util.Locale;

import java.util.Map;

import java.util.Set;

import java.util.Map.Entry;

import javax.swing.ImageIcon;

import org.gvsig.andami.IconThemeHelper;

import org.gvsig.geoprocess.lib.api.GeoProcess;

import org.gvsig.geoprocess.lib.api.GeoProcessManager;

import org.gvsig.geoprocess.lib.sextante.gui.settings.GeoprocessSetting;

import org.gvsig.i18n.Messages;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.i18n.I18nManager;

import org.kxml2.io.KXmlParser;

import org.xmlpull.v1.XmlPullParser;

import es.unex.sextante.additionalInfo.AdditionalInfoVectorLayer;

import es.unex.sextante.core.GeoAlgorithm;

import es.unex.sextante.core.OutputObjectsSet;

import es.unex.sextante.core.ParametersSet;

import es.unex.sextante.core.Sextante;

import es.unex.sextante.docEngines.html.HTMLDoc;

import es.unex.sextante.exceptions.NullParameterAdditionalInfoException;

import es.unex.sextante.gui.algorithm.DefaultParametersPanel;

import es.unex.sextante.gui.algorithm.GeoAlgorithmParametersPanel;

import es.unex.sextante.gui.core.IAlgorithmProvider;

import es.unex.sextante.gui.core.IToolboxRightButtonAction;

import es.unex.sextante.gui.core.NameAndIcon;

import es.unex.sextante.gui.core.ToolboxAction;

import es.unex.sextante.gui.help.HelpElement;

import es.unex.sextante.gui.help.ImageAndDescription;

import es.unex.sextante.gui.modeler.DefaultModelerParametersPanel;

import es.unex.sextante.gui.settings.Setting;

import es.unex.sextante.outputs.Output;

import es.unex.sextante.outputs.Output3DRasterLayer;

import es.unex.sextante.outputs.OutputChart;

import es.unex.sextante.outputs.OutputNumericalValue;

import es.unex.sextante.outputs.OutputRasterLayer;

import es.unex.sextante.outputs.OutputTable;

import es.unex.sextante.outputs.OutputText;

import es.unex.sextante.outputs.OutputVectorLayer;

import es.unex.sextante.parameters.Parameter;

import es.unex.sextante.parameters.ParameterVectorLayer;

/**

 * Implementation for the {@link GeoProcessManager} interface based on the

 * sextante library.

 *

 * @author gvSIG Team

 * @version $Id$

 */

public class SextanteGeoProcessManager implements GeoProcessManager,

    IAlgorithmProvider {

    private static final String XML_PARSER_ENCODING = "ISO-8859-1";

    private static String HELP = "help";

    private Map<String, GeoAlgorithm> geoprocesses;

    private I18nManager i18nManager;

    /**

     * Manager constructor.

     */

    public SextanteGeoProcessManager() {

        i18nManager = ToolsLocator.getI18nManager();

        geoprocesses = new HashMap<String, GeoAlgorithm>();

    }

    public String getTranslation(String label) {

        // Just in case an algorithm is using a sextante label

        String text = i18nManager.getTranslation(label);

        return text == null ? Sextante.getText(label) : text;

    }

    public void registerGeoProcess(GeoProcess geoProcess) {

        if (geoProcess instanceof GeoAlgorithm) {

            GeoAlgorithm geoAlgorithm = (GeoAlgorithm) geoProcess;

            geoprocesses.put(geoAlgorithm.getCommandLineName(), geoAlgorithm);

        } else {

            throw new IllegalArgumentException("The geoprocess " + geoProcess

                + " is not an implementation of a sextante GeoAlgorithm, "

                + "so it is not supported as of now");

        }

    }

    public void registerGeoProcess(Class<? extends GeoProcess> geoProcessClazz,

        Map<String, String> localeStrings) {

        try {

            GeoProcess geoAlgorithm = geoProcessClazz.newInstance();

            registerGeoProcess(geoAlgorithm);

        } catch (InstantiationException e) {

            throw new RuntimeException(

                "Error creating a geoprocess instance from the class "

                    + geoProcessClazz, e);

        } catch (IllegalAccessException e) {

            throw new RuntimeException(

                "Error creating a geoprocess instance from the class "

                    + geoProcessClazz, e);

        }

    }

    public void initialize() {

        // Nothing to do

    }

    public String getName() {

        return Messages.getText("gv_algorithms");

    }

    public HashMap<String, GeoAlgorithm> getAlgorithms() {

        return new HashMap<String, GeoAlgorithm>(geoprocesses);

    }

    public HashMap<String, Class> getCustomModelerParameterPanels() {

        final HashMap<String, Class> map = new HashMap<String, Class>();

        final Set<String> set = getAlgorithms().keySet();

        final Iterator<String> iter = set.iterator();

        while (iter.hasNext()) {

            map.put(iter.next(), DefaultModelerParametersPanel.class);

        }

        return map;

    }

    public HashMap<String, Class> getCustomParameterPanels() {

        final HashMap<String, Class> map = new HashMap<String, Class>();

        final Set<Entry<String, GeoAlgorithm>> set = getAlgorithms().entrySet();

        final Iterator<Entry<String, GeoAlgorithm>> iter = set.iterator();

        while (iter.hasNext()) {

            Entry<String, GeoAlgorithm> entry = iter.next();

            GeoAlgorithm algorithm = entry.getValue();

            Class<? extends GeoAlgorithmParametersPanel> panelClazz = null;

            if (algorithm instanceof AbstractSextanteGeoProcess) {

                panelClazz =

                    ((AbstractSextanteGeoProcess) algorithm)

                        .getCustomParametersPanelClass();

            }

            map.put(entry.getKey(), (panelClazz == null

                ? DefaultParametersPanel.class : panelClazz));

        }

        return map;

    }

    public ImageIcon getIcon() {

        return IconThemeHelper.getImageIcon("gvsig-icon16x16");

    }

    public Setting getSettings() {

        return new GeoprocessSetting();

    }

    public void update() {

        // Nothing to do

    }

    public Object getAlgorithmHelp(GeoAlgorithm alg) {

        String algName = alg.getClass().getSimpleName();

        String helpFileName =

            algName + "_" + Locale.getDefault().getLanguage() + ".xml";

        String currentLocaleHelp = "help" + "/" + helpFileName;

        InputStream is =

            alg.getClass().getClassLoader()

                .getResourceAsStream(currentLocaleHelp);

        if (is == null) {

            helpFileName = algName + ".xml";

            currentLocaleHelp = "help" + "/" + helpFileName;

            is =

                alg.getClass().getClassLoader()

                    .getResourceAsStream(currentLocaleHelp);

        }

        if (is == null) {

            return null;

        }

        // The following code has been extracted from the

        // es.unex.sextante.gui.help.HelpIO getHelpAsHTMLCode method, as it

        // works with a string file path, and we need a stream from a classpath

        // resource.

        URL helpURL =

            alg.getClass().getClassLoader().getResource(currentLocaleHelp);

        String helpBaseURL = helpURL.toString();

        int lastIndex = helpBaseURL.length() - helpFileName.length();

        helpBaseURL = helpBaseURL.substring(0, lastIndex);

        HelpElement element;

        Map<String, HelpElement> elements = readHelpElements(is);

        HTMLDoc doc = new HTMLDoc();

        doc.open(alg.getName());

        doc.addHeader(Sextante.getText(alg.getName()), 1);

        doc.addHeader(Sextante.getText("Description"), 2);

        element = (HelpElement) elements.get("DESCRIPTION");

        if (element != null) {

            doc.addParagraph(element.getTextAsFormattedHTML());

            for (int j = 0; j < element.getImages().size(); j++) {

                ImageAndDescription iad =

                    (ImageAndDescription) element.getImages().get(j);

                doc.addImageAndDescription(helpBaseURL + iad.getFilename(),

                    iad.getDescription());

            }

        }

        doc.addHeader(Sextante.getText("Parameters"), 2);

        ParametersSet params = alg.getParameters();

        doc.startUnorderedList();

        for (int i = 0; i < params.getNumberOfParameters(); i++) {

            Parameter param = params.getParameter(i);

            String sParam = param.getParameterDescription();

            sParam =

                "<b>" + sParam + "[" + getParameterTypeName(param) + "]: </b>";

            element = (HelpElement) elements.get(param.getParameterName());

            if (element != null) {

                sParam = sParam + element.getTextAsFormattedHTML();

            }

            doc.addListElement(sParam);

            if (element != null) {

                for (int j = 0; j < element.getImages().size(); j++) {

                    final ImageAndDescription iad =

                        (ImageAndDescription) element.getImages().get(j);

                    doc.addImageAndDescription(helpBaseURL + iad.getFilename(),

                        iad.getDescription());

                }

            }

        }

        doc.closeUnorderedList();

        doc.addHeader(Sextante.getText("Outputs"), 2);

        element = (HelpElement) elements.get("OUTPUT_DESCRIPTION");

        if (element != null) {

            doc.addParagraph(element.getTextAsFormattedHTML());

            for (int j = 0; j < element.getImages().size(); j++) {

                final ImageAndDescription iad =

                    (ImageAndDescription) element.getImages().get(j);

                doc.addImageAndDescription(helpBaseURL + iad.getFilename(),

                    iad.getDescription());

            }

        }

        doc.startUnorderedList();

        final OutputObjectsSet oo = alg.getOutputObjects();

        String sOutputType = "";

        for (int i = 0; i < oo.getOutputObjectsCount(); i++) {

            final Output out = oo.getOutput(i);

            String sOutput = out.getDescription();

            if (out instanceof OutputRasterLayer) {

                sOutputType = Sextante.getText("Raster_Layer");

            } else if (out instanceof Output3DRasterLayer) {

                sOutputType = Sextante.getText("3D_Raster_layer");

            } else if (out instanceof OutputVectorLayer) {

                sOutputType = Sextante.getText("Vector_Layer");

                final OutputVectorLayer ovl = (OutputVectorLayer) out;

                switch (ovl.getShapeType()) {

                case OutputVectorLayer.SHAPE_TYPE_UNDEFINED:

                default:

                    sOutputType =

                        sOutputType + " - " + Sextante.getText("Any_type");

                    break;

                case OutputVectorLayer.SHAPE_TYPE_LINE:

                    sOutputType =

                        sOutputType + " - " + Sextante.getText("Line");

                    break;

                case OutputVectorLayer.SHAPE_TYPE_POLYGON:

                    sOutputType =

                        sOutputType + " - " + Sextante.getText("Polygon");

                    break;

                case OutputVectorLayer.SHAPE_TYPE_POINT:

                    sOutputType =

                        sOutputType + " - " + Sextante.getText("Point");

                    break;

                }

            } else if (out instanceof OutputTable) {

                sOutputType = Sextante.getText("Table");

            } else if (out instanceof OutputChart) {

                sOutputType = Sextante.getText("graph-chart");

            } else if (out instanceof OutputText) {

                sOutputType = Sextante.getText("Text");

            } else if (out instanceof OutputNumericalValue) {

                sOutputType = Sextante.getText("Numerical_value");

            }

            sOutput = "<b>" + sOutput + "[" + sOutputType + "]: </b>";

            element = (HelpElement) elements.get(out.getName());

            if (element != null) {

                sOutput = sOutput + element.getTextAsFormattedHTML();

            }

            doc.addListElement(sOutput);

            if (element != null) {

                for (int j = 0; j < element.getImages().size(); j++) {

                    ImageAndDescription iad =

                        (ImageAndDescription) element.getImages().get(j);

                    doc.addImageAndDescription(helpBaseURL + iad.getFilename(),

                        iad.getDescription());

                }

            }

        }

        doc.closeUnorderedList();

        doc.addHeader(Sextante.getText("Additional_information"), 2);

        element = (HelpElement) elements.get("ADDITIONAL_INFO");

        if (element != null) {

            doc.addParagraph(element.getTextAsFormattedHTML());

            for (int j = 0; j < element.getImages().size(); j++) {

                ImageAndDescription iad =

                    (ImageAndDescription) element.getImages().get(j);

                doc.addImageAndDescription(helpBaseURL + iad.getFilename(),

                    iad.getDescription());

            }

        }

        doc.addHeader(Sextante.getText("Command_line"), 2);

        String sText = alg.getCommandLineHelp();

        sText = sText.replaceAll("\n", "<br>");

        sText = sText.replace("   ", " &nbsp ");

        doc.addCourierText(sText);

        doc.addParagraph("");

        element = (HelpElement) elements.get("EXTENSION_AUTHOR");

        if (element != null) {

            doc.addParagraph("<i>" + Sextante.getText("Algorithm_created_by")

                + " " + element.getText() + "</i>");

            for (int j = 0; j < element.getImages().size(); j++) {

                ImageAndDescription iad =

                    (ImageAndDescription) element.getImages().get(j);

                doc.addImageAndDescription(helpBaseURL + iad.getFilename(),

                    iad.getDescription());

            }

        }

        element = (HelpElement) elements.get("HELP_AUTHOR");

        if (element != null) {

            doc.addParagraph("<i>" + Sextante.getText("Help_file_created_by")

                + " " + element.getText() + "</i>");

            for (int j = 0; j < element.getImages().size(); j++) {

                ImageAndDescription iad =

                    (ImageAndDescription) element.getImages().get(j);

                doc.addImageAndDescription(helpBaseURL + iad.getFilename(),

                    iad.getDescription());

            }

        }

        doc.close();

        return doc.getHTMLCode();

    }

    public String getAlgorithmHelpFilename(GeoAlgorithm alg,

        boolean bForceCurrentLocale) {

        // TODO Auto-generated method stub

        return null;

    }

    public boolean canEditHelp() {

        return false;

    }

    private Map<String, HelpElement> readHelpElements(InputStream is) {

        List<ImageAndDescription> images = null;

        Map<String, HelpElement> elements = new HashMap<String, HelpElement>();

        HelpElement element = null;

        KXmlParser parser = new KXmlParser();

        try {

            parser.setInput(is, XML_PARSER_ENCODING);

            int tag = parser.nextTag();

            boolean bOut = false;

            String name;

            if (parser.getEventType() != XmlPullParser.END_DOCUMENT) {

                while ((tag != XmlPullParser.END_DOCUMENT) && !bOut) {

                    switch (tag) {

                    case XmlPullParser.START_TAG:

                        name = parser.getName();

                        if (HELP.equals(name)) {

                        } else if (HelpElement.ELEMENT.equals(name)) {

                            images = new ArrayList<ImageAndDescription>();

                            String sText =

                                parser.getAttributeValue("", HelpElement.TEXT);

                            String sName =

                                parser.getAttributeValue("", HelpElement.NAME);

                            String sDescription =

                                parser.getAttributeValue("",

                                    HelpElement.DESCRIPTION);

                            int iType =

                                Integer.parseInt(parser.getAttributeValue("",

                                    HelpElement.TYPE));

                            element = new HelpElement();

                            element.setText(sText);

                            element.setName(sName);

                            element.setType(iType);

                            element.setDescription(sDescription);

                        } else if (ImageAndDescription.IMAGE.equals(name)) {

                            final ImageAndDescription iad =

                                new ImageAndDescription();

                            final String sImageFilename =

                                parser.getAttributeValue("",

                                    ImageAndDescription.FILE);

                            final String sDesc =

                                parser.getAttributeValue("",

                                    ImageAndDescription.DESCRIPTION);

                            iad.setDescription(sDesc);

                            iad.setFilename(sImageFilename);

                            images.add(iad);

                        }

                        break;

                    case XmlPullParser.END_TAG:

                        name = parser.getName();

                        if (HELP.equals(name)) {

                            bOut = true;

                        } else if (HelpElement.ELEMENT.equals(name)) {

                            element.setImages((ArrayList) images);

                            elements.put(element.getName(), element);

                        }

                        break;

                    case XmlPullParser.TEXT:

                        break;

                    }

                    if (!bOut) {

                        tag = parser.next();

                    }

                }

            }

        } catch (final Exception e) {

            return null;

        }

        return elements;

    }

    private String getParameterTypeName(Parameter param) {

        String s =

            Sextante.getText(param.getParameterTypeName().replace(' ', '_'));

        if (param instanceof ParameterVectorLayer) {

            try {

                final AdditionalInfoVectorLayer ai =

                    (AdditionalInfoVectorLayer) param

                        .getParameterAdditionalInfo();

                switch (ai.getShapeType()) {

                case AdditionalInfoVectorLayer.SHAPE_TYPE_ANY:

                default:

                    s = s + " - " + Sextante.getText("Any_type");

                    break;

                case AdditionalInfoVectorLayer.SHAPE_TYPE_LINE:

                    s = s + " - " + Sextante.getText("Line");

                    break;

                case AdditionalInfoVectorLayer.SHAPE_TYPE_POLYGON:

                    s = s + " - " + Sextante.getText("Polygon");

                    break;

                case AdditionalInfoVectorLayer.SHAPE_TYPE_POINT:

                    s = s + " - " + Sextante.getText("Point");

                    break;

                }

            } catch (final NullParameterAdditionalInfoException e) {

                // Nothing to do

            }

        }

        return s;

    }

    public HashMap<NameAndIcon, ArrayList<ToolboxAction>> getToolboxActions() {

        return new HashMap<NameAndIcon, ArrayList<ToolboxAction>>();

     }

     public IToolboxRightButtonAction[] getToolboxRightButtonActions() {

        return new IToolboxRightButtonAction[0];

     }

}