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.spi;

import java.util.List;

import java.util.Map;

import org.gvsig.euclidean.EuclideanLine2D;

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

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

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

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

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

import org.gvsig.fmap.geom.Geometry;

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

import org.gvsig.fmap.geom.exception.CreateGeometryException;

import org.gvsig.fmap.geom.operation.GeometryOperationException;

import org.gvsig.fmap.geom.operation.GeometryOperationNotSupportedException;

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

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

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

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

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

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

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

import org.gvsig.fmap.mapcontext.MapContext;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.service.spi.ProviderServices;

/**

 * EditingProviderServices provides services to provides.

 *

 * @author gvSIG team.

 * @version $Id$

 */

public interface EditingProviderServices extends ProviderServices {

    /**

     * Makes a console message. Parameters must be i18n keys. If you don't want

     * any text before options use null. The format of console message returned

     * is:

     * "preText". ["keyOption1"]valueOption1 ["keyOption2"]valueOption2...

     *

     * @param preText

     *            i18n key of first part of message.

     * @param options

     *            Map with accepted options. Keys of map should be first letter

     *            of option and value of map should be an i18n key. For example,

     *            a valid map could be <"A","arc_mode">, <"C","close_polyline">

     * @return console message created

     */

    public String makeConsoleMessage(String preText, Map<String, String> options);

    /**

     * Inserts the feature into feature store.

     *

     * @param feature

     *            to be insert

     * @param featureStore

     *            where feature will be insert

     */

    public void insertFeatureIntoFeatureStore(Feature feature,

        FeatureStore featureStore);

    /**

     * Inserts the geometry into feature store.

     *

     * @param geometry

     *            to be insert

     * @param featureStore

     *            where geometry will be insert

     */

    public void insertGeometryIntoFeatureStore(Geometry geometry,

        FeatureStore featureStore);

    /**

     * Deletes the feature from feature store.

     *

     * @param feature

     * @param featureStore

     */

    public void deleteFeatureFromFeatureStore(Feature feature,

        FeatureStore featureStore);

    /**

     * Deletes the feature from feature set.

     *

     * @param feature

     * @param featureStore

     * @param featureSet

     */

    public void deleteFeatureFromFeatureSet(Feature feature,

        FeatureStore featureStore, FeatureSet featureSet);

    /**

     * Updates the feature received as parameter in feature store.

     *

     * @param feature

     *            to be updated

     * @param featureStore

     *            where feature will be updated

     */

    public void updateFeatureInFeatureStore(Feature feature,

        FeatureStore featureStore);

    /**

     * Creates a circle as of center and radius.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param center

     *            of new circle

     * @param radius

     *            of new circle

     * @param subtype

     *            subtype of circle. See {@link Geometry.SUBTYPES}

     * @return The circle created with center and radius

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Circle createCircle(Point center, double radius, int subtype)

        throws CreateGeometryException;

    /**

     * Creates a circle from three points.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param firstPoint

     *            of circle

     * @param secondPoint

     *            of circle

     * @param thirdPoint

     *            of circle

     * @param subtype

     *            subtype of circle. See {@link Geometry.SUBTYPES}

     * @return The circle created from three points received as parameters.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Circle createCircle(Point firstPoint, Point secondPoint,

        Point thirdPoint, int subtype) throws CreateGeometryException;

    /**

     * Creates a circle from five points.The first two points are two points on a tangent to the circle.The next two are two points on another tangent to the circle.The last one is a point near the center of the circle.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param firstPoint

     * @param secondPoint

     * @param thirdPoint

     * @param fourthPoint

     * @param fifthPoint

     * @param subtype

     *            subtype of circle. See {@link Geometry.SUBTYPES}

     * @return The circle created from three points received as parameters.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Circle createCircle(Point firstPoint, Point secondPoint,

        Point thirdPoint, Point fourthPoint, Point fifthPoint, int subtype) throws CreateGeometryException;

    /**

     * Creates a circle from two tangents and one point.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param line1

     *            A tangent line

     * @param line2

     *            Another tangent line

     * @param point

     *            A point near the center of the circle.

     * @param subtype

     *            subtype of circle. See {@link Geometry.SUBTYPES}

     * @return The circle created from two tangents and one point received as parameters.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Circle createCircle(EuclideanLine2D line1, EuclideanLine2D line2,

        Point point, int subtype) throws CreateGeometryException;

    /**

     * Creates a circle from two tangent geometries and the radius.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param geometry1

     *            A tangent geometry

     * @param geometry2

     *            Another tangent geometry

     * @param radius

     *            the radius of the cicle.

     * @param firstPoint

     *            a point near tangent point of geometry1

     * @param secondPoint

     *            a point near tangent point of geometry2

     * @param subtype

     *            subtype of circle. See {@link Geometry.SUBTYPES}

     * @return The circle created from two tangent geometries and the radius received as parameters.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Circle createCircle(Geometry geometry1, Geometry geometry2,

        double radius, Point firstPoint, Point secondPoint, int subtype) throws CreateGeometryException;

    /**

     * Creates an arc as of center, radius, start angle and extension angle.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param center

     *            center of arc.

     * @param radius

     *            of arc.

     * @param startAngle

     *            of arc in radians

     * @param angleExt

     *            of arc in radians

     * @param subtype

     *            subtype of arc. See {@link Geometry.SUBTYPES}

     * @return The arc created with center, radius, start angle and extension

     *         angle.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Arc createArc(Point center, double radius, double startAngle,

        double angleExt, int subtype) throws CreateGeometryException;

    /**

     * Creates an arc as of three points.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param start

     *            point of arc

     * @param middle

     *            point of arc. It can be any point of arc.

     * @param end

     *            point of arc

     * @param subtype

     *            of arc. See {@link Geometry.SUBTYPES}

     * @return The arc created that it start at start point, cross middle

     *         point and end at end point.

     * @throws org.gvsig.tools.exception.BaseException

     */

