001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2004-2024 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 org.opengis.annotation.UML;
021import org.opengis.annotation.Classifier;
022import org.opengis.annotation.Stereotype;
023import org.opengis.util.InternationalString;
024
025import static org.opengis.annotation.Obligation.*;
026import static org.opengis.annotation.Specification.*;
027
028
029/**
030 * Axis properties.
031 *
032 * @author  Martin Desruisseaux (IRD)
033 * @author  Cory Horner (Refractions Research)
034 * @author  Rémi Maréchal (Geomatys)
035 * @version 3.1
036 * @since   2.0
037 */
038@Classifier(Stereotype.DATATYPE)
039@UML(identifier="MD_Dimension", specification=ISO_19115)
040public interface Dimension {
041    /**
042     * Name of the axis.
043     *
044     * @return name of the axis.
045     */
046    @UML(identifier="dimensionName", obligation=MANDATORY, specification=ISO_19115)
047    DimensionNameType getDimensionName();
048
049    /**
050     * Number of elements along the axis.
051     *
052     * @return number of elements along the axis.
053     */
054    @UML(identifier="dimensionSize", obligation=MANDATORY, specification=ISO_19115)
055    Integer getDimensionSize();
056
057    /**
058     * Degree of detail in the grid dataset.
059     *
060     * <div class="warning"><b>Upcoming API change — units of measurement</b><br>
061     * The return type of this method may change in GeoAPI 4.0. It may be replaced by the
062     * {@link javax.measure.Quantity} type in order to provide unit of measurement
063     * together with the value.
064     * </div>
065     *
066     * @return degree of detail in the grid dataset, or {@code null}.
067     * @unitof Measure
068     */
069    @UML(identifier="resolution", obligation=OPTIONAL, specification=ISO_19115)
070    default Double getResolution() {
071        return null;
072    }
073
074    /**
075     * Enhancement / modifier of the dimension name.
076     *
077     * <div class="note"><b>Example:</b>
078     * dimensionName = "column", dimensionTitle = "longitude"</div>
079     *
080     * @return enhancement / modifier of the dimension name, or {@code null} if none.
081     *
082     * @since 3.1
083     */
084    @UML(identifier="dimensionTitle", obligation=OPTIONAL, specification=ISO_19115)
085    default InternationalString getDimensionTitle() {
086        return null;
087    }
088
089    /**
090     * Description of the axis.
091     *
092     * @return description of the axis, or {@code null} if none.
093     *
094     * @since 3.1
095     */
096    @UML(identifier="dimensionDescription", obligation=OPTIONAL, specification=ISO_19115)
097    default InternationalString getDimensionDescription() {
098        return null;
099    }
100}