org.apache.sis.metadata.iso.acquisition

Class DefaultInstrument

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultInstrument

All Implemented Interfaces:

Serializable, Cloneable, Emptiable, LenientComparable, IdentifiedObject, Instrument

public class DefaultInstrument
extends ISOMetadata
implements 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

See Also:

Serialized Form

Defined in the sis-metadata module

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor and Description
DefaultInstrument() Constructs an initially empty instrument.
DefaultInstrument(Instrument object) Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method and Description
static DefaultInstrument	castOrCopy(Instrument object) Returns a SIS metadata implementation with the values of 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 ISOMetadata

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

Methods inherited from class ModifiableMetadata

check­Write­Permission, clone, collection­Type, copy­Collection, copy­List, copy­Set, is­Modifiable, non­Null­Collection, non­Null­List, non­Null­Set, singleton, unmodifiable, write­Collection, write­List, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Detail

DefaultInstrument

public DefaultInstrument()

Constructs an initially empty instrument.

DefaultInstrument

public DefaultInstrument(Instrument object)

Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since 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(Instrument)

Method Detail

castOrCopy

public static DefaultInstrument castOrCopy(Instrument 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­Instrument, then it is returned unchanged.
• Otherwise a new Default­Instrument instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since 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.

getCitations

public Collection<Citation> getCitations()

Returns the complete citation of the instrument.

Specified by:

get­Citations in interface Instrument

Returns:

complete citation of the instrument.

setCitations

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

Sets the complete citation of the instrument.

Parameters:

new­Values - the new citation values.

getIdentifier

public Identifier getIdentifier()

Returns the unique identification of the instrument.

Specified by:

get­Identifier in interface Instrument

Returns:

unique identification of the instrument, or null.

setIdentifier

public void setIdentifier(Identifier newValue)

Sets the unique identification of the instrument.

Parameters:

new­Value - 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:

get­Type in interface Instrument

Returns:

type of instrument, or null.

setType

public void setType(InternationalString newValue)

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

Parameters:

new­Value - the new type value.

getDescription

public InternationalString getDescription()

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

Specified by:

get­Description in interface Instrument

Returns:

textual description, or null.

setDescription

public void setDescription(InternationalString newValue)

Sets the textual description of the instrument.

Parameters:

new­Value - the new description value.

getMountedOn

public Platform getMountedOn()

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

Specified by:

get­Mounted­On in interface Instrument

Returns:

platform on which the instrument is mounted, or null.

setMountedOn

public void setMountedOn(Platform newValue)

Sets the platform on which the instrument is mounted.

Parameters:

new­Value - the new platform value.