Application: gvSIG desktop

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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 3

 * 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.fmap.geom;

import java.awt.geom.PathIterator;

import java.util.List;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.geom.aggregate.MultiCurve;

import org.gvsig.fmap.geom.aggregate.MultiLine;

import org.gvsig.fmap.geom.aggregate.MultiPoint;

import org.gvsig.fmap.geom.aggregate.MultiPolygon;

import org.gvsig.fmap.geom.aggregate.MultiPrimitive;

import org.gvsig.fmap.geom.aggregate.MultiSurface;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.service.Manager;

import org.gvsig.tools.service.ServiceException;

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

/**

 * This singleton provides a centralized access to gvSIG's Geometry Model.

 * Its responsibilities are:<br>

 *

 * <ul>

 * <li>Offering a set of convenient methods for registering and retrieving

 * geometry types.

 * <li>Offering a set of convenient methods for registering and retrieving

 * geometry operations associated to one or more geometry types.

 * <li>Offering a set of convenient methods for registering and retrieving new

 * geometries.

 * </ul>

 *

 * @author jiyarza

 * @author <a href="mailto:jpiera@gvsig.org">Jorge Piera</a>

 */

public interface GeometryManager extends Manager, ServiceManager {

//    

//  Spatial index "Quadtree" is faster in creation but don't 

//  support of nearest query.

//    

//  Spatial index "RTree" is faster in queries and support 

//  nearest queries.

//  

//  The library expose a default implementation for RTree and QuadTree

//    

    public static final String SPATIALINDEX_DEFAULT_RTREE = "JSIRTree";

    public static final String SPATIALINDEX_DEFAULT_QUADTREE = "JTSQuadtree";

    public interface OPERATIONS {

        public final static String FROMWKT = "FromWKT";

        public final static String FROMWKB = "FromWKB";

        public final static String FROMEWKB = "FromEWKB";

        public final static String TOWKT = "ToWKT";

        public final static String TOWKB = "ToWKB";

        public final static String TOEWKB = "ToEWKB";

    }

    /**

     * <p>

     * Registers a GeometryOperation associated to a GeometryType. Returns an

     * unique index that is used later to identify and invoke the operation.

     * </p>

     * <p>

     * By convention this index should be in a final and static variable in the

     * class that implements the operation. The value of this variable must be

     * set using the method

     * {@link GeometryManager#getGeometryOperationCode(String)}:<BR>

     *

     * <pre>

     *

     * public class MyOperation extends GeometryOperation {

     *

     *     public static final int CODE = GeometryLocator.getGeometryManager()

     *         .getGeometryOperationCode("MyOperation");

     * }

     * </pre>

     *

     * </p>

     *

     * @param geomOpName

     *            Operation's unique name

     * @param geomOp

     *            Specific GeometryOperation's instance implementing this

     *            operation

     * @param geomType

     *            GeometryType instance to which this operation should be

     *            associated

     * @return Index assigned to this operation. This index is used later to

     *         access the operation.

     *

     */

    public int registerGeometryOperation(String geomOpName,

        GeometryOperation geomOp, GeometryType geomType);

    /**

     * <p>

     * Registers a GeometryOperation that is common for all GeometryType

     * (registered yet or not). Returns an unique index that is used later to

     * identify and invoke the operation.

     * </p>

     * <p>

     * By convention this index should be in a final and static variable in the

     * class that implements the operation. The value of this variable must be

     * set using the method

     * {@link GeometryManager#getGeometryOperationCode(String)}:<BR>

     *

     * <pre>

     *

     * public class MyOperation extends GeometryOperation {

     *

     *     public static final int CODE = GeometryLocator.getGeometryManager()

     *         .getGeometryOperationCode("MyOperation");

     * }

     * </pre>

     *

     * </p>

     *

     * @param geomOpName

     *            Operation's unique name

     * @param geomOp

     *            Specific GeometryOperation's instance implementing this

     *            operation

     * @return Index assigned to this operation. This index is used later to

     *         access the operation.

     */

    public int registerGeometryOperation(String geomOpName,

        GeometryOperation geomOp);

