001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2016-2023 Open Geospatial Consortium, Inc.
004 *    http://www.geoapi.org
005 *
006 *    Licensed under the Apache License, Version 2.0 (the "License");
007 *    you may not use this file except in compliance with the License.
008 *    You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *    Unless required by applicable law or agreed to in writing, software
013 *    distributed under the License is distributed on an "AS IS" BASIS,
014 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 *    See the License for the specific language governing permissions and
016 *    limitations under the License.
017 */
018package org.opengis.referencing.datum;
019
020import java.util.Map;
021import java.util.Optional;
022import org.opengis.parameter.ParameterValueGroup;
023import org.opengis.annotation.UML;
024
025import static org.opengis.annotation.Obligation.OPTIONAL;
026import static org.opengis.annotation.Specification.ISO_19111;
027
028
029/**
030 * Identification of a particular reference surface used as the origin of a parametric coordinate system.
031 * The identification includes the frame position with respect to the Earth or other planet.
032 * It may be a textual description and/or a set of parameters.
033 *
034 * @author  OGC Topic 2 (for abstract model and documentation)
035 * @author  Johann Sorel (Geomatys)
036 * @author  Martin Desruisseaux (Geomatys)
037 * @version 3.1
038 * @since   3.1
039 *
040 * @see DatumAuthorityFactory#createParametricDatum(String)
041 * @see DatumFactory#createParametricDatum(Map)
042 */
043@UML(identifier="ParametricDatum", specification=ISO_19111)
044public interface ParametricDatum extends Datum {
045    /**
046     * Parameters used to define the parametric datum.
047     * Each parameter can be a parameter value, an ordered sequence of values,
048     * or a reference to a file of parameter values that define a parametric datum.
049     *
050     * @return parameter used to define the parametric datum.
051     *
052     * @departure harmonization
053     *   ISO 19111 defines a {@code DefiningParameter} class.
054     *   GeoAPI retrofits in the {@link org.opengis.parameter} framework.
055     */
056    @UML(identifier="datumDefiningParameter", obligation=OPTIONAL, specification=ISO_19111)
057    default Optional<ParameterValueGroup> getDatumDefiningParameter() {
058        return Optional.empty();
059    }
060}