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 org.opengis.annotation.UML;
021import org.opengis.annotation.Classifier;
022import org.opengis.annotation.Stereotype;
023
024import static org.opengis.annotation.Obligation.*;
025import static org.opengis.annotation.Specification.*;
026
027
028/**
029 * Number of objects, listed by geometric object type, used in the dataset.
030 *
031 * @author  Martin Desruisseaux (IRD)
032 * @version 3.1
033 * @since   2.0
034 */
035@Classifier(Stereotype.DATATYPE)
036@UML(identifier="MD_GeometricObjects", specification=ISO_19115)
037public interface GeometricObjects {
038    /**
039     * Name of point and vector spatial objects used to locate zero-, one-, two- or three-dimensional
040     * spatial locations in the dataset.
041     *
042     * @return name of spatial objects used to locate spatial locations in the dataset.
043     */
044    @UML(identifier="geometricObjectType", obligation=MANDATORY, specification=ISO_19115)
045    GeometricObjectType getGeometricObjectType();
046
047    /**
048     * Total number of the point or vector object type occurring in the dataset.
049     *
050     * @return total number of the point or vector object type, or {@code null}.
051     */
052    @UML(identifier="geometricObjectCount", obligation=OPTIONAL, specification=ISO_19115)
053    default Integer getGeometricObjectCount() {
054        return null;
055    }
056}