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;
019
020import java.util.Collection;
021import java.util.Collections;
022import org.opengis.util.InternationalString;
023import org.opengis.metadata.citation.Responsibility;
024import org.opengis.metadata.citation.ResponsibleParty;
025import org.opengis.annotation.UML;
026
027import static org.opengis.annotation.Obligation.*;
028import static org.opengis.annotation.Specification.*;
029
030
031/**
032 * New metadata element, not found in ISO 19115, which is required to describe geographic data.
033 * Metadata elements are contained in a {@linkplain MetadataExtensionInformation metadata extension information}.
034 *
035 * @author  Martin Desruisseaux (IRD)
036 * @version 3.1
037 * @since   2.0
038 */
039@UML(identifier="MD_ExtendedElementInformation", specification=ISO_19115)
040public interface ExtendedElementInformation {
041    /**
042     * Name of the extended metadata element.
043     *
044     * @return name of the extended metadata element.
045     *
046     * @departure historic
047     *    This property has been kept conform to ISO 19115:2003 for simplicity.
048     *    The 2014 revision defines two mutually exclusive names depending on the data type:
049     *    {@code "conceptName"} for {@code ENUMERATION}, {@code CODE_LIST} or {@code CODE_LIST_ELEMENT},
050     *    and {@code "name"} for all other data types. GeoAPI keeps the {@code "name"} property for all
051     *    data types and let developers inspect the {@code "dataType"} property if needed.
052     */
053    @UML(identifier="name", obligation=MANDATORY, specification=ISO_19115)
054    String getName();
055
056    /**
057     * Short form suitable for use in an implementation method such as XML or SGML.
058     * Returns {@code null} if the {@linkplain #getDataType() data type}
059     * is {@linkplain Datatype#CODE_LIST_ELEMENT code list element}, in which case
060     * {@link #getDomainCode()} may be used instead.
061     *
062     * @return short form suitable for use in an implementation method such as XML or SGML,
063     *         or {@code null}.
064     *
065     * @condition The {@linkplain #getDataType() data type} is not
066     *            {@link Datatype#CODE_LIST_ELEMENT CODE_LIST_ELEMENT}.
067     *
068     * @deprecated Removed as of ISO 19115:2014.
069     */
070    @Deprecated(since="3.1")
071    @UML(identifier="shortName", obligation=CONDITIONAL, specification=ISO_19115, version=2003)
072    default String getShortName() {
073        return null;
074    }
075
076    /**
077     * Three digit code assigned to the extended element.
078     * Returns a non-null value only if the {@linkplain #getDataType() data type}
079     * is {@linkplain Datatype#CODE_LIST_ELEMENT code list element}, otherwise
080     * {@link #getShortName()} may be used instead.
081     *
082     * @return three digit code assigned to the extended element, or {@code null}.
083     *
084     * @condition The {@linkplain #getDataType() data type} is
085     *            {@link Datatype#CODE_LIST_ELEMENT CODE_LIST_ELEMENT}.
086     *
087     * @deprecated Removed as of ISO 19115:2014.
088     */
089    @Deprecated(since="3.1")
090    @UML(identifier="domainCode", obligation=CONDITIONAL, specification=ISO_19115, version=2003)
091    default Integer getDomainCode() {
092        return null;
093    }
094
095    /**
096     * Definition of the extended element.
097     *
098     * @return definition of the extended element.
099     */
100    @UML(identifier="definition", obligation=MANDATORY, specification=ISO_19115)
101    InternationalString getDefinition();
102
103    /**
104     * Obligation of the extended element.
105     *
106     * <div class="warning"><b>Upcoming API change — type change</b><br>
107     * According ISO 19115, {@code Obligation} shall be an enumeration, not a code list.
108     * Such enumeration already exists in the {@link org.opengis.annotation} package.
109     * Consequently the {@code org.opengis.metadata.Obligation} return type may be
110     * replaced by {@code org.opengis.annotation.Obligation} in GeoAPI 4.0.
111     * See <a href="http://jira.codehaus.org/browse/GEO-199">GEO-199</a> for more information.</div>
112     *
113     * @return obligation of the extended element, or {@code null}.
114     *
115     * @condition The {@linkplain #getDataType() data type} is not {@link Datatype#ENUMERATION ENUMERATION},
116     *            {@link Datatype#CODE_LIST CODE_LIST} or {@link Datatype#CODE_LIST_ELEMENT CODE_LIST_ELEMENT}.
117     */
118    @UML(identifier="obligation", obligation=CONDITIONAL, specification=ISO_19115)
119    Obligation getObligation();
120
121    /**
122     * Condition under which the extended element is mandatory.
123     * Returns a non-null value only if the {@linkplain #getObligation() obligation}
124     * is {@linkplain Obligation#CONDITIONAL conditional}.
125     *
126     * @return the condition under which the extended element is mandatory, or {@code null}.
127     *
128     * @condition The {@linkplain #getObligation() Obligation} is {@link Obligation#CONDITIONAL CONDITIONAL}.
129     */
130    @UML(identifier="condition", obligation=CONDITIONAL, specification=ISO_19115)
131    InternationalString getCondition();
132
133    /**
134     * Code which identifies the kind of value provided in the extended element.
135     *
136     * @return the kind of value provided in the extended element.
137     */
138    @UML(identifier="dataType", obligation=MANDATORY, specification=ISO_19115)
139    Datatype getDataType();
140
141    /**
142     * Maximum occurrence of the extended element.
143     * Returns {@code null} if it doesn't apply, for example if the
144     * {@linkplain #getDataType() data type} is {@linkplain Datatype#ENUMERATION enumeration},
145     * {@linkplain Datatype#CODE_LIST code list} or {@linkplain Datatype#CODE_LIST_ELEMENT
146     * code list element}.
147     *
148     * @return maximum occurrence of the extended element, or {@code null}.
149     *
150     * @condition The {@linkplain #getDataType() data type} is not {@link Datatype#ENUMERATION ENUMERATION},
151     *            {@link Datatype#CODE_LIST CODE_LIST} or {@link Datatype#CODE_LIST_ELEMENT CODE_LIST_ELEMENT}.
152     */
153    @UML(identifier="maximumOccurrence", obligation=CONDITIONAL, specification=ISO_19115)
154    Integer getMaximumOccurrence();
155
156    /**
157     * Valid values that can be assigned to the extended element.
158     * Returns {@code null} if it doesn't apply, for example if the
159     * {@linkplain #getDataType() data type} is {@linkplain Datatype#ENUMERATION enumeration},
160     * {@linkplain Datatype#CODE_LIST code list} or {@linkplain Datatype#CODE_LIST_ELEMENT
161     * code list element}.
162     *
163     * @return valid values that can be assigned to the extended element, or {@code null}.
164     *
165     * @condition The {@linkplain #getDataType() data type} is not {@link Datatype#ENUMERATION ENUMERATION},
166     *            {@link Datatype#CODE_LIST CODE_LIST} or {@link Datatype#CODE_LIST_ELEMENT CODE_LIST_ELEMENT}.
167     */
168    @UML(identifier="domainValue", obligation=CONDITIONAL, specification=ISO_19115)
169    InternationalString getDomainValue();
170
171    /**
172     * Name of the metadata entity(s) under which this extended metadata element may appear.
173     * The name(s) may be standard metadata element(s) or other extended metadata element(s).
174     *
175     * @return name of the metadata entity(s) under which this extended metadata element may appear.
176     */
177    @UML(identifier="parentEntity", obligation=MANDATORY, specification=ISO_19115)
178    Collection<String> getParentEntity();
179
180    /**
181     * Specifies how the extended element relates to other existing elements and entities.
182     *
183     * @return how the extended element relates to other existing elements and entities.
184     */
185    @UML(identifier="rule", obligation=MANDATORY, specification=ISO_19115)
186    InternationalString getRule();
187
188    /**
189     * Reason for creating the extended element.
190     *
191     * @return reason for creating the extended element.
192     *
193     * @since 3.1
194     */
195    @UML(identifier="rationale", obligation=OPTIONAL, specification=ISO_19115)
196    default InternationalString getRationale() {
197        return null;
198    }
199
200    /**
201     * @deprecated As of ISO 19115:2014, replaced by {@link #getRationale()}.
202     *
203     * @return reason for creating the extended element.
204     */
205    @Deprecated(since="3.1")
206    default Collection<? extends InternationalString> getRationales() {
207        InternationalString rationale = getRationale();
208        return (rationale != null) ? Collections.singletonList(rationale) : Collections.emptyList();
209    }
210
211    /**
212     * Name of the person or organization creating the extended element.
213     *
214     * <div class="warning"><b>Upcoming API change — generalization</b><br>
215     * As of ISO 19115:2014, {@code ResponsibleParty} is replaced by the {@link Responsibility} parent interface.
216     * This change may be applied in GeoAPI 4.0.
217     * </div>
218     *
219     * @return name of the person or organization creating the extended element.
220     */
221    @UML(identifier="source", obligation=MANDATORY, specification=ISO_19115, version=2003)
222    Collection<? extends ResponsibleParty> getSources();
223
224    /*
225     * No 'getConceptName()' method. See 'getName()' for explanation.
226     */
227}