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.distribution;
019
020import java.util.Collection;
021import java.util.Collections;
022import java.time.temporal.TemporalAmount;
023import org.opengis.util.InternationalString;
024import org.opengis.metadata.citation.OnlineResource;
025import org.opengis.annotation.UML;
026import org.opengis.annotation.Profile;
027
028import static org.opengis.annotation.Obligation.*;
029import static org.opengis.annotation.Specification.*;
030import static org.opengis.annotation.ComplianceLevel.*;
031
032
033/**
034 * Technical means and media by which a resource is obtained from the distributor.
035 *
036 * @author  Martin Desruisseaux (IRD)
037 * @author  Cory Horner (Refractions Research)
038 * @version 3.1
039 * @since   2.0
040 */
041@UML(identifier="MD_DigitalTransferOptions", specification=ISO_19115)
042public interface DigitalTransferOptions {
043    /**
044     * Tiles, layers, geographic areas, <i>etc.</i>, in which data is available.
045     * Units of distribution apply to both onLine and offLine distributions.
046     *
047     * @return tiles, layers, geographic areas, <i>etc.</i> in which data is available, or {@code null}.
048     */
049    @UML(identifier="unitsOfDistribution", obligation=OPTIONAL, specification=ISO_19115)
050    default InternationalString getUnitsOfDistribution() {
051        return null;
052    }
053
054    /**
055     * Estimated size of a unit in the specified transfer format, expressed in megabytes.
056     * The transfer size shall be greater than zero.
057     * Returns {@code null} if the transfer size is unknown.
058     *
059     * @return estimated size of a unit in the specified transfer format in megabytes, or {@code null}.
060     */
061    @UML(identifier="transferSize", obligation=OPTIONAL, specification=ISO_19115)
062    default Double getTransferSize() {
063        return null;
064    }
065
066    /**
067     * Information about online sources from which the resource can be obtained.
068     *
069     * @return online sources from which the resource can be obtained.
070     */
071    @Profile(level=CORE)
072    @UML(identifier="onLine", obligation=OPTIONAL, specification=ISO_19115)
073    default Collection<? extends OnlineResource> getOnLines() {
074        return Collections.emptyList();
075    }
076
077    /**
078     * Information about offline media on which the resource can be obtained.
079     *
080     * @return offline media on which the resource can be obtained.
081     *
082     * @since 3.1
083     */
084    @UML(identifier="offLine", obligation=OPTIONAL, specification=ISO_19115)
085    default Collection<? extends Medium> getOffLines() {
086        return Collections.emptyList();
087    }
088
089    /**
090     * Information about offline media on which the resource can be obtained.
091     *
092     * @return offline media on which the resource can be obtained, or {@code null}.
093     *
094     * @deprecated As of ISO 19115:2014, replaced by {@link #getOffLines()}.
095     */
096    @Deprecated(since="3.1")
097    Medium getOffLine();
098
099    /**
100     * Rate of occurrence of distribution.
101     * If non-null, the returned value should be an instance of {@link java.time.Period}
102     * when a precision in number of years, months and days is sufficient.
103     *
104     * @return rate of occurrence of distribution, or {@code null} if none.
105     *
106     * @departure integration
107     *   The type defined by ISO 19115 is {@code TM_PeriodDuration}, an interface defined by ISO 19108.
108     *   That ISO type should be mapped to {@link java.time.Period} from the standard Java library,
109     *   or to {@link java.time.Duration} if a precision smaller than one day is needed.
110     *
111     * @since 3.1
112     */
113    @UML(identifier="transferFrequency", obligation=OPTIONAL, specification=ISO_19115)
114    default TemporalAmount getTransferFrequency() {
115        return null;
116    }
117
118    /**
119     * Formats of distribution.
120     *
121     * @return formats of distribution.
122     *
123     * @since 3.1
124     */
125    @UML(identifier="distributionFormat", obligation=OPTIONAL, specification=ISO_19115)
126    default Collection<? extends Format> getDistributionFormats() {
127        return Collections.emptyList();
128    }
129}