    /**

     * <p>

     * Registers a GeometryOperation associated to a GeometryType, that has been

     * specified using the type code and the subtype code. Returns an unique

     * index that is used later to identify and invoke the operation.

     * </p>

     * <p>

     * By convention this index should be in a final and static variable in the

     * class that implements the operation. The value of this variable must be

     * set using the method

     * {@link GeometryManager#getGeometryOperationCode(String)}:<BR>

     *

     * <pre>

     *

     * public class MyOperation extends GeometryOperation {

     *

     *     public static final int CODE = GeometryLocator.getGeometryManager()

     *         .getGeometryOperationCode("MyOperation");

     * }

     * </pre>

     *

     * </p>

     * <p>

     * This method is only used if you have not a reference to the GeometryType

     * associated to the geometry class. If you have such reference then it is

     * slightly faster to use the method that receives the GeometryType.<br>

     * </p>

     *

     * @param geomOpName

     *            Operation's unique name

     * @param geomOp

     *            Specific GeometryOperation's instance implementing this

     *            operation

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return Index assigned to this operation. This index is used later to

     *         access the operation.

     * @throws GeometryTypeNotSupportedException

     *             Returns this exception if there is not a registered geometry

     *             with

     *             these type and subtype

     * @throws GeometryTypeNotValidException

     *             Returns if the type and subtype are not valid

     */

    public int registerGeometryOperation(String geomOpName,

        GeometryOperation geomOp, int type, int subType)

        throws GeometryTypeNotSupportedException, GeometryTypeNotValidException;

    /**

     * <p>

     * Registers a GeometryOperation associated to all the geometries with a

     * concrete type. Returns an unique index that is used later to identify and

     * invoke the operation.<br>

     * </p>

     * <p>

     * By convention this index should be in a final and static variable in the

     * class that implements the operation. The value of this variable must be

     * set using the method

     * {@link GeometryManager#getGeometryOperationCode(String)}:<BR>

     *

     * <pre>

     *

     * public class MyOperation extends GeometryOperation {

     *

     *     public static final int CODE = GeometryLocator.getGeometryManager()

     *         .getGeometryOperationCode("MyOperation");

     * }

     * </pre>

     *

     * </p>

     *

     * @param geomOpName

     *            Operation's unique name

     * @param geomOp

     *            Specific GeometryOperation's instance implementing this

     *            operation

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @return Index assigned to this operation. This index is used later to

     *         access the operation.

     */

    public int registerGeometryOperation(String geomOpName,

        GeometryOperation geomOp, int type);

    /**

     * <p>

     * Registers a GeometryOperation associated to all the geometries which

     * super type matches with a concrete type. Returns an unique index that

     * is used later to identify and invoke the operation.<br>

     * </p>

     * <p>

     * By convention this index should be in a final and static variable in the

     * class that implements the operation. The value of this variable must be

     * set using the method

     * {@link GeometryManager#getGeometryOperationCode(String)}:<BR>

     *

     * <pre>

     *

     * public class MyOperation extends GeometryOperation {

     *

     *     public static final int CODE = GeometryLocator.getGeometryManager()

     *         .getGeometryOperationCode("MyOperation");

     * }

     * </pre>

     *

     * </p>

     *

     * @param geomOpName

     *            Operation's unique name

     * @param geomOp

     *            Specific GeometryOperation's instance implementing this

     *            operation

     * @param superType

     *            super type of geometries that is used to register

     *            the operation. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @return Index assigned to this operation. This index is used later to

     *         access the operation.

     */

    public int registerGeometryOperationBySuperType(String geomOpName,

        GeometryOperation geomOp, int superType);

    /**

     * <p>

     * Registers a GeometryOperation associated to all the geometries which

     * super subType matches with a concrete subType. Returns an unique index that

     * is used later to identify and invoke the operation.<br>

     * </p>

     * <p>

     * By convention this index should be in a final and static variable in the

     * class that implements the operation. The value of this variable must be

     * set using the method

     * {@link GeometryManager#getGeometryOperationCode(String)}:<BR>

     *

     * <pre>

     *

     * public class MyOperation extends GeometryOperation {

     *

     *     public static final int CODE = GeometryLocator.getGeometryManager()

     *         .getGeometryOperationCode("MyOperation");

     * }

     * </pre>

     *

     * </p>

     *

     * @param geomOpName

     *            Operation's unique name

     * @param geomOp

     *            Specific GeometryOperation's instance implementing this

     *            operation

     * @param superSubType

     *            super subType of geometries that is used to register

     *            the operation. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return Index assigned to this operation. This index is used later to

     *         access the operation.

     */

    public int registerGeometryOperationBySuperSubType(String geomOpName,

        GeometryOperation geomOp, int superSubType);

