Class DefaultInstrument
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultInstrument
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty instrument.DefaultInstrument(Instrument object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultInstrumentcastOrCopy(Instrument object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the complete citation of the instrument.Returns the textual description of the instrument.Returns the unique identification of the instrument.Returns the platform on which the instrument is mounted.getType()Returns the name of the type of instrument.voidsetCitations(Collection<? extends Citation> newValues) Sets the complete citation of the instrument.voidsetDescription(InternationalString newValue) Sets the textual description of the instrument.voidsetIdentifier(Identifier newValue) Sets the unique identification of the instrument.voidsetMountedOn(Platform newValue) Sets the platform on which the instrument is mounted.voidsetType(InternationalString newValue) Sets the name of the type of instrument.Methods inherited from class ISOMetadatagetIdentifierMap, getIdentifiers, getStandard, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultInstrumentpublic DefaultInstrument()Constructs an initially empty instrument.
- 
DefaultInstrumentConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 DefaultInstrumentinstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getCitationsReturns the complete citation of the instrument.- Specified by:
- getCitationsin interface- Instrument
- Returns:
- complete citation of the instrument.
 
- 
setCitationsSets the complete citation of the instrument.- Parameters:
- newValues- the new citation values.
 
- 
getIdentifierReturns the unique identification of the instrument.- Specified by:
- getIdentifierin interface- Instrument
- Overrides:
- getIdentifierin class- ISOMetadata
- Returns:
- unique identification of the instrument, or null.
 
- 
setIdentifierSets the unique identification of the instrument.- Overrides:
- setIdentifierin class- ISOMetadata
- Parameters:
- newValue- the new identifier value.
 
- 
getTypeReturns the name of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame.- Specified by:
- getTypein interface- Instrument
- Returns:
- type of instrument, or null.
 
- 
setTypeSets the name of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame.- Parameters:
- newValue- the new type value.
 
- 
getDescriptionReturns the textual description of the instrument.nullif unspecified.- Specified by:
- getDescriptionin interface- Instrument
- Returns:
- textual description, or null.
 
- 
setDescriptionSets the textual description of the instrument.- Parameters:
- newValue- the new description value.
 
- 
getMountedOnReturns the platform on which the instrument is mounted.nullif unspecified.- Specified by:
- getMountedOnin interface- Instrument
- Returns:
- platform on which the instrument is mounted, or null.
 
- 
setMountedOnSets the platform on which the instrument is mounted.- Parameters:
- newValue- the new platform value.
 
 
-