Class DefaultDigitalTransferOptions
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultDigitalTransferOptions
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty digital transfer options.Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptioncastOrCopy(DigitalTransferOptions object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the formats of distribution.Deprecated.Returns information about offline media on which the resource can be obtained.Returns information about online sources from which the resource can be obtained.Returns the rate of occurrence of distribution.Returns an estimated size of a unit in the specified transfer format, expressed in megabytes.Returns tiles, layers, geographic areas, etc., in which data is available.voidsetDistributionFormats(Collection<? extends Format> newValues) Sets the formats of distribution.voidsetOffLine(Medium newValue) Deprecated.As of ISO 19115:2014, replaced bysetOffLines(Collection).voidsetOffLines(Collection<? extends Medium> newValues) Sets information about offline media on which the resource can be obtained.voidsetOnLines(Collection<? extends OnlineResource> newValues) Sets information about online sources from which the resource can be obtained.voidsetTransferFrequency(PeriodDuration newValue) Sets the rate of occurrence of distribution.voidsetTransferSize(Double newValue) Sets an estimated size of a unit in the specified transfer format, expressed in megabytes.voidsetUnitsOfDistribution(InternationalString newValue) Sets tiles, layers, geographic areas, etc., in which data is available.Methods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultDigitalTransferOptionspublic DefaultDigitalTransferOptions()Constructs an initially empty digital transfer options.
- 
DefaultDigitalTransferOptionsConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 DefaultDigitalTransferOptionsinstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getUnitsOfDistributionReturns tiles, layers, geographic areas, etc., in which data is available.- Specified by:
- getUnitsOfDistributionin interface- DigitalTransferOptions
- Returns:
- tiles, layers, geographic areas, etc. in which data is available, or null.
 
- 
setUnitsOfDistributionSets tiles, layers, geographic areas, etc., in which data is available.- Parameters:
- newValue- the new units of distribution.
 
- 
getTransferSizeReturns an estimated size of a unit in the specified transfer format, expressed in megabytes. The transfer size is greater than zero.- Specified by:
- getTransferSizein interface- DigitalTransferOptions
- Returns:
- estimated size of a unit in the specified transfer format in megabytes, or null.
 
- 
setTransferSizeSets 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.
 
- 
getOnLinesReturns information about online sources from which the resource can be obtained.- Specified by:
- getOnLinesin interface- DigitalTransferOptions
- Returns:
- online sources from which the resource can be obtained.
 
- 
setOnLinesSets 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<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
 
- 
setOffLinesSets information about offline media on which the resource can be obtained.- Parameters:
- newValues- the new offline media.
- Since:
- 0.5
 
- 
getOffLineDeprecated.As of ISO 19115:2014, replaced bygetOffLines().Returns information about offline media on which the resource can be obtained.- Specified by:
- getOffLinein interface- DigitalTransferOptions
- Returns:
- offline media on which the resource can be obtained, or null.
 
- 
setOffLineDeprecated.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 PeriodDuration getTransferFrequency()Returns the rate of occurrence of distribution.- Returns:
- rate of occurrence of distribution, or nullif none.
- Since:
- 0.5
 
- 
setTransferFrequencySets 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<Format> getDistributionFormats()Returns the formats of distribution.- Returns:
- formats of distribution.
- Since:
- 0.5
 
- 
setDistributionFormatsSets the formats of distribution.- Parameters:
- newValues- the new formats of distribution.
- Since:
- 0.5
 
 
- 
getOffLines().