    /**

     * <p>

     * Registers a GeometryOperation associated to all the geometries with a

     * concrete subtype. Returns an unique index that is used later to identify

     * and invoke the operation.<br>

     * </p>

     * <p>

     * By convention this index should be in a final and static variable in the

     * class that implements the operation. The value of this variable must be

     * set using the method

     * {@link GeometryManager#getGeometryOperationCode(String)}:<BR>

     *

     * <pre>

     *

     * public class MyOperation extends GeometryOperation {

     *

     *     public static final int CODE = GeometryLocator.getGeometryManager()

     *         .getGeometryOperationCode("MyOperation");

     * }

     * </pre>

     *

     * </p>

     *

     * @param geomOpName

     *            Operation's unique name

     * @param geomOp

     *            Specific GeometryOperation's instance implementing this

     *            operation

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return Index assigned to this operation. This index is used later to

     *         access the operation.

     */

    public int registerGeometryOperationBySubtype(String geomOpName,

        GeometryOperation geomOp, int subType);

    /**

     * <p>

     * Registers a GeometryType instance.

     * </p>

     *

     * @param geometryType

     *            A {@link GeometryType} instance to create {@link Geometry} objects

     */

    public void registerGeometryType(GeometryType geometryType);

    /**

     * <p>

     * Registers a Geometry implementation class with a predefined geometry type

     * and returns the associated GeometryType instance. Available predefined

     * types are defined in {@link Geometry.TYPES} and the subtypes are defined

     * in {@link Geometry.SUBTYPES}.

     * </p>

     * <p>

     * How to register a geometry class with a predefined type:

     *

     * <pre>

     *

     * GeometryType geomType = GeometryLocator.getGeometryManager()

     *     .registerBasicGeometryType(Point2D.class, "Point2D", Geometry.TYPES.POINT,

     *         Geometry.SYBTYPES.GEOM2D);

     * </pre>

     *

     * </p>

     *

     * @param geomClass

     *            Geometry subclass. It must not be null and must implement

     *            Geometry, otherwise an exception

     *            is raised.

     * @param name

     *            Symbolic name for the geometry type, it can be null. If it is

     *            null then the symbolic name

     *            will be the simple class name.

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return Instance of GeometryType associated to the Geometry

     *         implementation class

     *         geomClass

     * @throws IllegalArgumentException

     *             If geomClass is null or does not implement Geometry

     */

    public GeometryType registerGeometryType(Class geomClass, String name,

        int type, int subType);

    /**

     * <p>

     * Registers a Geometry implementation class with a predefined geometry type

     * and returns the associated GeometryType instance. Available predefined

     * types are defined in {@link Geometry.TYPES} and the subtypes are defined

     * in {@link Geometry.SUBTYPES}.

     * </p>

     * <p>

     * It adds also the super type and the super subType of the geometry, that

     * can be used to check if the type (or the subtype) inherits of other

     * type (or subType)

     * </p>

     * <p>

     * How to register a geometry class with a predefined type:

     *

     * <pre>

     *

     * GeometryType geomType = GeometryLocator.getGeometryManager()

     *     .registerBasicGeometryType(Arc3D.class, "Arc3D", Geometry.TYPES.ARC,

     *         Geometry.SYBTYPES.GEOM3D, Geometry.TYPES.CURVE, Geometry.SYBTYPES.GEOM2D);

     * </pre>

     *

     * </p>

     *

     * @param geomClass

     *            Geometry subclass. It must not be null and must implement

     *            Geometry, otherwise an exception

     *            is raised.

     * @param name

     *            Symbolic name for the geometry type, it can be null. If it is

     *            null then the symbolic name

     *            will be the simple class name.

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @param superType

     *              Super type of a geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param superSubType

     *             Super subType of a geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return Instance of GeometryType associated to the Geometry

     *         implementation class

     *         geomClass

     * @throws IllegalArgumentException

     *             If geomClass is null or does not implement Geometry

     */

    public GeometryType registerGeometryType(Class geomClass, String name,

        int type, int subType, int superType, int superSubType);

