Class DefaultInstrument

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultInstrument

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Instrument

@TitleProperty(name="identifier")
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

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static Default­Instrument	cast­Or­Copy(Instrument object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Citation>	get­Citations()	Returns the complete citation of the instrument.
International­String	get­Description()	Returns the textual description of the instrument.
Identifier	get­Identifier()	Returns the unique identification of the instrument.
Platform	get­Mounted­On()	Returns the platform on which the instrument is mounted.
International­String	get­Type()	Returns the name of the type of instrument.
void	set­Citations(Collection<? extends Citation> new­Values)	Sets the complete citation of the instrument.
void	set­Description(International­String new­Value)	Sets the textual description of the instrument.
void	set­Identifier(Identifier new­Value)	Sets the unique identification of the instrument.
void	set­Mounted­On(Platform new­Value)	Sets the platform on which the instrument is mounted.
void	set­Type(International­String new­Value)	Sets the name of the type of instrument.

Methods inherited from class ISOMetadata

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

Modifier and Type	Method	Description
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

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

Constructor Details

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, because 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 Details

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, because 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

Overrides:

get­Identifier in class ISOMetadata

Returns:

unique identification of the instrument, or null.

setIdentifier

public void setIdentifier(Identifier newValue)

Sets the unique identification of the instrument.

Overrides:

set­Identifier in class ISOMetadata

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.