org.gvsig.webmap

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright ? 2007-2016 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.webmap.lib.api;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.exception.InitializeException;

import org.gvsig.fmap.dal.exception.ProviderNotRegisteredException;

import org.gvsig.fmap.mapcontext.layers.FLayer;

import org.gvsig.fmap.mapcontrol.MapControl;

import org.gvsig.tools.swing.api.Component;

import org.gvsig.webmap.lib.api.exceptions.WebMapInvalidParamsException;

/**

 * Services to be added to webmap addlayer

 * @author dmartinezizquierdo

 *

 */

public interface WebMapService {

    /**

     * Label to identify service

     * @return String

     */

    public String getLabel();

    /**

     * Componente to require parameters to user and to be added to webmaps tab

     * @return Component

     */

    public Component getParametersPanel();

    /**

     * extracts panel parameters to create data store

     * @param parametersPanel

     * @return DataStoreParameters

     * @throws InitializeException

     * @throws ProviderNotRegisteredException

     */

    public DataStoreParameters getParameters() throws InitializeException, ProviderNotRegisteredException;

    /**

     * creates the layer to be shown

     * @param params

     * @return FLayer

     */

    public FLayer createLayer(DataStoreParameters params);

    /**

     * Validates panel parameters

     * @param parametersPanel

     * @return boolean

     * @throws WebMapInvalidParamsException

     */

    boolean isValid() throws WebMapInvalidParamsException;

    /**

     * Sets the mapControl

     * @param mapControl

     */

    void setMapCtrl(MapControl mapControl);

}