Application: gvSIG desktop » gvSIG tools: Vector editing

org.gvsig.vectorediting.lib.api.EditingLibrary

/**

 * 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.tools.locator.BaseLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

/**

 * This locator is the entry point for the Editing library, providing

 * access to all Editing services through the {@link EditingManager}

 * 

 * @author llmarques

 * @version $Id$

 */

public class EditingLocator extends BaseLocator {

    /**

     * Editing locator name

     */

    private static final String LOCATOR_NAME = "EditingLocator";

    /**

     * Editing manager name

     */

    public static final String MANAGER_NAME = "VectorEditing.manager";

    /**

     * Editing manager description

     */

    private static final String MANAGER_DESCRIPTION =

        "Editing Manager of gvSIG";

    /**

     * Unique instance

     */

    private static final EditingLocator instance = new EditingLocator();

    /**

     * Returns the singleton instance.

     *

     * @return the singleton instance

     */

    public static EditingLocator getInstance() {

        return instance;

    }

    /**

     * Returns the Locator's name

     * 

     * @return a String with the Locator's name

     */

    @Override

    public String getLocatorName() {

        return LOCATOR_NAME;

    }

    /**

     * Return a reference to EditingManager.

     *

     * @return a reference to EditingManager

     * @throws LocatorException

     *             if there is no access to the class or the class

     *             cannot be instantiated

     * @see Locator#get(String)

     */

