Class DefaultInstrument
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.DefaultInstrument
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.acquisition.Instrument
public class DefaultInstrument
extends ISOMetadata
implements org.opengis.metadata.acquisition.Instrument
Designations for the measuring instruments.
The following properties are mandatory in a well-formed metadata according ISO 19115:
MI_Instrument
├─identifier……
Unique identification of the instrument.
│ └─code…………
Alphanumeric value identifying an instance in the namespace.
└─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 Collection<org.opengis.metadata.citation.Citation>
Complete citation of the instrument.private org.opengis.util.InternationalString
Textual description of the instrument.private org.opengis.metadata.acquisition.Platform
Platform on which the instrument is mounted.private static final long
Serial number for inter-operability with different versions.private org.opengis.util.InternationalString
Name of the type of instrument.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty instrument.DefaultInstrument
(org.opengis.metadata.acquisition.Instrument object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultInstrument
castOrCopy
(org.opengis.metadata.acquisition.Instrument object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Collection<org.opengis.metadata.citation.Citation>
Returns the complete citation of the instrument.org.opengis.util.InternationalString
Returns the textual description of the instrument.org.opengis.metadata.Identifier
Returns the unique identification of the instrument.org.opengis.metadata.acquisition.Platform
Returns the platform on which the instrument is mounted.org.opengis.util.InternationalString
getType()
Returns the name of the type of instrument.void
setCitations
(Collection<? extends org.opengis.metadata.citation.Citation> newValues) Sets the complete citation of the instrument.void
setDescription
(org.opengis.util.InternationalString newValue) Sets the textual description of the instrument.void
setIdentifier
(org.opengis.metadata.Identifier newValue) Sets the unique identification of the instrument.void
setMountedOn
(org.opengis.metadata.acquisition.Platform newValue) Sets the platform on which the instrument is mounted.void
setType
(org.opengis.util.InternationalString newValue) Sets the name of the type of instrument.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:
-
citations
Complete citation of the instrument. -
type
private org.opengis.util.InternationalString typeName of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame. -
description
private org.opengis.util.InternationalString descriptionTextual description of the instrument. -
mountedOn
private org.opengis.metadata.acquisition.Platform mountedOnPlatform on which the instrument is mounted.
-
-
Constructor Details
-
DefaultInstrument
public DefaultInstrument()Constructs an initially empty instrument. -
DefaultInstrument
public DefaultInstrument(org.opengis.metadata.acquisition.Instrument 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
DefaultInstrument
, then it is returned unchanged. - Otherwise a new
DefaultInstrument
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
-
getCitations
Returns the complete citation of the instrument.- Specified by:
getCitations
in interfaceorg.opengis.metadata.acquisition.Instrument
- Returns:
- complete citation of the instrument.
-
setCitations
Sets the complete citation of the instrument.- Parameters:
newValues
- the new citation values.
-
getIdentifier
public org.opengis.metadata.Identifier getIdentifier()Returns the unique identification of the instrument.- Specified by:
getIdentifier
in interfaceorg.opengis.metadata.acquisition.Instrument
- Overrides:
getIdentifier
in classISOMetadata
- Returns:
- unique identification of the instrument, or
null
.
-
setIdentifier
public void setIdentifier(org.opengis.metadata.Identifier newValue) Sets the unique identification of the instrument.- Overrides:
setIdentifier
in classISOMetadata
- Parameters:
newValue
- the new identifier value.
-
getType
public org.opengis.util.InternationalString getType()Returns the name of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame.- Specified by:
getType
in interfaceorg.opengis.metadata.acquisition.Instrument
- Returns:
- type of instrument, or
null
.
-
setType
public void setType(org.opengis.util.InternationalString newValue) Sets the name of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame.- Parameters:
newValue
- the new type value.
-
getDescription
public org.opengis.util.InternationalString getDescription()Returns the textual description of the instrument.null
if unspecified.- Specified by:
getDescription
in interfaceorg.opengis.metadata.acquisition.Instrument
- Returns:
- textual description, or
null
.
-
setDescription
public void setDescription(org.opengis.util.InternationalString newValue) Sets the textual description of the instrument.- Parameters:
newValue
- the new description value.
-
getMountedOn
public org.opengis.metadata.acquisition.Platform getMountedOn()Returns the platform on which the instrument is mounted.null
if unspecified.- Specified by:
getMountedOn
in interfaceorg.opengis.metadata.acquisition.Instrument
- Returns:
- platform on which the instrument is mounted, or
null
.
-
setMountedOn
public void setMountedOn(org.opengis.metadata.acquisition.Platform newValue) Sets the platform on which the instrument is mounted.- Parameters:
newValue
- the new platform value.
-