Module org.apache.sis.metadata
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State -
Field Summary
Fields inherited from class ISOMetadata
identifiers -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty instrument.DefaultInstrument(Instrument object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier 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 ISOMetadata
getIdentifierMap, getIdentifiers, getStandard, transitionToMethods inherited from class ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Constructor Details
-
DefaultInstrument
public DefaultInstrument()Constructs an initially empty instrument. -
DefaultInstrument
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, ornullif 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
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, ornullif 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
-
getCitations
Returns the complete citation of the instrument.- Specified by:
getCitationsin interfaceInstrument- Returns:
- complete citation of the instrument.
-
setCitations
Sets the complete citation of the instrument.- Parameters:
newValues- the new citation values.
-
getIdentifier
Returns the unique identification of the instrument.- Specified by:
getIdentifierin interfaceInstrument- Overrides:
getIdentifierin classISOMetadata- Returns:
- unique identification of the instrument, or
null.
-
setIdentifier
Sets the unique identification of the instrument.- Overrides:
setIdentifierin classISOMetadata- Parameters:
newValue- the new identifier value.
-
getType
Returns the name of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame.- Specified by:
getTypein interfaceInstrument- Returns:
- type of instrument, or
null.
-
setType
Sets the name of the type of instrument. Examples: framing, line-scan, push-broom, pan-frame.- Parameters:
newValue- the new type value.
-
getDescription
Returns the textual description of the instrument.nullif unspecified.- Specified by:
getDescriptionin interfaceInstrument- Returns:
- textual description, or
null.
-
setDescription
Sets the textual description of the instrument.- Parameters:
newValue- the new description value.
-
getMountedOn
Returns the platform on which the instrument is mounted.nullif unspecified.- Specified by:
getMountedOnin interfaceInstrument- Returns:
- platform on which the instrument is mounted, or
null.
-
setMountedOn
Sets the platform on which the instrument is mounted.- Parameters:
newValue- the new platform value.
-