001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-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;
021import java.util.Collections;
022import org.opengis.util.InternationalString;
023import org.opengis.util.Record;
024import org.opengis.metadata.citation.Citation;
025import org.opengis.annotation.UML;
026
027import static org.opengis.annotation.Obligation.*;
028import static org.opengis.annotation.Specification.*;
029
030
031/**
032 * Grid with cells irregularly spaced in any given geographic/projected coordinate reference system.
033 * Individual cells can be geolocated using geolocation information supplied with the data but cannot
034 * be geolocated from the grid properties alone.
035 *
036 * @author  Martin Desruisseaux (IRD)
037 * @author  Cory Horner (Refractions Research)
038 * @author  Cédric Briançon (Geomatys)
039 * @version 3.1
040 * @since   2.0
041 */
042@UML(identifier="MD_Georeferenceable", specification=ISO_19115)
043public interface Georeferenceable extends GridSpatialRepresentation {
044    /**
045     * Indication of whether or not control point(s) exists.
046     *
047     * @return whether or not control point(s) exists.
048     */
049    @UML(identifier="controlPointAvailability", obligation=MANDATORY, specification=ISO_19115)
050    boolean isControlPointAvailable();
051
052    /**
053     * Indication of whether or not orientation parameters are available.
054     *
055     * @return whether or not orientation parameters are available.
056     */
057    @UML(identifier="orientationParameterAvailability", obligation=MANDATORY, specification=ISO_19115)
058    boolean isOrientationParameterAvailable();
059
060    /**
061     * Description of parameters used to describe sensor orientation.
062     *
063     * @return description of parameters used to describe sensor orientation, or {@code null}.
064     */
065    @UML(identifier="orientationParameterDescription", obligation=OPTIONAL, specification=ISO_19115)
066    default InternationalString getOrientationParameterDescription() {
067        return null;
068    }
069
070    /**
071     * Terms which support grid data georeferencing.
072     *
073     * @return terms which support grid data georeferencing.
074     */
075    @UML(identifier="georeferencedParameters", obligation=MANDATORY, specification=ISO_19115)
076    Record getGeoreferencedParameters();
077
078    /**
079     * Reference providing description of the parameters.
080     *
081     * @return reference providing description of the parameters.
082     */
083    @UML(identifier="parameterCitation", obligation=OPTIONAL, specification=ISO_19115)
084    default Collection<? extends Citation> getParameterCitations() {
085        return Collections.emptyList();
086    }
087
088    /**
089     * Information that can be used to geolocate the data.
090     *
091     * @return a geolocalisation of the data.
092     */
093    @UML(identifier="geolocationInformation", obligation=MANDATORY, specification=ISO_19115_2)
094    Collection<? extends GeolocationInformation> getGeolocationInformation();
095}