Class DefaultDigitalTransferOptions

All Implemented Interfaces:
Serializable, Emptiable, LenientComparable, IdentifiedObject, org.opengis.metadata.distribution.DigitalTransferOptions

public class DefaultDigitalTransferOptions extends ISOMetadata implements org.opengis.metadata.distribution.DigitalTransferOptions
Technical means and media by which a resource is obtained from the distributor.

Limitations

  • Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
  • Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.
Since:
0.3
Version:
1.0
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      Serial number for inter-operability with different versions.
      See Also:
    • unitsOfDistribution

      private org.opengis.util.InternationalString unitsOfDistribution
      Tiles, layers, geographic areas, etc., in which data is available.
    • transferSize

      private Double transferSize
      Estimated size of a unit in the specified transfer format, expressed in megabytes. The transfer size shall be greater than 0.
    • onLines

      private Collection<org.opengis.metadata.citation.OnlineResource> onLines
      Information about online sources from which the resource can be obtained.
    • offLines

      private Collection<org.opengis.metadata.distribution.Medium> offLines
      Information about offline media on which the resource can be obtained.
    • transferFrequency

      private org.opengis.temporal.PeriodDuration transferFrequency
      Rate of occurrence of distribution.
    • distributionFormats

      private Collection<org.opengis.metadata.distribution.Format> distributionFormats
      Formats of distribution.
  • Constructor Details

    • DefaultDigitalTransferOptions

      public DefaultDigitalTransferOptions()
      Constructs an initially empty digital transfer options.
    • DefaultDigitalTransferOptions

      public DefaultDigitalTransferOptions(org.opengis.metadata.distribution.DigitalTransferOptions object)
      Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.
      Note on properties validation: This constructor does not verify the property values of the given metadata (e.g. whether it contains unexpected negative values). This is because invalid metadata exist in practice, and verifying their validity in this copy constructor is often too late. Note that this is not the only hole, as invalid metadata instances can also be obtained by unmarshalling an invalid XML document.
      Parameters:
      object - the metadata to copy values from, or null if none.
      See Also:
  • Method Details

    • castOrCopy

      public static DefaultDigitalTransferOptions castOrCopy(org.opengis.metadata.distribution.DigitalTransferOptions object)
      Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:
      • If the given object is null, then this method returns null.
      • Otherwise if the given object is already an instance of DefaultDigitalTransferOptions, then it is returned unchanged.
      • Otherwise a new DefaultDigitalTransferOptions instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.
    • getUnitsOfDistribution

      public org.opengis.util.InternationalString getUnitsOfDistribution()
      Returns tiles, layers, geographic areas, etc., in which data is available.
      Specified by:
      getUnitsOfDistribution in interface org.opengis.metadata.distribution.DigitalTransferOptions
      Returns:
      tiles, layers, geographic areas, etc. in which data is available, or null.
    • setUnitsOfDistribution

      public void setUnitsOfDistribution(org.opengis.util.InternationalString newValue)
      Sets tiles, layers, geographic areas, etc., in which data is available.
      Parameters:
      newValue - the new units of distribution.
    • getTransferSize

      @ValueRange(minimum=0.0, isMinIncluded=false) public Double getTransferSize()
      Returns an estimated size of a unit in the specified transfer format, expressed in megabytes. The transfer size is greater than zero.
      Specified by:
      getTransferSize in interface org.opengis.metadata.distribution.DigitalTransferOptions
      Returns:
      estimated size of a unit in the specified transfer format in megabytes, or null.
    • setTransferSize

      public void setTransferSize(Double newValue)
      Sets an estimated size of a unit in the specified transfer format, expressed in megabytes. The transfer shall be greater than zero.
      Parameters:
      newValue - the new transfer size, or null.
      Throws:
      IllegalArgumentException - if the given value is NaN or negative.
    • getOnLines

      public Collection<org.opengis.metadata.citation.OnlineResource> getOnLines()
      Returns information about online sources from which the resource can be obtained.
      Specified by:
      getOnLines in interface org.opengis.metadata.distribution.DigitalTransferOptions
      Returns:
      online sources from which the resource can be obtained.
    • setOnLines

      public void setOnLines(Collection<? extends org.opengis.metadata.citation.OnlineResource> newValues)
      Sets information about online sources from which the resource can be obtained.
      Parameters:
      newValues - the new online sources.
    • getOffLines

      @UML(identifier="offLine", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.distribution.Medium> getOffLines()
      Returns information about offline media on which the resource can be obtained.
      Returns:
      offline media on which the resource can be obtained.
      Since:
      0.5
    • setOffLines

      public void setOffLines(Collection<? extends org.opengis.metadata.distribution.Medium> newValues)
      Sets information about offline media on which the resource can be obtained.
      Parameters:
      newValues - the new offline media.
      Since:
      0.5
    • getOffLine

      @Deprecated public org.opengis.metadata.distribution.Medium getOffLine()
      Deprecated.
      As of ISO 19115:2014, replaced by getOffLines().
      Returns information about offline media on which the resource can be obtained.
      Specified by:
      getOffLine in interface org.opengis.metadata.distribution.DigitalTransferOptions
      Returns:
      offline media on which the resource can be obtained, or null.
    • setOffLine

      @Deprecated public void setOffLine(org.opengis.metadata.distribution.Medium newValue)
      Deprecated.
      As of ISO 19115:2014, replaced by setOffLines(Collection).
      Sets information about offline media on which the resource can be obtained.
      Parameters:
      newValue - the new offline media.
    • getTransferFrequency

      @UML(identifier="transferFrequency", obligation=OPTIONAL, specification=ISO_19115) public org.opengis.temporal.PeriodDuration getTransferFrequency()
      Returns the rate of occurrence of distribution.
      Returns:
      rate of occurrence of distribution, or null if none.
      Since:
      0.5
    • setTransferFrequency

      public void setTransferFrequency(org.opengis.temporal.PeriodDuration newValue)
      Sets the rate of occurrence of distribution.
      Parameters:
      newValue - the new rate of occurrence of distribution.
      Since:
      0.5
    • getDistributionFormats

      @UML(identifier="distributionFormat", obligation=OPTIONAL, specification=ISO_19115) public Collection<org.opengis.metadata.distribution.Format> getDistributionFormats()
      Returns the formats of distribution.
      Returns:
      formats of distribution.
      Since:
      0.5
    • setDistributionFormats

      public void setDistributionFormats(Collection<? extends org.opengis.metadata.distribution.Format> newValues)
      Sets the formats of distribution.
      Parameters:
      newValues - the new formats of distribution.
      Since:
      0.5
    • getDistributionFormat

      private Collection<org.opengis.metadata.distribution.Format> getDistributionFormat()
      Invoked by JAXB at both marshalling and unmarshalling time. This attribute has been added by ISO 19115:2014 standard. If (and only if) marshalling an older standard version, we omit this attribute.