    /**

     * <p>

     * Registers a Geometry implementation class with a predefined geometry type

     * and returns the associated GeometryType instance. Available predefined

     * types are defined in {@link Geometry.TYPES} and the subtypes are defined

     * in {@link Geometry.SUBTYPES}.

     * </p>

     * <p>

     * It adds also the super type of the geometry, that can be used to

     * check if the type inherits of other type.

     * </p>

     * <p>

     * How to register a geometry class with a predefined type:

     *

     * <pre>

     *

     * GeometryType geomType = GeometryLocator.getGeometryManager()

     *     .registerBasicGeometryType(Arc3D.class, "Arc3D", Geometry.TYPES.ARC,

     *         Geometry.SYBTYPES.GEOM3D, Geometry.TYPES.CURVE);

     * </pre>

     *

     * </p>

     *

     * @param geomClass

     *            Geometry subclass. It must not be null and must implement

     *            Geometry, otherwise an exception

     *            is raised.

     * @param name

     *            Symbolic name for the geometry type, it can be null. If it is

     *            null then the symbolic name

     *            will be the simple class name.

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @param superType

     *              Super type of a geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @return Instance of GeometryType associated to the Geometry

     *         implementation class

     *         geomClass

     * @throws IllegalArgumentException

     *             If geomClass is null or does not implement Geometry

     */

    public GeometryType registerGeometryType(Class geomClass, String name,

        int type, int subType, int superType);

    /**

     * <p>

     * Registers a Geometry implementation class with a predefined geometry type

     * and returns the associated GeometryType instance. Available predefined

     * types are defined in {@link Geometry.TYPES} and the subtypes are defined

     * in {@link Geometry.SUBTYPES}.

     * </p>

     * <p>

     * It adds also the super types and the super subTypes of the geometry, that

     * can be used to check if the type (or the subtype) inherits of other

     * types (or subTypes)

     * </p>

     * <p>

     * How to register a geometry class with a predefined type:

     *

     * <pre>

     *

     * GeometryType geomType = GeometryLocator.getGeometryManager()

     *     .registerBasicGeometryType(Circle3DM.class, "Circle3DM", Geometry.TYPES.CIRCLE,

     *         Geometry.SYBTYPES.GEOM3DM,

     *         new int[]{Geometry.TYPES.CURVE, Geometry.TYPES.GEOMETRY},

     *         new int[]{Geometry.SYBTYPES.GEOM2D, Geometry.SYBTYPES.GEOM3D});

     * </pre>

     *

     * </p>

     *

     * @param geomClass

     *            Geometry subclass. It must not be null and must implement

     *            Geometry, otherwise an exception

     *            is raised.

     * @param name

     *            Symbolic name for the geometry type, it can be null. If it is

     *            null then the symbolic name

     *            will be the simple class name.

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @param superTypes

     *              List of the super types of a geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param superSubTypes

     *             List of the super subType of a geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return Instance of GeometryType associated to the Geometry

     *         implementation class

     *         geomClass

     * @throws IllegalArgumentException

     *             If geomClass is null or does not implement Geometry

     */

    public GeometryType registerGeometryType(Class geomClass, String name,

        int type, int subType, int[] superTypes, int superSubTypes[]);

    /**

     * <p>

     * Registers a Geometry implementation class with a predefined geometry type

     * and returns the associated GeometryType instance. Available predefined

     * types are defined in {@link Geometry.TYPES} and the subtypes are defined

     * in {@link Geometry.SUBTYPES}.

     * </p>

     * <p>

     * It adds also the super types and the super subTypes of the geometry, that

     * can be used to check if the type inherits of other types.

     * </p>

     * <p>

     * How to register a geometry class with a predefined type:

     *

     * <pre>

     *

     * GeometryType geomType = GeometryLocator.getGeometryManager()

     *     .registerBasicGeometryType(Circle2D.class, "Circle2DM", Geometry.TYPES.CIRCLE,

     *         Geometry.SYBTYPES.GEOM2D,

     *         new int[]{Geometry.TYPES.CURVE, Geometry.TYPES.SURFACE});

     * </pre>

     *

     * </p>

     *

     * @param geomClass

     *            Geometry subclass. It must not be null and must implement

     *            Geometry, otherwise an exception

     *            is raised.

     * @param name

     *            Symbolic name for the geometry type, it can be null. If it is

     *            null then the symbolic name

     *            will be the simple class name.

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @param superTypes

     *              List of the super types of a geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @return Instance of GeometryType associated to the Geometry

     *         implementation class

     *         geomClass

     * @throws IllegalArgumentException

     *             If geomClass is null or does not implement Geometry

     */

    public GeometryType registerGeometryType(Class geomClass, String name,

        int type, int subType, int[] superTypes);

