Class DefaultAcquisitionInformation

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultAcquisitionInformation

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Acquisition­Information

public class DefaultAcquisitionInformation
extends ISOMetadata
implements AcquisitionInformation

Designations for the measuring instruments, the platform carrying them, and the mission to which the data contributes.

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­Acquisition­Information()	Constructs an initially empty acquisition information.
Default­Acquisition­Information(Acquisition­Information object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Acquisition­Information	cast­Or­Copy(Acquisition­Information object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Plan>	get­Acquisition­Plans()	Returns the plan as implemented by the acquisition.
Collection<Requirement>	get­Acquisition­Requirements()	Returns the requirement the data acquisition intends to satisfy.
Environmental­Record	get­Environmental­Conditions()	Returns a record of the environmental circumstances during the data acquisition.
Collection<Instrument>	get­Instruments()	Returns the general information about the instrument used in data acquisition.
Collection<Objective>	get­Objectives()	Returns the area or object to be sensed.
Collection<Operation>	get­Operations()	Returns the general information about an identifiable activity which provided the data.
Collection<Platform>	get­Platforms()	Returns the general information about the platform from which the data were taken.
void	set­Acquisition­Plans(Collection<? extends Plan> new­Values)	Sets the plan as implemented by the acquisition.
void	set­Acquisition­Requirements(Collection<? extends Requirement> new­Values)	Sets the requirement the data acquisition intends to satisfy.
void	set­Environmental­Conditions(Environmental­Record new­Value)	Sets the record of the environmental circumstances during the data acquisition.
void	set­Instruments(Collection<? extends Instrument> new­Values)	Sets the general information about the instrument used in data acquisition.
void	set­Objectives(Collection<? extends Objective> new­Values)	Sets the area or object to be sensed.
void	set­Operations(Collection<? extends Operation> new­Values)	Sets the general information about an identifiable activity which provided the data.
void	set­Platforms(Collection<? extends Platform> new­Values)	Sets the general information about the platform from which the data were taken.

Methods inherited from class ISOMetadata

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

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
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.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

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

DefaultAcquisitionInformation

public DefaultAcquisitionInformation()

Constructs an initially empty acquisition information.

DefaultAcquisitionInformation

public DefaultAcquisitionInformation(AcquisitionInformation 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(Acquisition­Information)

Method Details

castOrCopy

public static DefaultAcquisitionInformation castOrCopy(AcquisitionInformation 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­Acquisition­Information, then it is returned unchanged.
• Otherwise a new Default­Acquisition­Information 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.

getAcquisitionPlans

public Collection<Plan> getAcquisitionPlans()

Returns the plan as implemented by the acquisition.

Specified by:

get­Acquisition­Plans in interface Acquisition­Information

Returns:

plan as implemented by the acquisition.

setAcquisitionPlans

public void setAcquisitionPlans(Collection<? extends Plan> newValues)

Sets the plan as implemented by the acquisition.

Parameters:

new­Values - the new plan values.

getAcquisitionRequirements

public Collection<Requirement> getAcquisitionRequirements()

Returns the requirement the data acquisition intends to satisfy.

Specified by:

get­Acquisition­Requirements in interface Acquisition­Information

Returns:

requirement the data acquisition intends to satisfy.

setAcquisitionRequirements

public void setAcquisitionRequirements(Collection<? extends Requirement> newValues)

Sets the requirement the data acquisition intends to satisfy.

Parameters:

new­Values - the new acquisition requirements values.

getEnvironmentalConditions

public EnvironmentalRecord getEnvironmentalConditions()

Returns a record of the environmental circumstances during the data acquisition. null if unspecified.

Specified by:

get­Environmental­Conditions in interface Acquisition­Information

Returns:

record of the environmental circumstances, or null.

setEnvironmentalConditions

public void setEnvironmentalConditions(EnvironmentalRecord newValue)

Sets the record of the environmental circumstances during the data acquisition.

Parameters:

new­Value - the new environmental record value.

getInstruments

public Collection<Instrument> getInstruments()

Returns the general information about the instrument used in data acquisition.

Specified by:

get­Instruments in interface Acquisition­Information

Returns:

instrument used in data acquisition.

setInstruments

public void setInstruments(Collection<? extends Instrument> newValues)

Sets the general information about the instrument used in data acquisition.

Parameters:

new­Values - the new instruments values.

getObjectives

public Collection<Objective> getObjectives()

Returns the area or object to be sensed.

Specified by:

get­Objectives in interface Acquisition­Information

Returns:

area or object to be sensed.

setObjectives

public void setObjectives(Collection<? extends Objective> newValues)

Sets the area or object to be sensed.

Parameters:

new­Values - the new objectives values.

getOperations

public Collection<Operation> getOperations()

Returns the general information about an identifiable activity which provided the data.

Specified by:

get­Operations in interface Acquisition­Information

Returns:

identifiable activity which provided the data.

setOperations

public void setOperations(Collection<? extends Operation> newValues)

Sets the general information about an identifiable activity which provided the data.

Parameters:

new­Values - the new operations values.

getPlatforms

public Collection<Platform> getPlatforms()

Returns the general information about the platform from which the data were taken.

Specified by:

get­Platforms in interface Acquisition­Information

Returns:

platform from which the data were taken.

setPlatforms

public void setPlatforms(Collection<? extends Platform> newValues)

Sets the general information about the platform from which the data were taken.

Parameters:

new­Values - the new platforms values.