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;
019
020import java.net.URI;
021import org.opengis.annotation.UML;
022import org.opengis.metadata.citation.Citation;
023import org.opengis.metadata.citation.OnlineResource;
024
025import static org.opengis.annotation.Obligation.*;
026import static org.opengis.annotation.Specification.*;
027
028
029/**
030 * Defines and exposes the structure of a resource (model and/or data dictionary).
031 *
032 * @author  Martin Desruisseaux (IRD)
033 * @version 3.1
034 * @since   2.0
035 */
036@UML(identifier="MD_ApplicationSchemaInformation", specification=ISO_19115)
037public interface ApplicationSchemaInformation {
038    /**
039     * Name of the application schema used.
040     *
041     * @return name of the application schema.
042     */
043    @UML(identifier="name", obligation=MANDATORY, specification=ISO_19115)
044    Citation getName();
045
046    /**
047     * Identification of the schema language used.
048     *
049     * @return the schema language used.
050     */
051    @UML(identifier="schemaLanguage", obligation=MANDATORY, specification=ISO_19115)
052    String getSchemaLanguage();
053
054    /**
055     * Formal language used in Application Schema.
056     *
057     * @return formal language used in Application Schema.
058     */
059    @UML(identifier="constraintLanguage", obligation=MANDATORY, specification=ISO_19115)
060    String getConstraintLanguage();
061
062    /**
063     * Full application schema given as an ASCII file.
064     *
065     * <div class="warning"><b>Upcoming API change</b><br>
066     * {@code URI} will be replaced by {@link CharSequence} in GeoAPI 4.0.
067     * </div>
068     *
069     * @return application schema as an ASCII file, or {@code null}.
070     */
071    @UML(identifier="schemaAscii", obligation=OPTIONAL, specification=ISO_19115)
072    default URI getSchemaAscii() {
073        return null;
074    }
075
076    /**
077     * Full application schema given as a graphics file.
078     *
079     * <div class="warning"><b>Upcoming API change</b><br>
080     * As of ISO 19115:2014, {@code URI} is replaced by {@link OnlineResource}.
081     * This change may be applied in GeoAPI 4.0.
082     * </div>
083     *
084     * @return application schema as a graphics file, or {@code null}.
085     */
086    @UML(identifier="graphicsFile", obligation=OPTIONAL, specification=ISO_19115, version=2003)
087    default URI getGraphicsFile() {
088        return null;
089    }
090
091    /**
092     * Full application schema given as a software development file.
093     *
094     * <div class="warning"><b>Upcoming API change</b><br>
095     * As of ISO 19115:2014, {@code URI} is replaced by {@link OnlineResource}.
096     * This change may be applied in GeoAPI 4.0.
097     * </div>
098     *
099     * @return application schema as a software development file, or {@code null}.
100     */
101    @UML(identifier="softwareDevelopmentFile", obligation=OPTIONAL, specification=ISO_19115, version=2003)
102    default URI getSoftwareDevelopmentFile() {
103        return null;
104    }
105
106    /**
107     * Software dependent format used for the application schema software dependent file.
108     *
109     * @return format used for the application schema software file, or {@code null}.
110     */
111    @UML(identifier="softwareDevelopmentFileFormat", obligation=OPTIONAL, specification=ISO_19115)
112    default String getSoftwareDevelopmentFileFormat() {
113        return null;
114    }
115}