    /**

     * <p>

     * Registers a Geometry implementation class with a predefined geometry type

     * and returns the associated GeometryType instance. Available predefined

     * types are defined in {@link Geometry.TYPES} and the subtypes are defined

     * in {@link Geometry.SUBTYPES}.

     * </p>

     * <p>

     * In this case the symbolic name will be the geometry's simple class name

     * </p>

     * How to register a new geometry type:

     *

     * <pre>

     *

     * GeometryType geomType = GeometryLocator.getGeometryManager()

     *     .registerBasicGeometryType(Point2D.class, Geometry.TYPES.POINT,

     *         Geometry.SYBTYPES.GEOM2D);

     * </pre>

     *

     * @param geomClass

     *            Geometry implementation class. It must not be null and must

     *            implement Geometry,

     *            otherwise an exception is thrown.

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return Instance of GeometryType associated to the Geometry

     *         implementation class

     * @throws IllegalArgumentException

     *             If geomClass is null or does not implement Geometry

     */

    public GeometryType registerGeometryType(Class geomClass, int type,

        int subType);

    /**

     * <p>

     * Returns an instance of GeometryType given the Geometry type and the

     * subtype.

     * </p>

     *

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return Instance of GeometryType associated to the type and the subtype

     * @throws GeometryTypeNotSupportedException

     *             Returns this exception if there is not a registered geometry

     *             with

     *             these type and subtype

     * @throws GeometryTypeNotValidException

     *             Returns if the type and subtype are not valid

     */

    public GeometryType getGeometryType(int type, int subType)

        throws GeometryTypeNotSupportedException, GeometryTypeNotValidException;

    /**

     * <p>

     * This method creates a {@link Geometry} with the type specified by this

     * GeometryType. The geometry is empty, and all the internal attributes must

     * be assigned to a value when the geometry has been created.

     * </p>

     * <p>

     * This example creates a point2D and sets the coordinates to 1,1:

     *

     * <pre>

     * Point point =

     *     (Point) GeometryLocator.getGeometryManager().create(GEOMETRY.TYPES.POINT,

     *         GEOMETRY.SUBTYPES.GEOM2D);

     * point.setX(1);

     * point.setY(1);

     * </pre>

     *

     * </p>

     *

     * @param geomType

     *            The geometry type

     * @return

     *         A instance of a geometry.

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create

     *             the geometry.

     */

    public Geometry create(GeometryType geomType)

        throws CreateGeometryException;

    /**

     * <p>

     * Creates a Envelope with a concrete subtype. The envelope is empty and it

     * have to be filled with the corners once has been created.

     * </p>

     *

     * @param subType

     *            SubType of envelope. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return

     *         A Envelope

     * @throws CreateEnvelopeException

     *             If it is not possible to create the envelope.

     */

    public Envelope createEnvelope(int subType) throws CreateEnvelopeException;

    /**

     * <p>

     * Creates a Envelope with a concrete subtype. It sets the values for the

     * lower corner and the upper corner (in 2D) using the method parameters.

     * </p>

     *

     * @param minX

     *            The minimum value for the X coordinate.

     * @param minY

     *            The minimum value for the Y coordinate.

     * @param maxX

     *            The maximum value for the X coordinate.

     * @param maxY

     *            The maximum value for the Y coordinate.

     * @param subType

     *            SubType of envelope. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return

     * @throws CreateEnvelopeException

     */

    public Envelope createEnvelope(double minX, double minY, double maxX,

        double maxY, int subType) throws CreateEnvelopeException;

    /**

     * <p>

     * This method creates a {@link Geometry} with the type specified by this

     * name. If a geometry with this name doesn't exist, a

     * {@link IllegalArgumentException} is thrown. The geometry is empty, and

     * all the internal attributes must be assigned to a value when the geometry

     * has been created.

     * </p>

     * <p>

     * This example creates a point2D and sets the coordinates to 1,1: It

     * supposes that there is a Point2D class with name "Point2D".

     * </p>

     *

     * <pre>

     * Point point = (Point) GeometryLocator.getGeometryManager().create("Point2D");

     * point.setX(1);

     * point.setY(1);

     * </pre>

     *

     * @param name

     *            The name of the geometry type

     * @return

     *         A instance of a geometry.

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create

     *             the geometry.

     */

    public Geometry create(String name) throws CreateGeometryException;

    /**

     * Create a geometry from a WKT definition.

     *

     * This is a utility method to wrap the invocation to the operation

     * {@link OPERATIONS#FROMWKT}.

     *

     * @param wkt

     *            geometry in Well-known text format

     *

     * @return the geometry as a Geometry

     *

     * @throws CreateGeometryException

     * @throws GeometryException

     */

    public Geometry createFrom(String wkt, String srs)

