001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2009-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.metadata.lineage;
019
020import org.opengis.annotation.UML;
021import org.opengis.metadata.citation.Citation;
022import org.opengis.util.InternationalString;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Details of the methodology by which geographic information was derived from the instrument
030 * readings.
031 *
032 * @author  Cédric Briançon (Geomatys)
033 * @version 3.0
034 * @since   2.3
035 */
036@UML(identifier="LE_Algorithm", specification=ISO_19115_2)
037public interface Algorithm {
038    /**
039     * Information identifying the algorithm and version or date.
040     *
041     * @return algorithm and version or date.
042     */
043    @UML(identifier="citation", obligation=MANDATORY, specification=ISO_19115_2)
044    Citation getCitation();
045
046    /**
047     * Information describing the algorithm used to generate the data.
048     *
049     * @return algorithm used to generate the data.
050     */
051    @UML(identifier="description", obligation=MANDATORY, specification=ISO_19115_2)
052    InternationalString getDescription();
053}