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

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

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

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

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

/**

 * Definition of a coordinate operation, a mathematical operation on coordinates that

 * calculates the equivalent coordinates on a different coordinate reference system.

 * 

 * Despite its name, this interface describes transformations (a particular kind of

 * operation which requires empirically derived parameters, for instance a datum

 * change) and also other kinds of operations: concatenated operations, projection

 * operations, etc.

 * 

 * @author  Cesar Martinez Izquierdo

 * @author  gvSIG Team

 */

public interface TransformationDefinition {

    /**

     * Returns the definition of the source CRS

     *

     * @return the definition of the source CRS, or {@code null} if not available.

     */

    CRSDefinition getSourceDefinition();

    /**

     * Returns the definition of the target CRS

     *

     * @return the definition of the target CRS, or {@code null} if not available.

     */

    CRSDefinition getTargetDefinition();

    /**

     * A common name for this coordinate operation

     * 

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

     */

        String getName();

    /**

     * Gets a code that references an unambiguous definition of this coordinate operation

     * for some authority. Examples: "EPSG:1633", "EPSG:1632".

     * 

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

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

     * 

     * If this transformation 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();

    /**

     * Version of the coordinate transformation (i.e., instantiation due to the stochastic

     * nature of the parameters). Mandatory when describing a transformation, and should not

     * be supplied for a conversion.

     *

     * @return the coordinate operation version, or {@code null} if none.

     */

    String getOperationVersion();

    /**

     * Area or region or timeframe in which this coordinate operation is valid.

     *

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

     */

    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 definition of the inverse of this coordinate operation.

     * 

     * @throws NoninvertibleTransformException if the inverse of this operation

     * is not defined

     * @throws UnsupportedTransformationException 

     */

    TransformationDefinition getInverseDefinition() throws NoninvertibleTransformException, UnsupportedTransformationException;

    /**

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

     *

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

     * This method must fail if the requested format is not supported by a particular

     * implementation

     * 

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

     * @throws UnsupportedFormatException 

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

     */

        String toString(TextSerialization.Format format) throws UnsupportedOperationException, UnsupportedFormatException;

    /**

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

     *

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

     * This method must fail if the requested format is not supported by a particular

     * implementation

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

     * @throws UnsupportedFormatException 

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

     */

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

}