Class DefaultDigitalTransferOptions
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.distribution.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:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Collection
<org.opengis.metadata.distribution.Format> Formats of distribution.private Collection
<org.opengis.metadata.distribution.Medium> Information about offline media on which the resource can be obtained.private Collection
<org.opengis.metadata.citation.OnlineResource> Information about online sources from which the resource can be obtained.private static final long
Serial number for inter-operability with different versions.private org.opengis.temporal.PeriodDuration
Rate of occurrence of distribution.private Double
Estimated size of a unit in the specified transfer format, expressed in megabytes.private org.opengis.util.InternationalString
Tiles, layers, geographic areas, etc., in which data is available.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty digital transfer options.DefaultDigitalTransferOptions
(org.opengis.metadata.distribution.DigitalTransferOptions object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptioncastOrCopy
(org.opengis.metadata.distribution.DigitalTransferOptions object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.private Collection
<org.opengis.metadata.distribution.Format> Invoked by JAXB at both marshalling and unmarshalling time.Collection
<org.opengis.metadata.distribution.Format> Returns the formats of distribution.org.opengis.metadata.distribution.Medium
Deprecated.Collection
<org.opengis.metadata.distribution.Medium> Returns information about offline media on which the resource can be obtained.Collection
<org.opengis.metadata.citation.OnlineResource> Returns information about online sources from which the resource can be obtained.org.opengis.temporal.PeriodDuration
Returns the rate of occurrence of distribution.Returns an estimated size of a unit in the specified transfer format, expressed in megabytes.org.opengis.util.InternationalString
Returns tiles, layers, geographic areas, etc., in which data is available.void
setDistributionFormats
(Collection<? extends org.opengis.metadata.distribution.Format> newValues) Sets the formats of distribution.void
setOffLine
(org.opengis.metadata.distribution.Medium newValue) Deprecated.As of ISO 19115:2014, replaced bysetOffLines(Collection)
.void
setOffLines
(Collection<? extends org.opengis.metadata.distribution.Medium> newValues) Sets information about offline media on which the resource can be obtained.void
setOnLines
(Collection<? extends org.opengis.metadata.citation.OnlineResource> newValues) Sets information about online sources from which the resource can be obtained.void
setTransferFrequency
(org.opengis.temporal.PeriodDuration newValue) Sets the rate of occurrence of distribution.void
setTransferSize
(Double newValue) Sets an estimated size of a unit in the specified transfer format, expressed in megabytes.void
setUnitsOfDistribution
(org.opengis.util.InternationalString newValue) Sets tiles, layers, geographic areas, etc., in which data is available.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
unitsOfDistribution
private org.opengis.util.InternationalString unitsOfDistributionTiles, layers, geographic areas, etc., in which data is available. -
transferSize
Estimated size of a unit in the specified transfer format, expressed in megabytes. The transfer size shall be greater than 0. -
onLines
Information about online sources from which the resource can be obtained. -
offLines
Information about offline media on which the resource can be obtained. -
transferFrequency
private org.opengis.temporal.PeriodDuration transferFrequencyRate of occurrence of distribution. -
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, ornull
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 returnsnull
. - 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, ornull
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.
- If the given object is
-
getUnitsOfDistribution
public org.opengis.util.InternationalString getUnitsOfDistribution()Returns tiles, layers, geographic areas, etc., in which data is available.- Specified by:
getUnitsOfDistribution
in interfaceorg.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
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 interfaceorg.opengis.metadata.distribution.DigitalTransferOptions
- Returns:
- estimated size of a unit in the specified transfer format in megabytes, or
null
.
-
setTransferSize
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, ornull
.- Throws:
IllegalArgumentException
- if the given value is NaN or negative.
-
getOnLines
Returns information about online sources from which the resource can be obtained.- Specified by:
getOnLines
in interfaceorg.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
Sets information about offline media on which the resource can be obtained.- Parameters:
newValues
- the new offline media.- Since:
- 0.5
-
getOffLine
Deprecated.As of ISO 19115:2014, replaced bygetOffLines()
.Returns information about offline media on which the resource can be obtained.- Specified by:
getOffLine
in interfaceorg.opengis.metadata.distribution.DigitalTransferOptions
- Returns:
- offline media on which the resource can be obtained, or
null
.
-
setOffLine
Deprecated.As of ISO 19115:2014, replaced bysetOffLines(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
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.
-
getOffLines()
.