Class DefaultOperation

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultOperation

All Implemented Interfaces:

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

@TitleProperty(name="identifier")
public class DefaultOperation
extends ISOMetadata
implements Operation

Designations for the operation used to acquire the dataset. The following properties are mandatory in a well-formed metadata according ISO 19115:

MI_Operation ├─identifier………………… Unique identification of the operation. │ └─code……………………… Alphanumeric value identifying an instance in the namespace. ├─status…………………………… Status of the data acquisition. └─parent­Operation…… Heritage of the operation.

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

Method Summary

Modifier and Type	Method	Description
static Default­Operation	cast­Or­Copy(Operation object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Operation>	get­Child­Operations()	Returns the sub-missions that make up part of a larger mission.
Citation	get­Citation()	Returns the identification of the mission.
International­String	get­Description()	Returns the description of the mission on which the platform observations are made and the objectives of that mission.
Identifier	get­Identifier()	Returns the unique identification of the operation.
Collection<Objective>	get­Objectives()	Returns object(s) or area(s) of interest to be sensed.
Operation	get­Parent­Operation()	Returns the heritage of the operation.
Plan	get­Plan()	Returns the plan satisfied by the operation.
Collection<Platform>	get­Platforms()	Returns the platform (or platforms) used in the operation.
Collection<Event>	get­Significant­Events()	Returns the record of an event occurring during an operation.
Progress	get­Status()	Returns the status of the data acquisition.
Operation­Type	get­Type()	Returns the collection technique for the operation.
void	set­Child­Operations(Collection<? extends Operation> new­Values)	Sets the sub-missions that make up part of a larger mission.
void	set­Citation(Citation new­Value)	Sets the identification of the mission.
void	set­Description(International­String new­Value)	Sets the description of the mission on which the platform observations are made and the objectives of that mission.
void	set­Identifier(Identifier new­Value)	Sets the unique identification of the operation.
void	set­Objectives(Collection<? extends Objective> new­Values)	Sets Object(s) or area(s) of interest to be sensed.
void	set­Parent­Operation(Operation new­Value)	Sets the heritage of the operation.
void	set­Plan(Plan new­Value)	Sets the plan satisfied by the operation.
void	set­Platforms(Collection<? extends Platform> new­Values)	Sets the platform (or platforms) used in the operation.
void	set­Significant­Events(Collection<? extends Event> new­Values)	Sets the record of an event occurring during an operation.
void	set­Status(Progress new­Value)	Sets the status of the data acquisition.
void	set­Type(Operation­Type new­Value)	Sets the collection technique for the operation.

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

DefaultOperation

public DefaultOperation()

Constructs an initially empty operation.

DefaultOperation

public DefaultOperation(Operation 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(Operation)

Method Details

castOrCopy

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

getDescription

public InternationalString getDescription()

Returns the description of the mission on which the platform observations are made and the objectives of that mission. null if unspecified.

Specified by:

get­Description in interface Operation

Returns:

description of the mission, or null.

setDescription

public void setDescription(InternationalString newValue)

Sets the description of the mission on which the platform observations are made and the objectives of that mission.

Parameters:

new­Value - the new description value.

getCitation

public Citation getCitation()

Returns the identification of the mission. null if unspecified.

Specified by:

get­Citation in interface Operation

Returns:

identification of the mission, or null.

setCitation

public void setCitation(Citation newValue)

Sets the identification of the mission.

Parameters:

new­Value - the new citation value.

getIdentifier

public Identifier getIdentifier()

Returns the unique identification of the operation.

Specified by:

get­Identifier in interface Operation

Overrides:

get­Identifier in class ISOMetadata

Returns:

unique identification of the operation, or null.

setIdentifier

public void setIdentifier(Identifier newValue)

Sets the unique identification of the operation.

Overrides:

set­Identifier in class ISOMetadata

Parameters:

new­Value - the new identifier value.

getStatus

public Progress getStatus()

Returns the status of the data acquisition.

Specified by:

get­Status in interface Operation

Returns:

status of the data acquisition, or null.

setStatus

public void setStatus(Progress newValue)

Sets the status of the data acquisition.

Parameters:

new­Value - the new status value.

getType

public OperationType getType()

Returns the collection technique for the operation.

Specified by:

get­Type in interface Operation

Returns:

collection technique for the operation, or null.

setType

public void setType(OperationType newValue)

Sets the collection technique for the operation.

Parameters:

new­Value - the new type value.

getChildOperations

public Collection<Operation> getChildOperations()

Returns the sub-missions that make up part of a larger mission.

Specified by:

get­Child­Operations in interface Operation

Returns:

sub-missions.

setChildOperations

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

Sets the sub-missions that make up part of a larger mission.

Parameters:

new­Values - the new child operations values.

getObjectives

public Collection<Objective> getObjectives()

Returns object(s) or area(s) of interest to be sensed.

Specified by:

get­Objectives in interface Operation

Returns:

object(s) or area(s) of interest.

setObjectives

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

Sets Object(s) or area(s) of interest to be sensed.

Parameters:

new­Values - the new objectives values.

getParentOperation

public Operation getParentOperation()

Returns the heritage of the operation.

Specified by:

get­Parent­Operation in interface Operation

Returns:

heritage of the operation, or null.

setParentOperation

public void setParentOperation(Operation newValue)

Sets the heritage of the operation.

Parameters:

new­Value - the new parent operation value.

getPlan

public Plan getPlan()

Returns the plan satisfied by the operation.

Specified by:

get­Plan in interface Operation

Returns:

plan satisfied by the operation, or null.

setPlan

public void setPlan(Plan newValue)

Sets the plan satisfied by the operation.

Parameters:

new­Value - the new plan value.

getPlatforms

public Collection<Platform> getPlatforms()

Returns the platform (or platforms) used in the operation.

Specified by:

get­Platforms in interface Operation

Returns:

platforms used in the operation.

setPlatforms

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

Sets the platform (or platforms) used in the operation.

Parameters:

new­Values - the new platforms values.

getSignificantEvents

public Collection<Event> getSignificantEvents()

Returns the record of an event occurring during an operation.

Specified by:

get­Significant­Events in interface Operation

Returns:

record of an event occurring during an operation.

setSignificantEvents

public void setSignificantEvents(Collection<? extends Event> newValues)

Sets the record of an event occurring during an operation.

Parameters:

new­Values - the new significant events value.