    @Deprecated

    public Arc createArc(Point start, Point middle, Point end, int subtype)

        throws BaseException;

    /**

     * Creates an ellipse from start and end point of A axis and half length

     * of B axis.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param firstPointAxisA

     *            first point of A axis

     * @param secondPointAxisA

     *            second point of B axis

     * @param halfLengthAxisB

     *            half length of B axis

     * @param subtype

     *            of ellipse See {@link Geometry.SUBTYPES}

     * @return The ellipse created

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Arc createEllipse(Point firstPointAxisA,

        Point secondPointAxisA, double halfLengthAxisB, int subtype)

        throws CreateGeometryException;

    /**

     * Creates a filled ellipse from start and end point of A axis and half length

     * of B axis.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param firstPointAxisA

     *            first point of A axis

     * @param secondPointAxisA

     *            second point of B axis

     * @param halfLengthAxisB

     *            half length of B axis

     * @param subtype

     *            of ellipse See {@link Geometry.SUBTYPES}

     * @return The ellipse created

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Ellipse createFilledEllipse(Point firstPointAxisA,

        Point secondPointAxisA, double halfLengthAxisB, int subtype)

        throws CreateGeometryException;

    /**

     * Creates point with x and y values.

     * @deprecated

     * Use createPoint from GeometryManager

     *

     * @param x

     *            The X coordinate

     * @param y

     *            The y coordinate

     * @param subtype

     *            of point. See {@link Geometry.SUBTYPES}

     * @return The Point created.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Point createPoint(double x, double y, int subtype)

        throws CreateGeometryException;

    /**

     * Creates line as of two point coordinates.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param x1

     *            The X1 coordinate

     * @param y1

     *            The y1 coordinate

     * @param x2

     *            The X2 coordinate

     * @param y2

     *            The y2 coordinate

     * @param subtype

     *            of line. See {@link Geometry.SUBTYPES}

     * @return The Line created.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Line createLine(double x1, double y1, double x2, double y2,

        int subtype) throws CreateGeometryException;

    /**

     * Creates line as of two point objects.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param p1

     *            First point

     * @param p2

     *            Second point

     * @param subtype

     *            of line. See {@link Geometry.SUBTYPES}

     * @return The Line created.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Line createLine(Point p1, Point p2, int subtype)

        throws CreateGeometryException;

    /**

     * Create Spline from point list

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param points

     * @param subtype

     * @return

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Spline createSpline(List<Point> points, int subtype)

        throws CreateGeometryException;

    /**

     * Gets {@link SUBTYPES} of the feature store received as parameter.

     *

     * @param featureStore

     * @return the subtype of the default geometry.

     * @throws DataException

     *             if there some problem getting subtype.

     */

