Class DefaultPlatform

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultPlatform

All Implemented Interfaces:

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

@TitleProperty(name="citation")
public class DefaultPlatform
extends ISOMetadata
implements Platform

Designation of the platform used to acquire the dataset. The following properties are mandatory in a well-formed metadata according ISO 19115:

MI_Platform ├─identifier……………… Unique identification of the platform. │ └─code…………………… Alphanumeric value identifying an instance in the namespace. ├─description…………… Narrative description of the platform supporting the instrument. └─instrument……………… Instrument(s) mounted on a platform. ├─identifier…… Unique identification of the instrument. └─type…………………… Name of the type of instrument.

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

Method Summary

Modifier and Type	Method	Description
static Default­Platform	cast­Or­Copy(Platform object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Citation	get­Citation()	Returns the source where information about the platform is described.
International­String	get­Description()	Gets the narrative description of the platform supporting the instrument.
Identifier	get­Identifier()	Returns the unique identification of the platform.
Collection<Instrument>	get­Instruments()	Gets the instrument(s) mounted on a platform.
Collection<Responsible­Party>	get­Sponsors()	Returns the organization responsible for building, launch, or operation of the platform.
void	set­Citation(Citation new­Value)	Sets the source where information about the platform is described.
void	set­Description(International­String new­Value)	Sets the narrative description of the platform supporting the instrument.
void	set­Identifier(Identifier new­Value)	Sets the unique identification of the platform.
void	set­Instruments(Collection<? extends Instrument> new­Values)	Sets the instrument(s) mounted on a platform.
void	set­Sponsors(Collection<? extends Responsible­Party> new­Values)	Sets the organization responsible for building, launch, or operation of the platform.

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

DefaultPlatform

public DefaultPlatform()

Constructs an initially empty platform.

DefaultPlatform

public DefaultPlatform(Platform 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.

Parameters:

object - the metadata to copy values from, or null if none.

See Also:

• cast­Or­Copy(Platform)

Method Details

castOrCopy

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

getCitation

public Citation getCitation()

Returns the source where information about the platform is described. null if unspecified.

Specified by:

get­Citation in interface Platform

Returns:

source where information about the platform is described, or null.

setCitation

public void setCitation(Citation newValue)

Sets the source where information about the platform is described.

Parameters:

new­Value - the new citation value.

getIdentifier

public Identifier getIdentifier()

Returns the unique identification of the platform.

Specified by:

get­Identifier in interface Platform

Overrides:

get­Identifier in class ISOMetadata

Returns:

unique identification of the platform, or null.

setIdentifier

public void setIdentifier(Identifier newValue)

Sets the unique identification of the platform.

Overrides:

set­Identifier in class ISOMetadata

Parameters:

new­Value - the new identifier value.

getDescription

public InternationalString getDescription()

Gets the narrative description of the platform supporting the instrument.

Specified by:

get­Description in interface Platform

Returns:

narrative description of the platform, or null.

setDescription

public void setDescription(InternationalString newValue)

Sets the narrative description of the platform supporting the instrument.

Parameters:

new­Value - the new description value.

getSponsors

public Collection<ResponsibleParty> getSponsors()

Returns the organization responsible for building, launch, or operation of the platform.

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change will be tentatively applied in GeoAPI 4.0.

Specified by:

get­Sponsors in interface Platform

Returns:

organization responsible for building, launch, or operation of the platform.

setSponsors

public void setSponsors(Collection<? extends ResponsibleParty> newValues)

Sets the organization responsible for building, launch, or operation of the platform.

Upcoming API change — generalization
As of ISO 19115:2014, Responsible­Party is replaced by the Responsibility parent interface. This change will be tentatively applied in GeoAPI 4.0.

Parameters:

new­Values - the new sponsors values;

getInstruments

public Collection<Instrument> getInstruments()

Gets the instrument(s) mounted on a platform.

Specified by:

get­Instruments in interface Platform

Returns:

instrument(s) mounted on a platform.

setInstruments

public void setInstruments(Collection<? extends Instrument> newValues)

Sets the instrument(s) mounted on a platform.

Parameters:

new­Values - the new instruments values.