Application: gvSIG desktop » gvSIG projections

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2018 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.catalog;

import java.util.List;

import java.util.Set;

import javax.measure.Unit;

import javax.measure.quantity.Length;

import org.gvsig.proj.catalog.datum.Datum;

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

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

import org.gvsig.proj.catalog.extent.Extent;

/**

 * Definition of a Coordinate Reference System (CRS).

 * 

 * A CRS defines how a set of coordinates relate to real positions (on earth, on other

 * planet or in the space). A CRS defines the number of coordinate axis, its name, order and

 * direction, its units, the mathematical model used to define the geometric figure (ellipsoid)

 * to approximate the shape of the earth, the relationship of this mathematical model with the

 * earth (datum), among other concepts and parameters. Some CRSs include a projection, which

 * defines a mathematical model to approximate the surface of an area of the earth using a

 * planar surface.

 * 

 * Note that a set of coordinates is meaningless if their CRS is not defined, as these

 * values can refer to different locations on the Earth depending on the CRS being used.

 * 

 * @author  gvSIG Team

 * @author  Cesar Martinez Izquierdo

 */

public interface CRSDefinition {

    /**

     * A common name for this coordinate reference system

     * 

     * @return The human-readable name of the CRS. This method should never return null

     */

        String getName();

    /**

     * Gets a code that references an unambiguous definition of the coordinate reference

     * system for some authority. Examples: "EPSG:4326", "EPSG:25830".

     * 

     * Note that identifiers in the "USER:" namespace are an special case, as their

     * definition will be different for each user, so they don't reference an

     * unambiguous definition.

     * 

     * @return the identifier which was used to instantiate the object, or the

     * identifier that more closely matches the information used to instantiate

     * the object (e.g. if derived from an WKT definition), or <code>null</code> if an identifier is

     * not available

     */

    String getIdentifier();

    /**

     * Gets the list of identifiers which describe this coordinate reference system

     * definition.

     *

     * @return the list of object identifiers, or an empty collection if there is none.

     */

    Set<String> getIdentifiers();

    /**

     * Gets the authority which defines this coordinate references system

     * (e.g. "EPSG", "ESRI", "USER"...).

     * 

     * If the CRS is defined by several

     * authorities, it returns the authority which was used to instantiate

     * the object, or the authority that more closely matches the information

     * used to instantiate the object (e.g. if derived from an WKT definition)

     * 

     * @return The authority name, or {@code null} if not available.

     */

    String getAuthorityName();

    /**

     * FIXME: GeoAPI

     * Area or region or timeframe in which this (coordinate) reference system is valid.

     *

     * @return the reference system valid domain, or {@code null} if not available.

     * @since 2.1

     */

        Extent getDomainOfValidity();

    /**

     * Textual description of the coordinate reference system, including remarks

     * and its scope. 

     *

     * @return the description, or {@code null} if none.

     */

    String getDescription();

    /**

     * Gets the type of coordinate reference system

     * 

     * @return

     */

    CRSType getType();

    /**

     * Returns a <cite>Well-Known Text</cite> (WKT) definition for this object.

     * Note that there are different versions of the WKT specification

     * (the older WKT defined by OGC 01-009 and the newer one, defined by OGC 12-063r5

     * and ISO 19162). Also note that ESRI uses different names to refer to CRSs, datums,

     * ellipsoids, etc. compared to OGC, so OGC and ESRI WKTs can be considered as different

     * dialects. Use 

     * {@link #toString(org.gvsig.proj.catalog.TextSerialization.WKTConvention, int)}

     * if a particular format and/or convention is required.

     * 

     * Whenever possible, this method will return a WKT following the same specification and

     * dialect that the one used to instantiate this CRSDefinition. If the original

     * specification or dialect are unknown, implementations are encouraged to format according

     * to the most recent standard and following OGC dialect.

     *

     * @return the Well-Known Text (WKT) definition for this object.

     * @throws UnsupportedOperationException if this object can not be formatted as WKT.

     * @see #toString(org.gvsig.proj.catalog.TextSerialization.WKTConvention, int)

     */

        String toWKT() throws UnsupportedOperationException;

    /**

     * Returns a text serialization of this definition (such as a WKT string), using the

     * specified {@link TextSerialization.Format} and trying to convert names to the

     * specified {@link TextSerialization.WKTConvention}.

     * {@link TextSerialization.Format#WKT1} format MUST be supported by any implementation

     * of this API. This method must throw an UnsupportedOperationException if the requested format is not

     * supported by a particular implementation

     *

     * @param format The {@link TextSerialization.Format} used to serialize this definition.

     * 

     * @return A serialized version of this definition.

     * @throws UnsupportedOperationException if the requested format is not supported

     * or if this is object can not be formatted using that format.

     * @see #toString(org.gvsig.proj.catalog.TextSerialization.WKTConvention, int)

     */