    public static EditingManager getManager() throws LocatorException {

        return (EditingManager) getInstance().get(MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the EditingLocator interface.

     *

     * @param clazz

     *            implementing the EditingManager interface

     */

    public static void registerManager(Class clazz) {

        getInstance().register(MANAGER_NAME, MANAGER_DESCRIPTION, clazz);

    }

    /**

     * Registers the default Class implementing the EditingLocator interface

     * 

     * @param clazz

     *            implementing the EditingManager interface

     */

    public static void registerDefaultManager(Class clazz) {

        getInstance().registerDefault(MANAGER_NAME, MANAGER_DESCRIPTION, clazz);

    }

}

/**

 * 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.DALLibrary;

import org.gvsig.fmap.geom.GeometryLibrary;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

import org.gvsig.tools.locator.ReferenceNotRegisteredException;

/**

 * Library for API initialization and configuration.

 *

 * @author gvSIG team

 * @version $Id$

 */

public class EditingLibrary extends AbstractLibrary {

    @Override

    public void doRegistration() {

        registerAsAPI(EditingLibrary.class);

        require(DALLibrary.class);

        require(GeometryLibrary.class);

    }

    @Override

    protected void doInitialize() throws LibraryException {

        // Do nothing

    }

    @Override

    protected void doPostInitialize() throws LibraryException {

        // Validate there is any implementation registered.

        EditingManager manager = EditingLocator.getManager();

        if (manager == null) {

            throw new ReferenceNotRegisteredException(

                EditingLocator.MANAGER_NAME, EditingLocator.getInstance());

        }

    }

}

/**

 * 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);

}

/**

 * 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 java.util.List;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol;

/**

 * Drawing status represents the status when an user are drawing geometries.

 * This status includes geometries and information. It is used to show a preview

 * of the service result.

 *

 * List of geometries of this drawing status can be different from final

 * geometries created by service. Sometimes, some auxiliary geometries are added

 * to help users. For example, when user draws a circle, the radius is also

 * showed.

 *

 * Information contains data about parameters of geometries. For example, when

 * an user is drawing a line, it is interesting to show values like angle, slope

 * or y-intercept.

 *

 * @author gvSIG team.

 * @version $Id$

 */

public interface DrawingStatus {

    interface Status{

        public Geometry getGeometry();

        public ISymbol getSymbol();

        public String getText();

    }

    /**

     * Gets list of geometries to be drawn.

     *

     * @return

     */

    public List<Geometry> getGeometries();

    /**

     * Gets list of status to be drawn.

     *

     * @return

     */

    public List<Status> getStatus();

    /**

     * Gets information about position of geometries, angles, distances among

     * geometries...

     *

     * @return

     */

    public String getInfo();

}

/**

 * 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 java.awt.Image;

import java.util.List;

import org.gvsig.fmap.geom.Geometry.TYPES;

import org.gvsig.fmap.geom.type.GeometryType;

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

/**

 * <p>

 * Editing service represents the available read-only information about a

 * service. This information is composed by type (creates geometries or not),

 * mouse icon, list of parameters, supported geometries, description, name,

 * information of parameters, and compatibility with {@link GeometryType}.

 * </p>

 * @author gvSIG team.

 * @version $Id$

 */

public interface EditingServiceInfo {

    /**

     * Returns if service creates new geometries.

     *

     * @return true if service creates new geometries otherwise false.

     */

    public boolean createsNewGeometries();

    /**

     * Get mouse icon associated to service.

     *

     * @return Image that represents mouse icon.

     */

    public Image getMouseIcon();

    /**

     * Gets a <code>List</code> with all parameters of service. Each parameter

     * has name, description and types. See {@link EditingServiceParameter}.

     *

     * @return A list of {@link EditingServiceParameter} objects.

     */

    public List<EditingServiceParameter> getParameters();

    /**

     * Gets supported primitive geometry types of service. Primitive types must

     * be {@link TYPES}.

     *

     * @return An array whit primitive type supported

     */

    public int[] getSupportedPrimitiveGeometryTypes();

    /**

     * Gets description of service.

     *

     * @return Description of service.

     */

    public String getDescription();

    /**

     * Gets name of service. The name of service is the same name of linked

     * provider name.

     *

     * @return service name.

     */

    public String getName();

    /**

     * Gets read only information about a parameter of this service. See

     * {@link EditingServiceParameter}.

     *

     * @param name

     *            Name of parameter.

     * @return An {@link EditingServiceParameter} object of parameter.

     */

    public EditingServiceParameter getParameterInfo(String name);

    /**

     * Returns if service is compatible with the geometry type received as

     * parameter.

     *

     * @param geotype

     *            see {@link GeometryType}

     * @return True if service is compatible otherwise false.

     */

    public boolean isCompatibleWith(GeometryType geoType)

        throws ServiceInformationException;

}

/**

 * 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.exceptions;

public class DrawServiceException extends EditingServiceException {

    private static final long serialVersionUID = -305271540045091091L;

    private static final String MESSAGE =

        "An error has been produced drawing geometries.";

    private static final String KEY = "_DrawServiceException";

    public DrawServiceException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

    public DrawServiceException(String msg, Throwable ex) {

        super(msg, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class StartServiceException extends EditingServiceException {

    private static final long serialVersionUID = -1368352148381697338L;

    private static final String MESSAGE =

        "An error has been produced starting the service.";

    private static final String KEY = "_StartServiceException";

    public StartServiceException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class FinishServiceException extends EditingServiceException {

    private static final long serialVersionUID = -1289186566439942967L;

    private static final String MESSAGE =

        "An error has been produced finishing service.";

    private static final String KEY = "_FinishServiceException";

    public FinishServiceException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

    public FinishServiceException(String message, Throwable ex) {

        super(message, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class StartEditingException extends VectorEditingException {

    private static final long serialVersionUID = 3223155291885793084L;

    private static final String MESSAGE =

        "An error has been produced starting edition.";

    private static final String KEY = "_StartEditionException";

    public StartEditingException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

    public StartEditingException(String message, Throwable ex) {

        super(message, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class EditingServiceException extends VectorEditingException {

    private static final long serialVersionUID = 3053840379042307445L;

    private static final String MESSAGE =

        "An error has been produced in the VectorEditing library";

    private static final String KEY = "_EditingServiceException";

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <strong>Don't use this constructor in child classes.</strong>

     */

    public EditingServiceException() {

        super(MESSAGE, KEY, serialVersionUID);

    }

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <p>

     * <strong>Don't use this constructor in child classes.</strong>

     * </p>

     *

     * @param cause

     *            the original cause of the exception

     */

    public EditingServiceException(Exception cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

    }

    /**

     * @see BaseException#BaseException(String, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected EditingServiceException(String message, String key, long code) {

        super(message, key, code);

    }

    /**

     * @see BaseException#BaseException(String, Throwable, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param cause

     *            the original cause of the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected EditingServiceException(String message, Throwable cause,

        String key, long code) {

        super(message, cause, key, code);

    }

}

/**

 * 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.exceptions;

public class ParsePointException extends ParseException {

    private static final long serialVersionUID = 6461347009855377979L;

    private static final String MESSAGE =

        "An error has been produced parsing point inserted. Please check format";

    private static final String KEY = "_ParsePointException";

    public ParsePointException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class ChangeCurrentLayerException extends VectorEditingException {

    /**

     *

     */

    private static final long serialVersionUID = 8313545531034322640L;

    private static final String MESSAGE =

        "An error has been changing current layer.";

    private static final String KEY = "_ChangeCurrentLayerException";

    public ChangeCurrentLayerException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class ServiceInformationException extends VectorEditingException {

    private static final long serialVersionUID = 8313545531034322640L;

    private static final String MESSAGE =

        "An error has been getting service information.";

    private static final String KEY = "_ServiceInformationException";

    public ServiceInformationException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

    public ServiceInformationException(String message, Throwable ex) {

        super(message, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class StopServiceException extends EditingServiceException {

    private static final long serialVersionUID = -4063545494462367961L;

    private static final String MESSAGE =

        "An error has been produced stopping the service.";

    private static final String KEY = "_StopServiceException";

    public StopServiceException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

import org.gvsig.tools.exception.BaseException;

/**

 *

 * @author gvSIG team.

 *

 */

public class VectorEditingException extends BaseException {

    private static final long serialVersionUID = -3224623603201641463L;

    private static final String MESSAGE =

        "An error has been produced in the VectorEditing library";

    private static final String KEY = "_WasteException";

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <strong>Don't use this constructor in child classes.</strong>

     */

    public VectorEditingException() {

        super(MESSAGE, KEY, serialVersionUID);

    }

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <p>

     * <strong>Don't use this constructor in child classes.</strong>

     * </p>

     *

     * @param cause

     *            the original cause of the exception

     */

    public VectorEditingException(Exception cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

    }

    /**

     * @see BaseException#BaseException(String, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected VectorEditingException(String message, String key, long code) {

        super(message, key, code);

    }

    /**

     * @see BaseException#BaseException(String, Throwable, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param cause

     *            the original cause of the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected VectorEditingException(String message, Throwable cause,

        String key, long code) {

        super(message, cause, key, code);

    }

}

/**

 * 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.exceptions;

public class CreateEditingBehaviorException extends VectorEditingException {

    private static final long serialVersionUID = 1941515520264405144L;

    private static final String MESSAGE =

        "An error has been creating the editing behavior.";

    private static final String KEY = "_ChangeCurrentLayerException";

    public CreateEditingBehaviorException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class ParseValueException extends ParseException {

    private static final long serialVersionUID = 416446081762001139L;

    private static final String MESSAGE =

        "An error has been produced parsing value inserted. Please, check value format";

    private static final String KEY = "_InvalidOptionException";

    public ParseValueException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class InvalidEntryException extends EditingServiceException {

    private static final long serialVersionUID = 2515764199505996338L;

    private static final String MESSAGE =

        "An error has been produced validating entry inserted. Please, check entry format or possible entries";

    private static final String KEY = "_InvalidValueException";

    public InvalidEntryException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class EndEditingException extends VectorEditingException {

    private static final long serialVersionUID = 2150082352618473147L;

    private static final String MESSAGE =

        "An error has been produced ending edition.";

    private static final String KEY = "_EndEditionException";

    public EndEditingException(Throwable ex) {

        super(MESSAGE, ex, KEY, serialVersionUID);

    }

    public EndEditingException(String message, Throwable ex) {

        super(message, ex, KEY, serialVersionUID);

    }

}

/**

 * 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.exceptions;

public class ParseException extends VectorEditingException {

    private static final long serialVersionUID = 7934726070832975067L;

    private static final String MESSAGE = "An error has been produced parsing.";

    private static final String KEY = "_ParseException";

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <strong>Don't use this constructor in child classes.</strong>

     */

    public ParseException() {

        super(MESSAGE, KEY, serialVersionUID);

    }

    /**

     * Constructor to be used in rare cases, usually you must create a new child

     * exception class for each case.

     * <p>

     * <strong>Don't use this constructor in child classes.</strong>

     * </p>

     *

     * @param cause

     *            the original cause of the exception

     */

    public ParseException(Exception cause) {

        super(MESSAGE, cause, KEY, serialVersionUID);

    }

    /**

     * @see BaseException#BaseException(String, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected ParseException(String message, String key, long code) {

        super(message, key, code);

    }

    /**

     * @see BaseException#BaseException(String, Throwable, String, long).

     * @param message

     *            the default messageFormat to describe the exception

     * @param cause

     *            the original cause of the exception

     * @param key

     *            the key to use to search a localized messageFormnata

     * @param code

     *            the unique code to identify the exception

     */

    protected ParseException(String message, Throwable cause, String key,

        long code) {

        super(message, cause, key, code);

    }

}

/**

 * 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 java.util.List;

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

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.primitive.Point;

import org.gvsig.tools.service.Service;

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

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

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

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

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

/**

 * <p>

 * This service is used to interact with Editing providers. Each instance of

 * this has linked an Editing provider. At this moment services delegate all

 * functionality to providers. To get an instance of this use

 * {@link EditingManager#getEditingService(String, org.gvsig.fmap.dal.feature.FeatureStore)}

 * </p>

 * 

 * @author gvSIG team.

 * @version $Id$

 */

public interface EditingService extends Service {

    /**

     * Gets state of drawing. If this service has sufficient values with mouse

     * position to create geometries returns a {@link DrawingStatus}. List of

     * geometries of drawing status object can be different from final

     * geometries. Use this method to get a draft status information while user

     * is drawing.

     *

     * @param mousePosition

     *            Mouse position to draw geometries.

     * @return A {@link DrawingStatus} object with a list of geometries and

     *         information.

     * @throws DrawServiceException

     *             if there are some error creating geometries.

     */

    public DrawingStatus getDrawingStatus(Point mousePosition)

        throws DrawServiceException;

    /**

     * Gets a <code>List</code> with all parameters of service. Each parameter

     * has name, description and types. See {@link EditingServiceParameter}.

     *

     * @return A list of {@link EditingServiceParameter} objects.

     */

    public List<EditingServiceParameter> getParameters();

    /**

     * Gets next parameter needed by service. The parameter has information

     * about its name, description and types. Returns <code>null</code> if all

     * parameters have values.

     *

     * @return An {@link EditingServiceParameter} object that represents the

     *         next parameter.

     */

    public EditingServiceParameter next();

    /**

     * Sets value to service. The value will be put in the next parameter need

     * by this service.

     *

     * @param value

     *            Object to be set to next {@link EditingServiceParameter}

     * @throws InvalidEntryException

     *             If the next parameter needed does not accept this value.

     */

    public void setValue(Object value) throws InvalidEntryException;

    /**

     * Stops service. Use this method to stop and clean values of service.

     *

     * @throws StopServiceException

     *             Stops service initializing necessary parameters of service.

     *             This method is called when user cancels service.

     */

    public void stop() throws StopServiceException;

    /**

     * Finalizes service. Use this method to get the result of service without

     * store it to {@link FeatureStore}. Make sure that service has all required

     * values.

     *

     * @return Geometry created or modified from added values.

     * @throws FinishServiceException

     *             if there are some error getting values,

     *             creating geometries.

     */

    public Geometry finish() throws FinishServiceException;

    /**

     * Finalizes service and stores the result to {@link FeatureStore} of this

     * service. Use this method to store the result of this service. Make sure

     * that service has all required values.

     *

     * @throws FinishServiceException

     *             if there are some error getting values,

     *             creating geometries or inserting/updating/removing geometries

     *             from feature store.

     */

    public void finishAndStore() throws FinishServiceException;

    /**

     * Starts service. Use this method before add values.

     *

     * @throws StartServiceException

     *             if there are some error starting service.

     * @throws InvalidEntryException

     *             if the entry of provider is not valid

     */

    public void start() throws StartServiceException, InvalidEntryException;

    /**

     * Gets service name. The name of service is the same name of linked

     * provider.

     *

     * @return Name of service.

     */

    public String getName();

}

/**

 * 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.

 */