Class DefaultMedium

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultMedium

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Medium

@TitleProperty(name="name")
public class DefaultMedium
extends ISOMetadata
implements Medium

Information about the media on which the resource can be distributed. The following property is mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

MD_Medium └─density­Units…… Units of measure for the recording density.

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­Medium()	Constructs an initially empty medium.
Default­Medium(Medium object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Medium	cast­Or­Copy(Medium object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Double>	get­Densities()	Deprecated. As of ISO 19115:2014, replaced by get­Density().
Double	get­Density()	Returns the density at which the data is recorded.
Unit<?>	get­Density­Units()	Returns the units of measure for the recording density.
Identifier	get­Identifier()	Returns a unique identifier for an instance of the medium.
Collection<Medium­Format>	get­Medium­Formats()	Returns the method used to write to the medium.
International­String	get­Medium­Note()	Returns a description of other limitations or requirements for using the medium.
Medium­Name	get­Name()	Returns the name of the medium on which the resource can be received.
Integer	get­Volumes()	Returns the number of items in the media identified.
void	set­Densities(Collection<? extends Double> new­Values)	Deprecated. As of ISO 19115:2014, replaced by set­Density(Double).
void	set­Density(Double new­Value)	Sets density at which the data is recorded.
void	set­Density­Units(Unit<?> new­Value)	Sets the units of measure for the recording density.
void	set­Identifier(Identifier new­Value)	Sets a unique identifier for an instance of the medium.
void	set­Medium­Formats(Collection<? extends Medium­Format> new­Values)	Sets the method used to write to the medium.
void	set­Medium­Note(International­String new­Value)	Sets a description of other limitations or requirements for using the medium.
void	set­Name(Medium­Name new­Value)	Sets the name of the medium on which the resource can be received.
void	set­Volumes(Integer new­Value)	Sets the number of items in the media identified.

Methods inherited from class ISOMetadata

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

Modifier and Type	Method	Description
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.

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

DefaultMedium

public DefaultMedium()

Constructs an initially empty medium.

DefaultMedium

public DefaultMedium(Medium 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(Medium)

Method Details

castOrCopy

public static DefaultMedium castOrCopy(Medium 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­Medium, then it is returned unchanged.
• Otherwise a new Default­Medium 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.

getName

public MediumName getName()

Returns the name of the medium on which the resource can be received.

Upcoming API change
Medium­Name may be replaced by Citation in GeoAPI 4.0.

Specified by:

get­Name in interface Medium

Returns:

name of the medium, or null.

See Also:

• SIS-389

setName

public void setName(MediumName newValue)

Sets the name of the medium on which the resource can be received.

Upcoming API change
Medium­Name may be replaced by Citation in GeoAPI 4.0.

Parameters:

new­Value - the new name.

getDensity

@ValueRange(minimum=0.0,
            isMinIncluded=false)
@UML(identifier="density",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Double getDensity()

Returns the density at which the data is recorded. The number shall be greater than zero.

Returns:

density at which the data is recorded, or null.

Since:

0.5

setDensity

public void setDensity(Double newValue)

Sets density at which the data is recorded. The number shall be greater than zero.

Parameters:

new­Value - the new density.

Throws:

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

Since:

0.5

getDensities

@Deprecated(since="1.0")
public Collection<Double> getDensities()

Deprecated.

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

Description copied from interface: Medium

Density at which the data is recorded. The numbers shall be greater than zero.

Specified by:

get­Densities in interface Medium

Returns:

density at which the data is recorded, or null.

setDensities

@Deprecated(since="1.0")
public void setDensities(Collection<? extends Double> newValues)

Deprecated.

As of ISO 19115:2014, replaced by set­Density(Double).

Parameters:

new­Values - the new densities.

getDensityUnits

public Unit<?> getDensityUnits()

Returns the units of measure for the recording density.

Specified by:

get­Density­Units in interface Medium

Returns:

units of measure for the recording density, or null.

setDensityUnits

public void setDensityUnits(Unit<?> newValue)

Sets the units of measure for the recording density.

Parameters:

new­Value - the new density units.

getVolumes

@ValueRange(minimum=0.0)
public Integer getVolumes()

Returns the number of items in the media identified.

Specified by:

get­Volumes in interface Medium

Returns:

number of items in the media identified, or null.

setVolumes

public void setVolumes(Integer newValue)

Sets the number of items in the media identified.

Parameters:

new­Value - the new volumes, or null.

Throws:

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

getMediumFormats

public Collection<MediumFormat> getMediumFormats()

Returns the method used to write to the medium.

Specified by:

get­Medium­Formats in interface Medium

Returns:

method used to write to the medium, or null.

setMediumFormats

public void setMediumFormats(Collection<? extends MediumFormat> newValues)

Sets the method used to write to the medium.

Parameters:

new­Values - the new medium formats.

getMediumNote

public InternationalString getMediumNote()

Returns a description of other limitations or requirements for using the medium.

Specified by:

get­Medium­Note in interface Medium

Returns:

description of other limitations for using the medium, or null.

setMediumNote

public void setMediumNote(InternationalString newValue)

Sets a description of other limitations or requirements for using the medium.

Parameters:

new­Value - the new medium note.

getIdentifier

@UML(identifier="identifier",
     obligation=OPTIONAL,
     specification=ISO_19115)
public Identifier getIdentifier()

Returns a unique identifier for an instance of the medium.

Overrides:

get­Identifier in class ISOMetadata

Returns:

unique identifier, or null if none.

Since:

0.5

setIdentifier

public void setIdentifier(Identifier newValue)

Sets a unique identifier for an instance of the medium.

Overrides:

set­Identifier in class ISOMetadata

Parameters:

new­Value - the new identifier.

Since:

0.5