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.spatial;
019
020import java.util.Collection;
021
022import org.opengis.annotation.UML;
023import org.opengis.referencing.ReferenceSystem;
024import org.opengis.util.InternationalString;
025
026import static org.opengis.annotation.Obligation.*;
027import static org.opengis.annotation.Specification.*;
028
029
030/**
031 * Information about a control point collection.
032 *
033 * @author  Cédric Briançon (Geomatys)
034 * @version 3.0
035 * @since   2.3
036 */
037@UML(identifier="MI_GCPCollection", specification=ISO_19115_2)
038public interface GCPCollection extends GeolocationInformation {
039    /**
040     * Identifier of the GCP collection.
041     *
042     * @return the identifier.
043     */
044    @UML(identifier="collectionIdentification", obligation=MANDATORY, specification=ISO_19115_2)
045    Integer getCollectionIdentification();
046
047    /**
048     * Name of the GCP collection.
049     *
050     * @return name of the GCP collection.
051     */
052    @UML(identifier="collectionName", obligation=MANDATORY, specification=ISO_19115_2)
053    InternationalString getCollectionName();
054
055    /**
056     * Coordinate system in which the ground control points are defined.
057     *
058     * @return coordinate system in which the ground control points are defined.
059     */
060    @UML(identifier="coordinateReferenceSystem", obligation=MANDATORY, specification=ISO_19115_2)
061    ReferenceSystem getCoordinateReferenceSystem();
062
063    /**
064     * Ground control point(s) used in the collection.
065     *
066     * @return ground control point(s).
067     */
068    @UML(identifier="gcp", obligation=MANDATORY, specification=ISO_19115_2)
069    Collection<? extends GCP> getGCPs();
070}