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.List;
021import java.util.Collections;
022import org.opengis.annotation.UML;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Basic information required to uniquely identify a resource or resources.
030 *
031 * @author  Martin Desruisseaux (IRD)
032 * @author  Cory Horner (Refractions Research)
033 * @version 3.1
034 * @since   2.0
035 */
036@UML(identifier="MD_GridSpatialRepresentation", specification=ISO_19115)
037public interface GridSpatialRepresentation extends SpatialRepresentation {
038    /**
039     * Number of independent spatial-temporal axes.
040     *
041     * @return number of independent spatial-temporal axes.
042     */
043    @UML(identifier="numberOfDimensions", obligation=MANDATORY, specification=ISO_19115)
044    Integer getNumberOfDimensions();
045
046    /**
047     * Information about spatial-temporal axis properties.
048     *
049     * @return information about spatial-temporal axis properties.
050     */
051    @UML(identifier="axisDimensionProperties", obligation=OPTIONAL, specification=ISO_19115)
052    default List<? extends Dimension> getAxisDimensionProperties() {
053        return Collections.emptyList();
054    }
055
056    /**
057     * Identification of grid data as point or cell.
058     *
059     * @return identification of grid data as point or cell.
060     */
061    @UML(identifier="cellGeometry", obligation=MANDATORY, specification=ISO_19115)
062    CellGeometry getCellGeometry();
063
064    /**
065     * Indication of whether or not parameters for transformation exists.
066     *
067     * @return whether or not parameters for transformation exists.
068     */
069    @UML(identifier="transformationParameterAvailability", obligation=MANDATORY, specification=ISO_19115)
070    boolean isTransformationParameterAvailable();
071}