        throws CreateGeometryException, GeometryException;

    public Geometry createFrom(String wkt, IProjection srs)

        throws CreateGeometryException, GeometryException;

    public Geometry createFrom(String wkt) throws CreateGeometryException,

        GeometryException;

    /**

     * Create a geometry from a WKB definition.

     *

     * This is a utility method to wrap the invocation to the operation

     * {@link OPERATIONS#FROMWKB}.

     *

     * @param wkb

     *            geometry in well-known binary format

     *

     * @return the geometry as a Geometry

     *

     * @throws CreateGeometryException

     * @throws GeometryException

     */

    public Geometry createFrom(byte[] wkb) throws CreateGeometryException,

        GeometryException;

    public Geometry createFrom(byte[] wkb, IProjection srs) throws CreateGeometryException,

        GeometryException;

    /**

     * <p>

     * This method creates a {@link Geometry} with a concrete type and subtype.

     * The geometry is empty, and all the internal attributes must be assigned

     * to a value when the geometry has been created.

     * </p>

     * <p>

     * This example creates a point2D and sets the coordinates to 1,1. It

     * supposes that there is a Point2D class with the id 1.

     * </p>

     *

     * <pre>

     * Point point =

     *     (Point) GeometryLocator.getGeometryManager().create(Geometry.TYPES.POINT,

     *         Geometry.SYBTYPES.GEOM2D);

     * point.setX(1);

     * point.setY(1);

     * </pre>

     *

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return

     *         A instance of a geometry.

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create

     *             the geometry.

     */

    public Geometry create(int type, int subType)

        throws CreateGeometryException;

    /**

     * <p>

     * It creates a null geometry with a concrete subtype.

     * <p>

     *

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return

     *         A NullGeometry

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create

     *             the geometry.

     * @deprecated use null instead. This method can be removed in next revisions

     */

    public NullGeometry createNullGeometry(int subType)

        throws CreateGeometryException;

    /**

     * <p>

     * Create a new point with a concrete type and sets the value for the X and

     * the Y.

     * </p>

     *

     * @param x

     *            The X coordinate

     * @param y

     *            The y coordinate

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create

     *             the geometry.

     * @return

     *         The Point

     */

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

        throws CreateGeometryException;

    /**

     * Create a new line with a concrete type. Use later addVertex to add

     * vertex to te line.

     *

     * @param subType SubType of geometry. Must be a value defined in {@link Geometry.SUBTYPES}

     * @return a line

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create

     *             the geometry.

     */

    public Line createLine(int subType) throws CreateGeometryException;

    /**

     * @deprecated use createLine

     */

    public Curve createCurve(int subType) throws CreateGeometryException;

    /**

     * Create a new polygon with a concrete type.

     * Use later addVertex to add vertex to te polygon.

     *

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return

     *         A polygon

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create

     *             the geometry.

     */

    public Polygon createPolygon(int subType)

        throws CreateGeometryException;

    /**

     * @deprecated use createPolygon

     */

    public Surface createSurface(int subType)

        throws CreateGeometryException;

    /**

     * Create a new multipoint with a concrete subtype.

     * Use addPrimitive to populate the multipoint.

     *

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return A multipoint

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create the

     *             geometry.

     */

    public MultiPoint createMultiPoint(int subType)

        throws CreateGeometryException;

    /**

     * Create a new multicurve with a concrete subtype.

     * Use addPrimitive to populate the multicurve.

     *

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return A multicurve

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create the

     *             geometry.

     */

    public MultiCurve createMultiCurve(int subType) throws CreateGeometryException;

    public MultiLine createMultiLine(int subType) throws CreateGeometryException;

    /**

     * Create a new multisurface with a concrete subtype.

     * Use later addPrimitive to populate.

     *

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return A multisurface

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create the

     *             geometry.

     */

    public MultiSurface createMultiSurface(int subType) throws CreateGeometryException;

    public MultiPolygon createMultiPolygon(int subType) throws CreateGeometryException;

