org.opengis.referencing.datum.DatumFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation
Standard interfaces implemented throughout the library.
The newest version!
/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2003-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.referencing.datum;

import static org.opengis.annotation.Specification.*;

import java.util.Date;
import java.util.Map;
import javax.measure.Unit;
import javax.measure.quantity.Angle;
import javax.measure.quantity.Length;
import org.opengis.annotation.UML;
import org.opengis.referencing.FactoryException;
import org.opengis.referencing.ObjectFactory;

/**
 * Builds up complex {@linkplain Datum datums} from simpler objects or values. {@code DatumFactory}
 * allows applications to make {@linkplain Datum datums} that cannot be created by a {@link
 * DatumAuthorityFactory}. This factory is very flexible, whereas the authority factory is easier to
 * use. So {@link DatumAuthorityFactory} can be used to make "standard" datums, and {@code
 * DatumFactory} can be used to make "special" datums.
 *
 * @version Implementation specification 1.0
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 1.0
 * @see org.opengis.referencing.cs.CSFactory
 * @see org.opengis.referencing.crs.CRSFactory
 */
@UML(identifier = "CS_CoordinateSystemFactory", specification = OGC_01009)
public interface DatumFactory extends ObjectFactory {
    /**
     * Creates an engineering datum.
     *
     * @param properties Name and other properties to give to the new object. Available properties
     *     are {@linkplain ObjectFactory listed there}.
     * @return The datum for the given properties.
     * @throws FactoryException if the object creation failed.
     */
    @UML(identifier = "createLocalDatum", specification = OGC_01009)
    EngineeringDatum createEngineeringDatum(Map properties) throws FactoryException;

    /**
     * Creates geodetic datum from ellipsoid and (optionaly) Bursa-Wolf parameters.
     *
     * @param properties Name and other properties to give to the new object. Available properties
     *     are {@linkplain ObjectFactory listed there}.
     * @param ellipsoid Ellipsoid to use in new geodetic datum.
     * @param primeMeridian Prime meridian to use in new geodetic datum.
     * @return The datum for the given properties.
     * @throws FactoryException if the object creation failed.
     */
    @UML(identifier = "createHorizontalDatum", specification = OGC_01009)
    GeodeticDatum createGeodeticDatum(
            Map properties, Ellipsoid ellipsoid, PrimeMeridian primeMeridian)
            throws FactoryException;

    /**
     * Creates an image datum.
     *
     * @param properties Name and other properties to give to the new object. Available properties
     *     are {@linkplain ObjectFactory listed there}.
     * @param pixelInCell Specification of the way the image grid is associated with the image data
     *     attributes.
     * @return The datum for the given properties.
     * @throws FactoryException if the object creation failed.
     */
    ImageDatum createImageDatum(Map properties, PixelInCell pixelInCell)
            throws FactoryException;

    /**
     * Creates a temporal datum from an enumerated type value.
     *
     * @param properties Name and other properties to give to the new object. Available properties
     *     are {@linkplain ObjectFactory listed there}.
     * @param origin The date and time origin of this temporal datum.
     * @return The datum for the given properties.
     * @throws FactoryException if the object creation failed.
     */
    TemporalDatum createTemporalDatum(Map properties, Date origin)
            throws FactoryException;

    /**
     * Creates a vertical datum from an enumerated type value.
     *
     * @param properties Name and other properties to give to the new object. Available properties
     *     are {@linkplain ObjectFactory listed there}.
     * @param type The type of this vertical datum (often "geoidal").
     * @return The datum for the given properties.
     * @throws FactoryException if the object creation failed.
     */
    @UML(identifier = "createVerticalDatum", specification = OGC_01009)
    VerticalDatum createVerticalDatum(Map properties, VerticalDatumType type)
            throws FactoryException;

    /**
     * Creates an ellipsoid from radius values.
     *
     * @param properties Name and other properties to give to the new object. Available properties
     *     are {@linkplain ObjectFactory listed there}.
     * @param semiMajorAxis Equatorial radius in supplied linear units.
     * @param semiMinorAxis Polar radius in supplied linear units.
     * @param unit Linear units of ellipsoid axes.
     * @return The ellipsoid for the given properties.
     * @throws FactoryException if the object creation failed.
     */
    @UML(identifier = "createEllipsoid", specification = OGC_01009)
    Ellipsoid createEllipsoid(
            Map properties,
            double semiMajorAxis,
            double semiMinorAxis,
            Unit unit)
            throws FactoryException;

    /**
     * Creates an ellipsoid from an major radius, and inverse flattening.
     *
     * @param properties Name and other properties to give to the new object. Available properties
     *     are {@linkplain ObjectFactory listed there}.
     * @param semiMajorAxis Equatorial radius in supplied linear units.
     * @param inverseFlattening Eccentricity of ellipsoid.
     * @param unit Linear units of major axis.
     * @return The ellipsoid for the given properties.
     * @throws FactoryException if the object creation failed.
     */
    @UML(identifier = "createFlattenedSphere", specification = OGC_01009)
    Ellipsoid createFlattenedSphere(
            Map properties,
            double semiMajorAxis,
            double inverseFlattening,
            Unit unit)
            throws FactoryException;

    /**
     * Creates a prime meridian, relative to Greenwich.
     *
     * @param properties Name and other properties to give to the new object. Available properties
     *     are {@linkplain ObjectFactory listed there}.
     * @param longitude Longitude of prime meridian in supplied angular units East of Greenwich.
     * @param unit Angular units of longitude.
     * @return The prime meridian for the given properties.
     * @throws FactoryException if the object creation failed.
     */
    @UML(identifier = "createPrimeMeridian", specification = OGC_01009)
    PrimeMeridian createPrimeMeridian(Map properties, double longitude, Unit unit)
            throws FactoryException;
}