Class DefaultDigitalTransferOptions

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultDigitalTransferOptions

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Digital­Transfer­Options

public class DefaultDigitalTransferOptions
extends ISOMetadata
implements 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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Digital­Transfer­Options()	Constructs an initially empty digital transfer options.
Default­Digital­Transfer­Options(Digital­Transfer­Options object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Digital­Transfer­Options	cast­Or­Copy(Digital­Transfer­Options object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Format>	get­Distribution­Formats()	Returns the formats of distribution.
Medium	get­Off­Line()	Deprecated. As of ISO 19115:2014, replaced by get­Off­Lines().
Collection<Medium>	get­Off­Lines()	Returns information about offline media on which the resource can be obtained.
Collection<Online­Resource>	get­On­Lines()	Returns information about online sources from which the resource can be obtained.
Temporal­Amount	get­Transfer­Frequency()	Returns the rate of occurrence of distribution.
Double	get­Transfer­Size()	Returns an estimated size of a unit in the specified transfer format, expressed in megabytes.
International­String	get­Units­Of­Distribution()	Returns tiles, layers, geographic areas, etc., in which data is available.
void	set­Distribution­Formats(Collection<? extends Format> new­Values)	Sets the formats of distribution.
void	set­Off­Line(Medium new­Value)	Deprecated. As of ISO 19115:2014, replaced by set­Off­Lines(Collection).
void	set­Off­Lines(Collection<? extends Medium> new­Values)	Sets information about offline media on which the resource can be obtained.
void	set­On­Lines(Collection<? extends Online­Resource> new­Values)	Sets information about online sources from which the resource can be obtained.
void	set­Transfer­Frequency(Temporal­Amount new­Value)	Sets the rate of occurrence of distribution.
void	set­Transfer­Size(Double new­Value)	Sets an estimated size of a unit in the specified transfer format, expressed in megabytes.
void	set­Units­Of­Distribution(International­String new­Value)	Sets tiles, layers, geographic areas, etc., in which data is available.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultDigitalTransferOptions

public DefaultDigitalTransferOptions()

Constructs an initially empty digital transfer options.

DefaultDigitalTransferOptions

public DefaultDigitalTransferOptions(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:

• cast­Or­Copy(Digital­Transfer­Options)

Method Details

castOrCopy

public static DefaultDigitalTransferOptions castOrCopy(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 Default­Digital­Transfer­Options, then it is returned unchanged.
• Otherwise a new Default­Digital­Transfer­Options 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 InternationalString getUnitsOfDistribution()

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

Specified by:

get­Units­Of­Distribution in interface Digital­Transfer­Options

Returns:

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

setUnitsOfDistribution

public void setUnitsOfDistribution(InternationalString newValue)

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

Parameters:

new­Value - 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:

get­Transfer­Size in interface Digital­Transfer­Options

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:

new­Value - the new transfer size, or null.

Throws:

Illegal­Argument­Exception - if the given value is NaN or negative.

getOnLines

public Collection<OnlineResource> getOnLines()

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

Specified by:

get­On­Lines in interface Digital­Transfer­Options

Returns:

online sources from which the resource can be obtained.

setOnLines

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

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

Parameters:

new­Values - 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

setOffLines

public void setOffLines(Collection<? extends Medium> newValues)

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

Parameters:

new­Values - the new offline media.

Since:

0.5

getOffLine

@Deprecated(since="1.0")
public Medium getOffLine()

Deprecated.

As of ISO 19115:2014, replaced by get­Off­Lines().

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

Specified by:

get­Off­Line in interface Digital­Transfer­Options

Returns:

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

setOffLine

@Deprecated(since="1.0")
public void setOffLine(Medium newValue)

Deprecated.

As of ISO 19115:2014, replaced by set­Off­Lines(Collection).

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

Parameters:

new­Value - the new offline media.

getTransferFrequency

public TemporalAmount 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(TemporalAmount newValue)

Sets the rate of occurrence of distribution.

Parameters:

new­Value - 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

setDistributionFormats

public void setDistributionFormats(Collection<? extends Format> newValues)

Sets the formats of distribution.

Parameters:

new­Values - the new formats of distribution.

Since:

0.5