Module org.opengis.geoapi

Package org.opengis.metadata.acquisition

Interface Event

@UML(identifier="MI_Event",
     specification=ISO_19115_2)
public interface Event

Identification of a significant collection point within an operation.

Since:

2.3

Method Summary

Modifier and Type	Method	Description
Context	getContext()	Meaning of the event.
Temporal	getDateOfOccurrence()	Date and time the event occurred.
default Collection<? extends Objective>	getExpectedObjectives()	Objective or objectives satisfied by an event.
Identifier	getIdentifier()	Event name or number.
default PlatformPass	getRelatedPass()	Pass during which an event occurs.
default Collection<? extends Instrument>	getRelatedSensors()	Instrument or instruments for which the event is meaningful.
Sequence	getSequence()	Relative time ordering of the event.
default Date	getTime()	Deprecated. Replaced by getDateOfOccurrence().
Trigger	getTrigger()	Initiator of the event.

Method Details

getIdentifier

@UML(identifier="identifier",
     obligation=MANDATORY,
     specification=ISO_19115_2)
Identifier getIdentifier()

Event name or number.

Returns:

event name or number.

getTrigger

@UML(identifier="trigger",
     obligation=MANDATORY,
     specification=ISO_19115_2)
Trigger getTrigger()

Initiator of the event.

Returns:

initiator of the event.

getContext

@UML(identifier="context",
     obligation=MANDATORY,
     specification=ISO_19115_2)
Context getContext()

Meaning of the event.

Returns:

meaning of the event.

getSequence

@UML(identifier="sequence",
     obligation=MANDATORY,
     specification=ISO_19115_2)
Sequence getSequence()

Relative time ordering of the event.

Returns:

relative time ordering.

getTime

@Deprecated(since="3.1")
default Date getTime()

Deprecated.

Replaced by getDateOfOccurrence().

Time the event occurred.

Returns:

time the event occurred.

getDateOfOccurrence

@UML(identifier="time",
     obligation=MANDATORY,
     specification=ISO_19115_2)
Temporal getDateOfOccurrence()

Date and time the event occurred. The returned value should be an instance of LocalDate, LocalDateTime, OffsetDateTime or ZonedDateTime, depending whether hours are defined and how the timezone (if any) is defined. But other types are also allowed.

Returns:

time the event occurred.

Since:

3.1

Details

Renamed for avoiding a conflict with the getTime() method defined in GeoAPI 3.0.

getExpectedObjectives

@UML(identifier="expectedObjective",
     obligation=OPTIONAL,
     specification=ISO_19115_2)
default Collection<? extends Objective> getExpectedObjectives()

Objective or objectives satisfied by an event.

Returns:

objectives satisfied by an event.

getRelatedPass

@UML(identifier="relatedPass",
     obligation=OPTIONAL,
     specification=ISO_19115_2)
default PlatformPass getRelatedPass()

Pass during which an event occurs.

Returns:

pass during which an event occurs, or null.

getRelatedSensors

@UML(identifier="relatedSensor",
     obligation=OPTIONAL,
     specification=ISO_19115_2)
default Collection<? extends Instrument> getRelatedSensors()

Instrument or instruments for which the event is meaningful.

Returns:

instruments for which the event is meaningful.