Application: gvSIG desktop » gvSIG tools: Vector editing

/**

 * gvSIG. Desktop Geographic Information System.

 *

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

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.tools.service.Manager;

import org.gvsig.vectorediting.lib.api.exceptions.ServiceInformationException;

/**

 * Main class that defines the available Editing services.

 *

 * @author llmarques

 * @version $Id$

 */

public interface EditingManager extends Manager {

    /**

     * Gets read only information about a service such as if service creates new

     * geometries, name, description, supported types, mouse icon, parameters

     * and information about its parameters.

     *

     * @param serviceName

     *            service name to get the service information

     * @return An <code>EditingServiceInfo</code> object that contains the

     *         information. {@link EditingServiceInfo}.

     * @throws ServiceInformationException

     *             if there is an error getting

     *             information of service.

     */

    public EditingServiceInfo getServiceInfo(String serviceName)

        throws ServiceInformationException;

    /**

     * Gets a new instance of service as of name and featureStore. Check

     * names to know what names are accepted.

     *

     * @param name

     *            Service name necessary to create an instance linked with the

     *            appropriate provider.

     * @param featureStore

     *            FeatureStore associated with this service necessary to

     *            create, update and remove geometries.

     * @param mapContext

     *            of layer in editing mode

     * @return An <code> EditingService </code> object. See

     *         {@link EditingService} .

     */

    public EditingService getEditingService(String name,

        FeatureStore featureStore, MapContext mapContext);

}