Class DefaultPlatform
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.acquisition.DefaultPlatform
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.acquisition.Platform
public class DefaultPlatform
extends ISOMetadata
implements org.opengis.metadata.acquisition.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
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.metadata.citation.Citation
Source where information about the platform is described.private org.opengis.util.InternationalString
Narrative description of the platform supporting the instrument.private Collection
<org.opengis.metadata.acquisition.Instrument> Instrument(s) mounted on a platform.private static final long
Serial number for inter-operability with different versions.private Collection
<org.opengis.metadata.citation.ResponsibleParty> Organization responsible for building, launch, or operation of the platform.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty platform.DefaultPlatform
(org.opengis.metadata.acquisition.Platform object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultPlatform
castOrCopy
(org.opengis.metadata.acquisition.Platform object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.metadata.citation.Citation
Returns the source where information about the platform is described.org.opengis.util.InternationalString
Gets the narrative description of the platform supporting the instrument.org.opengis.metadata.Identifier
Returns the unique identification of the platform.Collection
<org.opengis.metadata.acquisition.Instrument> Gets the instrument(s) mounted on a platform.Collection
<org.opengis.metadata.citation.ResponsibleParty> Returns the organization responsible for building, launch, or operation of the platform.void
setCitation
(org.opengis.metadata.citation.Citation newValue) Sets the source where information about the platform is described.void
setDescription
(org.opengis.util.InternationalString newValue) Sets the narrative description of the platform supporting the instrument.void
setIdentifier
(org.opengis.metadata.Identifier newValue) Sets the unique identification of the platform.void
setInstruments
(Collection<? extends org.opengis.metadata.acquisition.Instrument> newValues) Sets the instrument(s) mounted on a platform.void
setSponsors
(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the organization responsible for building, launch, or operation of the platform.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifierMap, getIdentifiers, getStandard, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
citation
private org.opengis.metadata.citation.Citation citationSource where information about the platform is described. -
description
private org.opengis.util.InternationalString descriptionNarrative description of the platform supporting the instrument. -
sponsors
Organization responsible for building, launch, or operation of the platform. -
instruments
Instrument(s) mounted on a platform.
-
-
Constructor Details
-
DefaultPlatform
public DefaultPlatform()Constructs an initially empty platform. -
DefaultPlatform
public DefaultPlatform(org.opengis.metadata.acquisition.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, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull
. - Otherwise if the given object is already an instance of
DefaultPlatform
, then it is returned unchanged. - Otherwise a new
DefaultPlatform
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, ornull
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.
- If the given object is
-
getCitation
public org.opengis.metadata.citation.Citation getCitation()Returns the source where information about the platform is described.null
if unspecified.- Specified by:
getCitation
in interfaceorg.opengis.metadata.acquisition.Platform
- Returns:
- source where information about the platform is described, or
null
.
-
setCitation
public void setCitation(org.opengis.metadata.citation.Citation newValue) Sets the source where information about the platform is described.- Parameters:
newValue
- the new citation value.
-
getIdentifier
public org.opengis.metadata.Identifier getIdentifier()Returns the unique identification of the platform.- Specified by:
getIdentifier
in interfaceorg.opengis.metadata.acquisition.Platform
- Overrides:
getIdentifier
in classISOMetadata
- Returns:
- unique identification of the platform, or
null
.
-
setIdentifier
public void setIdentifier(org.opengis.metadata.Identifier newValue) Sets the unique identification of the platform.- Overrides:
setIdentifier
in classISOMetadata
- Parameters:
newValue
- the new identifier value.
-
getDescription
public org.opengis.util.InternationalString getDescription()Gets the narrative description of the platform supporting the instrument.- Specified by:
getDescription
in interfaceorg.opengis.metadata.acquisition.Platform
- Returns:
- narrative description of the platform, or
null
.
-
setDescription
public void setDescription(org.opengis.util.InternationalString newValue) Sets the narrative description of the platform supporting the instrument.- Parameters:
newValue
- the new description value.
-
getSponsors
Returns the organization responsible for building, launch, or operation of the platform.Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change will be tentatively applied in GeoAPI 4.0.- Specified by:
getSponsors
in interfaceorg.opengis.metadata.acquisition.Platform
- Returns:
- organization responsible for building, launch, or operation of the platform.
-
setSponsors
public void setSponsors(Collection<? extends org.opengis.metadata.citation.ResponsibleParty> newValues) Sets the organization responsible for building, launch, or operation of the platform.Upcoming API change — generalization
As of ISO 19115:2014,ResponsibleParty
is replaced by theResponsibility
parent interface. This change will be tentatively applied in GeoAPI 4.0.- Parameters:
newValues
- the new sponsors values;
-
getInstruments
Gets the instrument(s) mounted on a platform.- Specified by:
getInstruments
in interfaceorg.opengis.metadata.acquisition.Platform
- Returns:
- instrument(s) mounted on a platform.
-
setInstruments
public void setInstruments(Collection<? extends org.opengis.metadata.acquisition.Instrument> newValues) Sets the instrument(s) mounted on a platform.- Parameters:
newValues
- the new instruments values.
-