Application: gvSIG desktop » gvSIG projections

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2012 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.proj;

import java.text.ParseException;

import org.gvsig.proj.catalog.CRSCatalogManager;

import org.gvsig.proj.catalog.CRSDefinition;

import org.gvsig.proj.catalog.TextSerialization;

import org.gvsig.proj.catalog.TransformationDefinition;

import org.gvsig.proj.catalog.exception.UnsupportedTransformationException;

import org.gvsig.proj.catalog.exception.UnsupportedCoordinateReferenceSystemException;

import org.gvsig.proj.catalog.exception.UnsupportedFormatException;

/**

 * This class is responsible of the management of the CoordinateReferenceSystem

 * library's business logic.

 * It is the library's main entry point, and provides all the services to manage

 * {@link CoordinateReferenceSystem}s.

 * 

 * @author gvSIG team

 * @version $Id$

 */

public interface CoordinateReferenceSystemManager {

        /**

         * Parses the provided CRS definition to create a {@link CoordinateReferenceSystem} object

         *  

         * @param def A string containing the definition to parse (e.g. a WKT

         * CRS definition, a GML CRS definition, etc)

         * @return A {@link CoordinateReferenceSystem} object

         * @throws CoordinateReferenceSystemException if the reference system is not supported by

         * this implementation

         * @throws ParseException if the provided definition can't be parsed (for instance because it is not

         * a valid document in any of the supported formats)

         */

        CoordinateReferenceSystem parseCoordinateReferenceSystem(String def)

                        throws UnsupportedCoordinateReferenceSystemException, ParseException;

        /**

         * Parses the provided CRS definition to create a {@link CoordinateReferenceSystem} object

         * 

         * @param def A string containing the definition to parse (e.g. a WKT

         * definition, a GML definition, etc)

         * @param format The format of the definition to parse

         * @return A {@link CoordinateReferenceSystem} object

         * @throws UnsupportedCoordinateReferenceSystemException if the reference system is not supported by

         * this implementation

         * @throws ParseException if the provided string can't be parsed, for instance if the format is

         * not supported or if the string is not valid

         */

        CoordinateReferenceSystem parseCoordinateReferenceSystem(String def, TextSerialization.Format format)

                        throws UnsupportedCoordinateReferenceSystemException, ParseException, UnsupportedFormatException;

        /**

         * Returns a Coordinate Reference System.

         * 

         * @param definition

         * @throws ParseException 

         * @throws UnsupportedOperationException 

         * @throws CoordinateReferenceSystemException 

         */

        CoordinateReferenceSystem getCoordinateReferenceSystem(

                CRSDefinition definition)

                        throws UnsupportedCoordinateReferenceSystemException, ParseException;

        /**

         * Parses the provided transformation definition to create a {@link CoordinateTransformation} object

         *  

         * @param def A string containing the definition to parse (e.g. a WKT

         * definition, a GML definition, etc)

         * @return A {@link CoordinateTransformation} object

         * @throws UnsupportedTransformationException if the transformation is not supported by

         * this implementation

         * @throws ParseException if the provided string can't be parsed (for instance because it is not

         * a valid document in any of the supported formats)

         */

        CoordinateTransformation parseCoordinateTransformation(String def)

                        throws UnsupportedTransformationException, ParseException;

        /**

         * Parses the provided CRS definition to create a {@link TransformationDefinition} object

         * 

         * @param def A string containing the definition to parse (e.g. a WKT

         * definition, a GML definition, etc)

         * @param format The format of the definition to parse

         * @return A {@link TransformationDefinition} object

         * @throws UnsupportedTransformationException if the transformation is not supported by

         * this implementation

         * @throws ParseException if the provided string can't be parsed, for instance if the format is

         * not supported or if the string is not valid

         * @throws UnsupportedFormatException if the format is not supported

         */

        CoordinateTransformation parseCoordinateTransformation(String def, TextSerialization.Format format)

                        throws UnsupportedTransformationException, ParseException, UnsupportedFormatException;

        /**

         * Returns a Coordinate Transformation

         * 

         * @param definition

         * @throws ParseException 

         * @throws CoordinateReferenceSystemException 

         */

        CoordinateTransformation getCoordinateTransformation(

                        TransformationDefinition definition)

                                        throws UnsupportedTransformationException, ParseException;

    /**

     * Sets the catalog instance to use for retrieving definitions

     * 

     * @return

     */

    void setCatalogManager(CRSCatalogManager manager);

}