    /**

     * <p>

     * Returns an operation given the Geometry type, the Geometry subtype and

     * and the operation code. If opCode corresponds to a common operation (a

     * common operation is an operation registered for all geometries), then

     * this method returns the common operation.

     * </p>

     * <p>

     * For better performance, if you need to call an operation multiple times,

     * use this method only once and keep the returned object in a local

     * variable over which you can iterate. For instance:

     *

     * <pre>

     * // Get the operation you need

     * GeometryManager gm = GeometryLocator.getGeometryManager()

     * GeometryOperation geomOp = null;

     * try {

     *    geomOp = gm.getGeometryOperation(Draw2D.CODE, Geometry.TYPES.POINT,

     *    Geometry.SUBTYPES.GEOM2D);

     * } catch (GeometryTypeNotSupportedException gtnse) {

     *    // treat exception

     * } catch (GeometryOperationNotSupportedException gonse) {

     *    // treat exception

     * }

     *

     *  // Fill the operation context with required params

     * GeometryOperationContext ctx = new GeometryOperationContext();

     *

     *  // Here is the main loop where you call the operation

     * for (int i=0; i<myGeometries.length; i++) {

     *    Object result = geomOp.invoke(myGeometries[i], ctx);

     * }

     * </pre>

     *

     * </p>

     *

     * @param opCode

     *            The operation code

     * @param type

     *            Type of geometry. Must be a value defined in

     *            {@link Geometry.TYPES}

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return Geometry operation

     * @throws GeometryTypeNotSupportedException

     *             Returns this exception if there is not a registered geometry

     *             with

     *             these type and subtype

     * @throws GeometryTypeNotValidException

     *             Returns this exception if the type and subtype are not valid

     * @throws GeometryOperationNotSupportedException

     *             Returns this exception if there is not a registered operation

     *             with

     *             this operation code

     */

    public GeometryOperation getGeometryOperation(int opCode, int type,

        int subType) throws GeometryTypeNotSupportedException,

        GeometryOperationNotSupportedException, GeometryTypeNotValidException;

    /**

     * <p>

     * Returns an common operation with given operation code. A common operation

     * is an operation registered for all geometries.

     * </p>

     * <p>

     * For better performance, if you need to call an operation multiple times,

     * use this method only once and keep the returned object in a local

     * variable over which you can iterate. For instance:

     *

     * <pre>

     * // Get the operation you need

     * GeometryManager gm = GeometryLocator.getGeometryManager()

     * GeometryOperation geomOp = null;

     * try {

     *    geomOp = gm.getGeometryOperation(FromWKB.CODE);

     * } catch (GeometryOperationNotSupportedException gonse) {

     *    // treat exception

     * }

     *

     *  // Fill the operation context with required params

     * FromWKBGeometryOperationContext ctx = new FromWKBGeometryOperationContext();

     *

     *  // Here is the main loop where you call the operation

     * for (int i=0; i<myGeometriesWKB.length; i++) {

     *    ctx.setData(myGeometriesWKB[i]);

     *    Object result = geomOp.invoke(null, ctx);

     * }

     * </pre>

     *

     * </p>

     *

     * @param opCode

     *            The operation code

     * @return Geometry operation

     * @throws GeometryOperationNotSupportedException

     *             Returns this exception if there is not a registered operation

     *             with

     *             this operation code

     */

    public GeometryOperation getGeometryOperation(int opCode)

        throws GeometryOperationNotSupportedException;

    /**

     * <p>

     * Invokes an operation given its code, the geometry and the operation

     * context holding the parameters required for the operation.

     * </p>

     *

     * @param opCode

     *            Operation code.

     * @param geom

     *            Geometry to which apply the operation

     * @param ctx

     *            Context holding the operation parameters

     * @return

     *         The object returned by an operation, depends on each operation.

     */

    public Object invokeOperation(int opCode, Geometry geom,

        GeometryOperationContext ctx)

        throws GeometryOperationNotSupportedException,

        GeometryOperationException;

    /**

     * <p>

     * Invokes an operation given its code, the geometry and the operation

     * context holding the parameters required for the operation.

     * </p>

     *

     * @param geomOpName

     *            Operation name.

     * @param geom

     *            Geometry to which apply the operation

     * @param ctx

     *            Context holding the operation parameters

     * @return

     *         The object returned by an operation, depends on each operation.

     */

    public Object invokeOperation(String geomOpName, Geometry geom,

        GeometryOperationContext ctx)

        throws GeometryOperationNotSupportedException,

        GeometryOperationException;

    /**

     * <p>

     * Invokes an operation given its code, and the operation context holding

     * the parameters required for the operation.

     * </p>

     *

     * @param geomOpName

     *            Operation name.

     * @param ctx

     *            Context holding the operation parameters

     * @return

     *         The object returned by an operation, depends on each operation.

     */

    public Object invokeOperation(String geomOpName,

        GeometryOperationContext ctx)

        throws GeometryOperationNotSupportedException,

        GeometryOperationException;