        String toString(TextSerialization.Format format) throws UnsupportedOperationException;

    /**

     * Returns a text serialization of this definition (such as a WKT string), using the

     * specified {@link TextSerialization.Format} and trying to convert names to the

     * specified {@link TextSerialization.WKTConvention}.

     * {@link TextSerialization.Format#WKT1} format MUST be supported by any implementation

     * of this API. This method must throw an UnsupportedOperationException if the requested format is not

     * supported by a particular implementation

     *

     * @param format The {@link TextSerialization.Format} used to serialize this definition.

     * @param convention The preferred {@link TextSerialization.WKTConvention} used to

     * encode projection names, datum names, units, etc. This is only a hint, 

     * implementations can ignore this hint if they are not able to convert this object

     * to the requested convention.

     * @param indentation  The amount of spaces to use in indentation. Use 0 to produce

     * a single line serialization.

     * 

     * @return A serialized version of this definition.

     * @throws UnsupportedOperationException if the requested format is not supported

     * or if this is object can not be formatted using that format.

     * @see #toString(org.gvsig.proj.catalog.TextSerialization.WKTConvention)

     */

        String toString(TextSerialization.Format format, TextSerialization.WKTConvention convention, int indentation) throws UnsupportedOperationException;

        /**

         * If the CRS type is {@link CRSType#CompoundCRSType}, this method returns the ordered

         * list of coordinate reference systems which are its components.

         *

         * @return the ordered list of coordinate reference systems, or <code>null if the CRS

         * is not compound

         * @throws UnsupportedCoordinateReferenceSystemException 

         * @see #getType()

         * @see CRSType#CompoundCRSType

         */

        List<CRSDefinition> getComponents() throws UnsupportedCoordinateReferenceSystemException;

        /**

         * Gets the number of axis of the associated CoordinateSystem

         * 

         * @return

         */

        int getAxisCount();

        /**

         * Returns the axis for the associated coordinate system at the specified dimension,

         * as officially defined by the authority. 

         * 

         * @param dimension

         * @return

         * @throws IndexOutOfBoundsException

         */

        CoordinateSystemAxis getAxis(int dimension) throws IndexOutOfBoundsException;

        /**

         * Returns the axis for the associated coordinate system at the specified

         * dimension as internally used by gvSIG, which will sometimes differ from

         * the order officially defined by the authority.

         * 

         * The internal order is used for convenience and performance. gvSIG geometries

         * and gvSIG coordinate transformations always expect coordinates to be provided

         * using the internal order (xy axis order). However, some

         * protocols or formats require the coordinates to be encoded using the

         * official order. 

         * 

         * @param dimension

         * @return

         * @throws IndexOutOfBoundsException

         */

        CoordinateSystemAxis getAxisInternal(int dimension) throws IndexOutOfBoundsException;

    /**

     * Returns the datum associated directly or indirectly to this CRS.

     * In the case of a derived CRS, this method returns the

     * datum of the {@linkplain #getBaseCRS() base CRS}. In the case of

     * a compound CRS, it returns the datum associated to the horizontal component.

     *

     * @return the datum

     */

    Datum getDatum();

    /**

     * Indicates whether some other CRSDefinition is "equal to" this one.

     * 

     * Definitions are considered equal if they represent the same CRS (same type,

     * same datum, same ellipsoid parameters, etc), despite some differences in

     * naming (CRS name, datum aliases, missing/different authority code...).

     * 

     * @param ignoreAxis Ignores the names and order of the axis in the comparison

     * @param ignoreMetadata Ignores metadata (including unit names) in the comparison

     * 

     * @return

     */

    boolean equals(CRSDefinition definition, boolean ignoreAxis, boolean ignoreMetadata);

    /**

     * For derived CRSs (such as projected CRSs), it returns the base coordinate

     * reference system.

     *

     * @return the base coordinate reference system or null if the CRS is not

     * derived

     * @throws UnsupportedCoordinateReferenceSystemException 

     * @see CRSType#isDerived()

     * @see CRSType#ProjectedCRSType

     * @see CRSType#OtherDerivedCRSType

     */

        CRSDefinition getBaseCRS() throws UnsupportedCoordinateReferenceSystemException;

    /**

     * For derived CRSs (such as projected CRSs), it returns the conversion from the

     * {@linkplain #getBaseCRS() base CRS} to this CRS.

     *

     * @return the conversion from the base CRS or null if the CRS is not derived

     * @throws CoordinateReferenceSystemException 

     *

     * @see CRSType#isDerived()

     * @see CRSType#ProjectedCRSType

     * @see CRSType#OtherDerivedCRSType

     */

        TransformationDefinition getConversionFromBase() throws CoordinateReferenceSystemException;

}