Class DefaultObjective

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultObjective

All Implemented Interfaces:

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

public class DefaultObjective
extends ISOMetadata
implements Objective

Describes the characteristics, spatial and temporal extent of the intended object to be observed. The following properties are mandatory in a well-formed metadata according ISO 19115:

MI_Objective ├─identifier………………………… Code used to identify the objective. │ └─code……………………………… Alphanumeric value identifying an instance in the namespace. └─objective­Occurrence… Event or events associated with objective completion. ├─identifier……………… Event name or number. │ └─code…………………… Alphanumeric value identifying an instance in the namespace. ├─trigger……………………… Initiator of the event. ├─context……………………… Meaning of the event. ├─sequence…………………… Relative time ordering of the event. └─time……………………………… Time the event occurred.

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

Method Summary

Modifier and Type	Method	Description
static Default­Objective	cast­Or­Copy(Objective object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Collection<Extent>	get­Extents()	Returns the extent information including the bounding box, bounding polygon, vertical and temporal extent of the objective.
Collection<International­String>	get­Functions()	Returns the role or purpose performed by or activity performed at the objective.
Collection<Identifier>	get­Identifiers()	Returns the code used to identify the objective.
Collection<Event>	get­Objective­Occurences()	Returns the event or events associated with objective completion.
Collection<Platform­Pass>	get­Pass()	Returns the pass of the platform over the objective.
International­String	get­Priority()	Returns the priority applied to the target.
Collection<Instrument>	get­Sensing­Instruments()	Returns the instrument which senses the objective data.
Collection<Objective­Type>	get­Types()	Returns the collection technique for the objective.
void	set­Extents(Collection<? extends Extent> new­Values)	Sets the extent information including the bounding box, bounding polygon, vertical and temporal extent of the objective.
void	set­Functions(Collection<? extends International­String> new­Values)	Sets the role or purpose performed by or activity performed at the objective.
void	set­Identifiers(Collection<? extends Identifier> new­Values)	Sets the code used to identify the objective.
void	set­Objective­Occurences(Collection<? extends Event> new­Values)	Sets the event or events associated with objective completion.
void	set­Pass(Collection<? extends Platform­Pass> new­Values)	Sets the pass of the platform over the objective.
void	set­Priority(International­String new­Value)	Sets the priority applied to the target.
void	set­Sensing­Instruments(Collection<? extends Instrument> new­Values)	Sets the instrument which senses the objective data.
void	set­Types(Collection<? extends Objective­Type> new­Values)	Sets the collection technique for the objective.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, 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.
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

DefaultObjective

public DefaultObjective()

Constructs an initially empty objective.

DefaultObjective

public DefaultObjective(Objective 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(Objective)

Method Details

castOrCopy

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

getIdentifiers

public Collection<Identifier> getIdentifiers()

Returns the code used to identify the objective.

Unified identifiers view

In this SIS implementation, the collection returned by this method includes the XML identifiers (ID, UUID, etc.), thus providing a unified view of every kind of identifiers associated with this objective.

XML marshalling note

The <mac:identifier> element marshalled to XML will exclude all the above cited identifiers, for compliance with ISO 19115 model. Those identifiers will appear in other XML elements or attributes.

Specified by:

get­Identifiers in interface Identified­Object

Specified by:

get­Identifiers in interface Objective

Overrides:

get­Identifiers in class ISOMetadata

Returns:

identification of the objective.

See Also:

• Default­Citation.get­Identifiers()
• get­Identifiers()
• Abstract­Identified­Object.get­Identifiers()

setIdentifiers

public void setIdentifiers(Collection<? extends Identifier> newValues)

Sets the code used to identify the objective.

XML identifiers (ID, UUID, etc.), are not affected by this method, unless they are explicitly provided in the given collection.

Parameters:

new­Values - the new identifiers values.

getPriority

public InternationalString getPriority()

Returns the priority applied to the target. null if unspecified.

Specified by:

get­Priority in interface Objective

Returns:

priority applied, or null.

setPriority

public void setPriority(InternationalString newValue)

Sets the priority applied to the target.

Parameters:

new­Value - the new priority value.

getTypes

public Collection<ObjectiveType> getTypes()

Returns the collection technique for the objective.

Specified by:

get­Types in interface Objective

Returns:

collection technique for the objective.

setTypes

public void setTypes(Collection<? extends ObjectiveType> newValues)

Sets the collection technique for the objective.

Parameters:

new­Values - the new types values.

getFunctions

public Collection<InternationalString> getFunctions()

Returns the role or purpose performed by or activity performed at the objective.

Specified by:

get­Functions in interface Objective

Returns:

role or purpose performed by or activity performed at the objective.

setFunctions

public void setFunctions(Collection<? extends InternationalString> newValues)

Sets the role or purpose performed by or activity performed at the objective.

Parameters:

new­Values - the new functions values.

getExtents

public Collection<Extent> getExtents()

Returns the extent information including the bounding box, bounding polygon, vertical and temporal extent of the objective.

Specified by:

get­Extents in interface Objective

Returns:

extent information.

setExtents

public void setExtents(Collection<? extends Extent> newValues)

Sets the extent information including the bounding box, bounding polygon, vertical and temporal extent of the objective.

Parameters:

new­Values - the new extents values.

getObjectiveOccurences

public Collection<Event> getObjectiveOccurences()

Returns the event or events associated with objective completion.

Upcoming API change
This method is misspelled (missing "r"). Its name may be fixed in GeoAPI 4.0.

Specified by:

get­Objective­Occurences in interface Objective

Returns:

events associated with objective completion.

setObjectiveOccurences

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

Sets the event or events associated with objective completion.

Upcoming API change
This method is misspelled (missing "r"). Its name may be fixed in GeoAPI 4.0.

Parameters:

new­Values - the new objective occurrences values.

getPass

public Collection<PlatformPass> getPass()

Returns the pass of the platform over the objective.

Specified by:

get­Pass in interface Objective

Returns:

pass of the platform.

setPass

public void setPass(Collection<? extends PlatformPass> newValues)

Sets the pass of the platform over the objective.

Parameters:

new­Values - the new pass values.

getSensingInstruments

public Collection<Instrument> getSensingInstruments()

Returns the instrument which senses the objective data.

Specified by:

get­Sensing­Instruments in interface Objective

Returns:

instrument which senses the objective data.

setSensingInstruments

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

Sets the instrument which senses the objective data.

Parameters:

new­Values - the new sensing instruments values.