| gvSIG desktop 1

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

 * <ul>

 *

 * @author jiyarza

 */

public interface GeometryManager {

	 * Registers a GeometryOperation associated to a GeometryType.

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

	 * By convention, the return value should be stored in a public constant within the class implementing

	 * the operation:<BR>

	 * <pre>

	 *        .registerGeometryOperation("MyOperation", new MyOperation(), geomType);

	 * }

	 * </pre>

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

	 */

	public int registerGeometryOperation(String geomOpName,

			GeometryOperation geomOp, GeometryType geomType);

	/**

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

	 * By convention, the return value should be stored in a public constant within the class implementing

	 * the operation:<BR>

	 * <pre>

	 *        .registerGeometryOperation("MyOperation", new MyOperation());

	 * }

	 * </pre>

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

	/**

	 * By convention, the return value should be stored in a public constant within the class implementing

	 * the operation:<BR>

	 * <pre>

	 *        .registerGeometryOperation("MyOperation", new MyOperation(), TYPES.POINT, SUBTYPES.GEOM2D);

	 * }

	 * </pre>

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

	 * @param geomOpName Operation's unique name

	 * @param geomOp Specific GeometryOperation's instance implementing this operation

	 * @param type

	 */

	public int registerGeometryOperation(String geomOpName,

			GeometryOperation geomOp, int type, int subType) throws GeometryTypeNotSupportedException, GeometryTypeNotValidException;

	/**

	 * Returns an unique index that is used later to identify and invoke the operation.<br>

	 * By convention, the return value should be stored in a public constant within the class implementing

	 * the operation:<BR>

	 * <pre>

	 * public class MyOperation extends GeometryOperation {

	 *   public static final int CODE =

	 *     GeometryManager.getInstance()

	 * }

	 * </pre>

	 * @param geomOpName Operation's unique name

	 * @param geomOp Specific GeometryOperation's instance implementing this operation

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

	/**

	 * Returns an unique index that is used later to identify and invoke the operation.<br>

	 * By convention, the return value should be stored in a public constant within the class implementing

	 * the operation:<BR>

	 * <pre>

	 * public class MyOperation extends GeometryOperation {

	 *   public static final int CODE =

	 *     GeometryManager.getInstance()

	 * }

	 * </pre>

	 * @param geomOpName Operation's unique name

	 * @param geomOp Specific GeometryOperation's instance implementing this operation

	 * @param subType

	 */

	public int registerGeometryOperationBySubtype(String geomOpName,

			GeometryOperation geomOp, int subType);

	/**

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

	 * If the class is already registered then this method throws an IllegalArgumentException.<br>

	 *             If geomClass is null or does not implement Geometry

	 */

	public GeometryType registerGeometryType(Class geomClass, String name, int type, int subType);

	/**

	 * Registers a Geometry implementation as a new geometry type and returns the

	 * associated GeometryType instance. If the class is already registered

	 *             If geomClass is null or does not implement Geometry

	 */

	public GeometryType registerGeometryType(Class geomClass, int type, int subType);

	/**

	 * Returns an instance of GeometryType given the associated Geometry implementation

	 * class.

	 * @throws GeometryTypeNotValidException 

	 */

	public GeometryType getGeometryType(int type, int subType) throws GeometryTypeNotSupportedException, GeometryTypeNotValidException;

	/**

	 * Returns the associated GeometryType given the fully qualified name of

	 * the Geometry implementation class.

	 * @return GeometryType associated to the class

	 */

	public GeometryType getGeometryType(String className) throws GeometryTypeNotSupportedException;

	/**

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

	 * by this GeometryType. The geometry is empty, and all the internal 

	public Geometry create(GeometryType geomType) throws CreateGeometryException;

	public Envelope createEnvelope(int subType) throws CreateEnvelopeException;

	public Envelope createEnvelope(double minX, double minY, double maxX, double maxY, int subType) throws CreateEnvelopeException;

	/**

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

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

	 * the geometry.

	 */

	public Geometry create(String name) throws CreateGeometryException;

	/**

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

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

	public Geometry create(int type, int subType) throws CreateGeometryException;

	public NullGeometry createNullGeometry(int subType) throws CreateGeometryException;

	 * Create point. If there is an

	 * error return <code>null</code> and add the error

	 * to the log

	 * The Point

	 */

	public Point createPoint(double x, double y, int subType) throws CreateGeometryException;

	public Curve createCurve(GeneralPathX generalPathX, int subType) throws CreateGeometryException;

	public Surface createSurface(GeneralPathX generalPathX, int subType) throws CreateGeometryException; 

	/**

	 * 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

	 * @throws GeometryTypeNotValidException 

	 */

	public GeometryOperation getGeometryOperation(int opCode, int type, int subType) throws GeometryTypeNotSupportedException, GeometryOperationNotSupportedException, GeometryTypeNotValidException;

	/**

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

	 * parameters required for the operation.

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

	 */

	public Object invokeOperation(int opCode, Geometry geom, GeometryOperationContext ctx) throws GeometryOperationNotSupportedException, GeometryOperationException;

	/**

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

	 * parameters required for the operation.

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

	 */

	public Object invokeOperation(String geomOpName, Geometry geom, GeometryOperationContext ctx) throws GeometryOperationNotSupportedException, GeometryOperationException;

	/**

	 * Unregisters a geometry class.

	 * @param geomTypeName

	 * @return

	 */

	public GeometryType unregisterGeometryType(Class geomClass);

}