Class DefaultObjective
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.acquisition.DefaultObjective
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.acquisition.Objective
public class DefaultObjective
extends ISOMetadata
implements org.opengis.metadata.acquisition.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.
└─objectiveOccurrence…
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
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Collection
<org.opengis.metadata.extent.Extent> Extent information including the bounding box, bounding polygon, vertical and temporal extent of the objective.private Collection
<org.opengis.util.InternationalString> Role or purpose performed by or activity performed at the objective.private Collection
<org.opengis.metadata.acquisition.Event> Event or events associated with objective completion.private Collection
<org.opengis.metadata.acquisition.PlatformPass> Pass of the platform over the objective.private org.opengis.util.InternationalString
Priority applied to the target.private Collection
<org.opengis.metadata.acquisition.Instrument> Instrument which senses the objective data.private static final long
Serial number for inter-operability with different versions.private Collection
<org.opengis.metadata.acquisition.ObjectiveType> Collection technique for the objective.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty objective.DefaultObjective
(org.opengis.metadata.acquisition.Objective object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultObjective
castOrCopy
(org.opengis.metadata.acquisition.Objective object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Collection
<org.opengis.metadata.extent.Extent> Returns the extent information including the bounding box, bounding polygon, vertical and temporal extent of the objective.Collection
<org.opengis.util.InternationalString> Returns the role or purpose performed by or activity performed at the objective.Collection
<org.opengis.metadata.Identifier> Returns the code used to identify the objective.Collection
<org.opengis.metadata.acquisition.Event> Returns the event or events associated with objective completion.Collection
<org.opengis.metadata.acquisition.PlatformPass> getPass()
Returns the pass of the platform over the objective.org.opengis.util.InternationalString
Returns the priority applied to the target.Collection
<org.opengis.metadata.acquisition.Instrument> Returns the instrument which senses the objective data.Collection
<org.opengis.metadata.acquisition.ObjectiveType> getTypes()
Returns the collection technique for the objective.void
setExtents
(Collection<? extends org.opengis.metadata.extent.Extent> newValues) Sets the extent information including the bounding box, bounding polygon, vertical and temporal extent of the objective.void
setFunctions
(Collection<? extends org.opengis.util.InternationalString> newValues) Sets the role or purpose performed by or activity performed at the objective.void
setIdentifiers
(Collection<? extends org.opengis.metadata.Identifier> newValues) Sets the code used to identify the objective.void
setObjectiveOccurences
(Collection<? extends org.opengis.metadata.acquisition.Event> newValues) Sets the event or events associated with objective completion.void
setPass
(Collection<? extends org.opengis.metadata.acquisition.PlatformPass> newValues) Sets the pass of the platform over the objective.void
setPriority
(org.opengis.util.InternationalString newValue) Sets the priority applied to the target.void
setSensingInstruments
(Collection<? extends org.opengis.metadata.acquisition.Instrument> newValues) Sets the instrument which senses the objective data.void
setTypes
(Collection<? extends org.opengis.metadata.acquisition.ObjectiveType> newValues) Sets the collection technique for the objective.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
priority
private org.opengis.util.InternationalString priorityPriority applied to the target. -
types
Collection technique for the objective. -
functions
Role or purpose performed by or activity performed at the objective. -
extents
Extent information including the bounding box, bounding polygon, vertical and temporal extent of the objective. -
objectiveOccurences
Event or events associated with objective completion. -
pass
Pass of the platform over the objective. -
sensingInstruments
Instrument which senses the objective data.
-
-
Constructor Details
-
DefaultObjective
public DefaultObjective()Constructs an initially empty objective. -
DefaultObjective
public DefaultObjective(org.opengis.metadata.acquisition.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, ornull
if 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
DefaultObjective
, then it is returned unchanged. - Otherwise a new
DefaultObjective
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, ornull
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.
- If the given object is
-
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 to this objective.XML 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:
getIdentifiers
in interfaceIdentifiedObject
- Specified by:
getIdentifiers
in interfaceorg.opengis.metadata.acquisition.Objective
- Overrides:
getIdentifiers
in classISOMetadata
- Returns:
- identification of the objective.
- See Also:
-
setIdentifiers
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:
newValues
- the new identifiers values.
-
getPriority
public org.opengis.util.InternationalString getPriority()Returns the priority applied to the target.null
if unspecified.- Specified by:
getPriority
in interfaceorg.opengis.metadata.acquisition.Objective
- Returns:
- priority applied, or
null
.
-
setPriority
public void setPriority(org.opengis.util.InternationalString newValue) Sets the priority applied to the target.- Parameters:
newValue
- the new priority value.
-
getTypes
Returns the collection technique for the objective.- Specified by:
getTypes
in interfaceorg.opengis.metadata.acquisition.Objective
- Returns:
- collection technique for the objective.
-
setTypes
public void setTypes(Collection<? extends org.opengis.metadata.acquisition.ObjectiveType> newValues) Sets the collection technique for the objective.- Parameters:
newValues
- the new types values.
-
getFunctions
Returns the role or purpose performed by or activity performed at the objective.- Specified by:
getFunctions
in interfaceorg.opengis.metadata.acquisition.Objective
- Returns:
- role or purpose performed by or activity performed at the objective.
-
setFunctions
Sets the role or purpose performed by or activity performed at the objective.- Parameters:
newValues
- the new functions values.
-
getExtents
Returns the extent information including the bounding box, bounding polygon, vertical and temporal extent of the objective.- Specified by:
getExtents
in interfaceorg.opengis.metadata.acquisition.Objective
- Returns:
- extent information.
-
setExtents
Sets the extent information including the bounding box, bounding polygon, vertical and temporal extent of the objective.- Parameters:
newValues
- the new extents values.
-
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:
getObjectiveOccurences
in interfaceorg.opengis.metadata.acquisition.Objective
- Returns:
- events associated with objective completion.
-
setObjectiveOccurences
public void setObjectiveOccurences(Collection<? extends org.opengis.metadata.acquisition.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:
newValues
- the new objective occurrences values.
-
getPass
Returns the pass of the platform over the objective.- Specified by:
getPass
in interfaceorg.opengis.metadata.acquisition.Objective
- Returns:
- pass of the platform.
-
setPass
Sets the pass of the platform over the objective.- Parameters:
newValues
- the new pass values.
-
getSensingInstruments
Returns the instrument which senses the objective data.- Specified by:
getSensingInstruments
in interfaceorg.opengis.metadata.acquisition.Objective
- Returns:
- instrument which senses the objective data.
-
setSensingInstruments
public void setSensingInstruments(Collection<? extends org.opengis.metadata.acquisition.Instrument> newValues) Sets the instrument which senses the objective data.- Parameters:
newValues
- the new sensing instruments values.
-