org.geotoolkit.metadata.iso.acquisition
Class DefaultInstrument

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultInstrument

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Instrument

@ThreadSafe
public class DefaultInstrument
extends MetadataEntity
implements Instrument

Designations for the measuring instruments.

Since:

3.03

Version:

3.19

Author:

Cédric Briançon (Geomatys), Martin Desruisseaux (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultInstrument()
Constructs an initially empty instrument.

DefaultInstrument(Instrument source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultInstrument	castOrCopy(Instrument object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Collection<Citation>	getCitations() Returns the complete citation of the instrument.
InternationalString	getDescription() Returns the textual description of the instrument.
Identifier	getIdentifier() Returns the unique identification of the instrument.
Platform	getMountedOn() Returns the platform on which the instrument is mounted.
InternationalString	getType() Returns the name of the type of instrument.
void	setCitations(Collection<? extends Citation> newValues) Sets the complete citation of the instrument.
void	setDescription(InternationalString newValue) Sets the textual description of the instrument.
void	setIdentifier(Identifier newValue) Sets the unique identification of the instrument.
void	setMountedOn(Platform newValue) Sets the platform on which the instrument is mounted.
void	setType(InternationalString newValue) Sets the name of the type of instrument.

Methods inherited from class MetadataEntity

getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultInstrument

public DefaultInstrument()

Constructs an initially empty instrument.

DefaultInstrument

public DefaultInstrument(Instrument source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Method Detail

castOrCopy

public static DefaultInstrument castOrCopy(Instrument object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getCitations

public Collection<Citation> getCitations()

Returns the complete citation of the instrument.

Specified by:

getCitations in interface Instrument

setCitations

public void setCitations(Collection<? extends Citation> newValues)

Sets the complete citation of the instrument.

Parameters:

newValues - The new citation values.

getIdentifier

public Identifier getIdentifier()

Returns the unique identification of the instrument.

Specified by:

getIdentifier in interface Instrument

Overrides:

getIdentifier in class MetadataEntity

Returns:

The first ISO 19115 identifier, or null if none.

setIdentifier

public void setIdentifier(Identifier newValue)

Sets the unique identification of the instrument.

Parameters:

newValue - The new identifier value.

getType

public InternationalString getType()

Returns the name of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame.

Specified by:

getType in interface Instrument

setType

public void setType(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 InternationalString getDescription()

Returns the textual description of the instrument. null if unspecified.

Specified by:

getDescription in interface Instrument

setDescription

public void setDescription(InternationalString newValue)

Sets the textual description of the instrument.

Parameters:

newValue - The new description value.

getMountedOn

public Platform getMountedOn()

Returns the platform on which the instrument is mounted. null if unspecified.

Specified by:

getMountedOn in interface Instrument

setMountedOn

public void setMountedOn(Platform newValue)

Sets the platform on which the instrument is mounted.

Parameters:

newValue - The new platform value.