MultiInputPanel.java

/**
 * OrbisGIS is a java GIS application dedicated to research in GIScience.
 * OrbisGIS is developed by the GIS group of the DECIDE team of the 
 * Lab-STICC CNRS laboratory, see <http://www.lab-sticc.fr/>.
 *
 * The GIS group of the DECIDE team is located at :
 *
 * Laboratoire Lab-STICC – CNRS UMR 6285
 * Equipe DECIDE
 * UNIVERSITÉ DE BRETAGNE-SUD
 * Institut Universitaire de Technologie de Vannes
 * 8, Rue Montaigne - BP 561 56017 Vannes Cedex
 * 
 * OrbisGIS is distributed under GPL 3 license.
 *
 * Copyright (C) 2007-2014 CNRS (IRSTV FR CNRS 2488)
 * Copyright (C) 2015-2017 CNRS (Lab-STICC UMR CNRS 6285)
 *
 * This file is part of OrbisGIS.
 *
 * OrbisGIS 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.
 *
 * OrbisGIS 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
 * OrbisGIS. If not, see <http://www.gnu.org/licenses/>.
 *
 * For more information, please consult: <http://www.orbisgis.org/>
 * or contact directly:
 * info_at_ orbisgis.org
 */
package org.orbisgis.sif.multiInputPanel;

import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import org.orbisgis.sif.UIPanel;

/**
 *
 * MultiInputPanel is a fast and simple way to create user interface to ask user
 * input.
 *
 *
 */
public class MultiInputPanel implements UIPanel {

        private URL url;
        private String title;
        private ArrayList<Input> inputs = new ArrayList<Input>();
        private ArrayList<MIPValidation> validation = new ArrayList<MIPValidation>();
        private HashMap<String, Input> nameInput = new HashMap<String, Input>();
        private InputPanel comp;

        /**
         *
         * @param title of the panel
         */
        public MultiInputPanel(String title) {
                this.title = title;
        }

        /**
         * Add a rule to valide the content of the multiinputpanel
         *
         * @param mDValidation
         */
        public void addValidation(MIPValidation mDValidation) {
                validation.add(mDValidation);
        }

        /**
         * To add a component on the multiInputPanel
         *
         * @param name of the component. Using an identifier to get it.
         * @param text of the component that is showed.
         * @param type of the component.
         *
         * Example :
         *
         *
         * addInput("AddValue", "Value to add", new IntType());
         *
         */
        public void addInput(String name, String text, InputType type) {
                Input input = new Input(name, text, null, type);
                inputs.add(input);
                nameInput.put(name, input);
        }

        /**
         * To add a component on the multiInputPanel
         *
         * @param name of the component. Using an identifier to get it.
         * @param text of the component that is showed.
         *
         * @param initialValue for the input component
         * @param type of the component.
         *
         * Example :
         *
         * addInput("AddValue", "Value to add", "1", new IntType());
         */
        public void addInput(String name, String text, String initialValue,
                InputType type) {
                Input input = new Input(name, text, initialValue, type);
                inputs.add(input);
                nameInput.put(name, input);
        }

        /**
         *
         * @param text
         */
        public void addText(String text) {
                Input input = new Input(null, text, null, new NoInputType());
                inputs.add(input);
        }

        /**
         *
         * @param url for the icon panel.
         */
        public void setIcon(URL url) {
                this.url = url;
        }

        /**
         *
         * @param title
         */
        public void setTitle(String title) {
                this.title = title;
        }

        /**
         * Valid the input of panel
         *
         * @return a string message
         */
        @Override
        public String validateInput() {
                for (Iterator<MIPValidation> it = validation.iterator(); it.hasNext();) {
                        MIPValidation validator = it.next();
                        String message = validator.validate(this);
                        if (message != null) {
                                return message;
                        }
                }
                return null;
        }

        public void setValue(String fieldName, String fieldValue) {
                Input input = nameInput.get(fieldName);
                if (input != null) {
                        input.getType().setValue(fieldValue);
                }
        }

        @Override
        public InputPanel getComponent() {
                if (comp == null) {
                        comp = new InputPanel(inputs);
                }
                return comp;
        }

        @Override
        public URL getIconURL() {
                return url;
        }

        @Override
        public String getTitle() {
                return title;
        }

        /**
         *
         * @param inputName the name of the component
         * @return the input value
         *
         * Example :
         *
         * new Integer(mip.getInput("AddValue"));
         */
        public String getInput(String inputName) {
                Input input = nameInput.get(inputName);
                if (input != null) {
                        return input.getType().getValue();
                } else {
                        return null;
                }
        }
}