    public int getSubType(FeatureStore featureStore) throws DataException;

    /**

     * Gets {@link GeometryType} of the feature store received as parameter.

     *

     * @param featureStore

     * @return the GeometryType of the default geometry.

     * @throws DataException

     *             if there some problem getting subtype.

     */

    public GeometryType getGeomType(FeatureStore featureStore)

        throws DataException;

    /**

     * Returns a copy of a feature without primary keys data

     *

     * @param featureStore

     * @param feature

     * @return the copy of a feature without primary keys data

     * @throws DataException

     *             if there some problem getting subtype.

     */

    public EditableFeature getFeatureCopyWithoutPK(FeatureStore featureStore,

        Feature feature) throws DataException;

    /**

     * Gets center point of three points.

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param a

     *            Point one

     * @param b

     *            Point two

     * @param c

     *            Point three

     * @param subtype

     *            of point created. See {@link Geometry.SUBTYPES}

     * @return Point center.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Point getCenter(Point a, Point b, Point c, int subtype)

        throws CreateGeometryException;

    /**

     * Gets midpoint of two points

     * @deprecated

     * Use same method in GeometryUtils

     *

     * @param a

     *            Point one

     * @param b

     *            Point two

     * @param subtype

     *            of point created. See {@link Geometry.SUBTYPES}

     * @return Mid point of points.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Point getMidPoint(Point a, Point b, int subtype)

        throws CreateGeometryException;

    /**

     * Gets the slope of the line created by points received.

     * @deprecated

     * Use EuclideanLine2D

     *

     * @param point

     *            of line

     * @param nextPoint

     *            of line

     * @return An array with two valors. First is slope of line and second is

     *         y-intercept

     */

    @Deprecated

    public Double[] getLineParams(Point point, Point nextPoint);

    /**

     * Gets perpendicular of line formed by slope and y-intercept received as

     * parameters.The perpendicular cross the point received as parameter.

     * @deprecated

     * Use getPerpendicular method from EuclideanLine2D package

     *

     * @param m

     *            slope of line

     * @param b

     *            y-intercep of line

     * @param point

     *            Point crossed by perpendicular

     * @param subtype

     *            of perpendicular points. See {@link Geometry.SUBTYPES}

     * @return Line perpendicular to line received as parameter. The

     *         perpendicular cross point received as parameter.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Point[] getPerpendicular(Double m, Double b, Point point, int subtype)

        throws CreateGeometryException;

    /**

     * Gets intersection point of two lines.If lines are parallels return null.

     * @deprecated

     * Use getIntersection method from EuclideanLine2D package

     *

     * @param lineA

     * @param lineB

     * @param subtype

     *            of intersection point. See {@link Geometry.SUBTYPES}

     * @return Point of intersection. If lines are parallels return null.

     * @throws org.gvsig.fmap.geom.exception.CreateGeometryException

     */

    @Deprecated

    public Point getIntersection(Point[] lineA, Point[] lineB, int subtype)

        throws CreateGeometryException;

    /**

     * Gets angle between two points.

     *

     * @param start

     * @param end

     * @return Angle between two points.

     * @throws org.gvsig.fmap.geom.operation.GeometryOperationNotSupportedException

     * @throws org.gvsig.fmap.geom.operation.GeometryOperationException

     */

    public double getAngle(Point start, Point end)

        throws GeometryOperationNotSupportedException,

        GeometryOperationException;

    /**

     * Gets distance between two angles.

     *

     * @param angle1

     * @param angle2

     * @return Distance of angles

     */

    public double angleDistance(double angle1, double angle2);

    /**

     * Return a geometry from store that intersects with the point.

     * 

     * @param point

     * @param store

     * @param mapContext

     * @return

     */

    public Geometry getGeometry(Point point, FeatureStore store, MapContext mapContext);

    /**

     * Return a geometry that intersects with the point from the visible layers 

     * if it can't be found in the feature store.

     * 

     * @param point

     * @param store

     * @param mapContext

     * @return

     */

    public Geometry getGeometryOfVisibleLayers(Point point, FeatureStore store, MapContext mapContext);

}