Module org.opengis.geoapi

Package org.opengis.metadata.distribution

Interface DigitalTransferOptions

@UML(identifier="MD_DigitalTransferOptions",
     specification=ISO_19115)
public interface DigitalTransferOptions

Technical means and media by which a resource is obtained from the distributor.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
default Collection<? extends Format>	getDistributionFormats()	Formats of distribution.
Medium	getOffLine()	Deprecated. As of ISO 19115:2014, replaced by getOffLines().
default Collection<? extends Medium>	getOffLines()	Information about offline media on which the resource can be obtained.
default Collection<? extends OnlineResource>	getOnLines()	Information about online sources from which the resource can be obtained.
default TemporalAmount	getTransferFrequency()	Rate of occurrence of distribution.
default Double	getTransferSize()	Estimated size of a unit in the specified transfer format, expressed in megabytes.
default InternationalString	getUnitsOfDistribution()	Tiles, layers, geographic areas, etc., in which data is available.

Method Details

getUnitsOfDistribution

@UML(identifier="unitsOfDistribution",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getUnitsOfDistribution()

Tiles, layers, geographic areas, etc., in which data is available. Units of distribution apply to both onLine and offLine distributions.

Returns:

tiles, layers, geographic areas, etc. in which data is available, or null.

getTransferSize

@UML(identifier="transferSize",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Double getTransferSize()

Estimated size of a unit in the specified transfer format, expressed in megabytes. The transfer size shall be greater than zero. Returns null if the transfer size is unknown.

Returns:

estimated size of a unit in the specified transfer format in megabytes, or null.

getOnLines

@Profile(level=CORE)
@UML(identifier="onLine",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends OnlineResource> getOnLines()

Information about online sources from which the resource can be obtained.

Returns:

online sources from which the resource can be obtained.

getOffLines

@UML(identifier="offLine",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Medium> getOffLines()

Information about offline media on which the resource can be obtained.

Returns:

offline media on which the resource can be obtained.

Since:

3.1

getOffLine

@Deprecated(since="3.1")
Medium getOffLine()

Deprecated.

As of ISO 19115:2014, replaced by getOffLines().

Information about offline media on which the resource can be obtained.

Returns:

offline media on which the resource can be obtained, or null.

getTransferFrequency

@UML(identifier="transferFrequency",
     obligation=OPTIONAL,
     specification=ISO_19115)
default TemporalAmount getTransferFrequency()

Rate of occurrence of distribution. If non-null, the returned value should be an instance of Period when a precision in number of years, months and days is sufficient.

Returns:

rate of occurrence of distribution, or null if none.

Since:

3.1

Departure from OGC/ISO standard for closer integration with the Java environment

The type defined by ISO 19115 is TM_PeriodDuration, an interface defined by ISO 19108. That ISO type should be mapped to java.time.Period from the standard Java library, or to java.time.Duration if a precision smaller than one day is needed.

getDistributionFormats

@UML(identifier="distributionFormat",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Collection<? extends Format> getDistributionFormats()

Formats of distribution.

Returns:

formats of distribution.

Since:

3.1