    /**

     * <p>

     * Registers the unique name of one operation. If it already exists then

     * this method does nothing but returning the name's corresponding index.

     * </p>

     * <p>

     * By convention this method is used to set the value of the final and

     * static variable that is located in the classes that implements the

     * operation:<BR>

     *

     * <pre>

     *

     * public class MyOperation extends GeometryOperation {

     *

     *     public static final int CODE = GeometryLocator.getGeometryManager()

     *         .getGeometryOperationCode("MyOperation");

     * }

     * </pre>

     *

     * </p>

     *

     * @param geomOpName

     *            Name used to register the geometry operation

     * @return

     *         Index assigned to the operation name passed as parameter

     */

    public int getGeometryOperationCode(String geomOpName);

    /**

     * Returns a list with the name of the operations that have been

     * registered.

     *

     * @return

     *         A list of the registered operations.

     */

    public List getGeometryOperationNames();

    /**

     * Returns the flatness used to convert a curve is a set

     * of points.

     *

     * @return

     *         The flatness.

     */

    public double getFlatness();

    /**

     * Sets the application flatness.

     *

     * @param flatness

     *            The flatness to set

     */

    public void setFlatness(double flatness);

    /**

     * Create a memory spatial index with the default implementation.

     *

     * @return a new SpatialIndex

     */

    public SpatialIndex createDefaultMemorySpatialIndex() throws ServiceException;

    /**

     * Create a spatial index with the implementation specified as name.

     * If the creation of index don't requery parameters can be passed a null.

     *

     * @param name of the type of spatial index to create

     * @param parameters used to create the index or null.

     * @return the new SpatialIndex or null if not exists the type of index.

     * @throws GeometryException

     */

    public SpatialIndex createSpatialIndex(String name, DynObject parameters) throws ServiceException;

    /**

     * Return the name of the factory of the spatial index required.

     *

     * @param name of the spatial index factory

     * @return the SpatialIndexFactory required or null if not exists

     */

    public SpatialIndexFactory getSpatialIndexFactory(String name);

    /**

     * Create a GeneralPathX to populate a geometry.

     * This method is deprecated, instead use OrientablePrimitive#addVertex(Point) to add vertex to

     * primitive geometries or {@link MultiPrimitive#addPrimitive(org.gvsig.fmap.geom.primitive.Primitive)} to add geometries to an aggregate.

     *

     * @param rule

     * @param pathIterator , can be null

     * @return a GeneralPathX

     * @deprecated use method of Geometry to handle this

     * @see OrientablePrimitive#addVertex(Point) or {@link MultiPrimitive#addPrimitive(org.gvsig.fmap.geom.primitive.Primitive)}

     *

     */

    public IGeneralPathX createGeneralPath(int rule, PathIterator pathIterator);

        /**

         * <p>

         * Create a new curve with a concrete type and sets the value for the

         * coordinates using a GeneralPathX.

         * </p>

         *

         * @param generalPathX

         *            It is used to set the values for the X and Y coordinates.

         * @param subType

         *            SubType of geometry. Must be a value defined in

         *            {@link Geometry.SUBTYPES}

         * @return

         *         A curve

         * @throws CreateGeometryException

         *             This exception is thrown when the manager can not create

         *             the geometry.

         * @deprecated use {@link #createCurve(int)} and OrientablePrimitive#addVertex(Point)

         */

        public Curve createCurve(GeneralPathX generalPathX, int subType)

            throws CreateGeometryException;

         /**

     * <p>

     * Create a new multipoint with a concrete type and sets the value for the

     * coordinates using a GeneralPathX.

     * </p>

     *

     * @param generalPathX

     *            It is used to set the values for the X and Y coordinates.

     * @param subType

     *            SubType of geometry. Must be a value defined in

     *            {@link Geometry.SUBTYPES}

     * @return A multipoint

     * @throws CreateGeometryException

     *             This exception is thrown when the manager can not create the

     *             geometry.

     * @deprecated use {@link #createMultiCurve(int)} and {@link MultiPrimitive#addPrimitive(org.gvsig.fmap.geom.primitive.Primitive)}

     */

    public MultiPoint createMultiPoint(GeneralPathX generalPathX, int subType)

            throws CreateGeometryException;

        /**

         * <p>

         * Create a new multicurve with a concrete type and sets the value for the

         * coordinates using a GeneralPathX.

         * </p>

         *

         * @param generalPathX

         *            It is used to set the values for the X and Y coordinates.

         * @param subType