org.geotoolkit.metadata.iso.distribution
Class DefaultDigitalTransferOptions

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultDigitalTransferOptions

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, DigitalTransferOptions

@ThreadSafe
public class DefaultDigitalTransferOptions
extends MetadataEntity
implements DigitalTransferOptions

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

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultDigitalTransferOptions()
Constructs an initially empty digital transfer options.

DefaultDigitalTransferOptions(DigitalTransferOptions source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultDigitalTransferOptions	castOrCopy(DigitalTransferOptions object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Medium	getOffLine() Returns information about offline media on which the resource can be obtained.
Collection<OnlineResource>	getOnLines() Returns information about online sources from which the resource can be obtained.
Double	getTransferSize() Returns an estimated size of a unit in the specified transfer format, expressed in megabytes.
InternationalString	getUnitsOfDistribution() Returns tiles, layers, geographic areas, etc., in which data is available.
void	setOffLine(Medium newValue) Sets information about offline media on which the resource can be obtained.
void	setOnLines(Collection<? extends OnlineResource> newValues) Sets information about online sources from which the resource can be obtained.
void	setTransferSize(Double newValue) Sets an estimated size of a unit in the specified transfer format, expressed in megabytes.
void	setUnitsOfDistribution(InternationalString newValue) Sets tiles, layers, geographic areas, etc., in which data is available.

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultDigitalTransferOptions

public DefaultDigitalTransferOptions()

Constructs an initially empty digital transfer options.

DefaultDigitalTransferOptions

public DefaultDigitalTransferOptions(DigitalTransferOptions source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.4

Method Detail

castOrCopy

public static DefaultDigitalTransferOptions castOrCopy(DigitalTransferOptions object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getUnitsOfDistribution

public InternationalString getUnitsOfDistribution()

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

Specified by:

getUnitsOfDistribution in interface DigitalTransferOptions

setUnitsOfDistribution

public void setUnitsOfDistribution(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)
public Double getTransferSize()

Returns an estimated size of a unit in the specified transfer format, expressed in megabytes. The transfer size is > 0.0. Returns null if the transfer size is unknown.

Specified by:

getTransferSize in interface DigitalTransferOptions

setTransferSize

public void setTransferSize(Double newValue)

Sets an estimated size of a unit in the specified transfer format, expressed in megabytes. The transfer size is > 0.0.

Parameters:

newValue - The new transfer size.

getOnLines

public Collection<OnlineResource> getOnLines()

Returns information about online sources from which the resource can be obtained.

Specified by:

getOnLines in interface DigitalTransferOptions

setOnLines

public void setOnLines(Collection<? extends OnlineResource> newValues)

Sets information about online sources from which the resource can be obtained.

Parameters:

newValues - The new online sources.

getOffLine

public Medium getOffLine()

Returns information about offline media on which the resource can be obtained.

Specified by:

getOffLine in interface DigitalTransferOptions

setOffLine

public void setOffLine(Medium newValue)

Sets information about offline media on which the resource can be obtained.

Parameters:

newValue - The new offline media.