org.geotoolkit.metadata.iso.acquisition
Class DefaultEvent

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              DefaultEvent

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, Event

@ThreadSafe
public class DefaultEvent
extends MetadataEntity
implements Event

Identification of a significant collection point within an operation.

Since:

3.03

Version:

3.19

Author:

Cédric Briançon (Geomatys), Martin Desruisseaux (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

DefaultEvent()
Constructs an initially empty acquisition information.

DefaultEvent(Event source)
Constructs a metadata entity initialized with the values from the specified metadata.

Method Summary

static DefaultEvent	castOrCopy(Event object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Context	getContext() Meaning of the event.
Collection<Objective>	getExpectedObjectives() Returns the objective or objectives satisfied by an event.
Identifier	getIdentifier() Returns the event name or number.
PlatformPass	getRelatedPass() Returns the pass during which an event occurs.
Collection<? extends Instrument>	getRelatedSensors() Returns the instrument or instruments for which the event is meaningful.
Sequence	getSequence() Returns the relative time ordering of the event.
Date	getTime() Returns the time the event occurred.
Trigger	getTrigger() Returns the initiator of the event.
void	setContext(Context newValue) Sets the meaning of the event.
void	setExpectedObjectives(Collection<? extends Objective> newValues) Sets the objective or objectives satisfied by an event.
void	setIdentifier(Identifier newValue) Sets the event name or number.
void	setRelatedPass(PlatformPass newValue) Sets the pass during which an event occurs.
void	setRelatedSensors(Collection<? extends Instrument> newValues) Sets the instrument or instruments for which the event is meaningful.
void	setSequence(Sequence newValue) Sets the relative time ordering of the event.
void	setTime(Date newValue) Sets the time the event occurred.
void	setTrigger(Trigger newValue) Sets the initiator of the event.

Methods inherited from class MetadataEntity

getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultEvent

public DefaultEvent()

Constructs an initially empty acquisition information.

DefaultEvent

public DefaultEvent(Event source)

Constructs a metadata entity initialized with the values from the specified metadata.

Parameters:

source - The metadata to copy, or null if none.

Method Detail

castOrCopy

public static DefaultEvent castOrCopy(Event object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getIdentifier

public Identifier getIdentifier()

Returns the event name or number.

Specified by:

getIdentifier in interface Event

Overrides:

getIdentifier in class MetadataEntity

Returns:

The first ISO 19115 identifier, or null if none.

setIdentifier

public void setIdentifier(Identifier newValue)

Sets the event name or number.

Parameters:

newValue - The event identifier value.

getTrigger

public Trigger getTrigger()

Returns the initiator of the event.

Specified by:

getTrigger in interface Event

setTrigger

public void setTrigger(Trigger newValue)

Sets the initiator of the event.

Parameters:

newValue - The new trigger value.

getContext

public Context getContext()

Meaning of the event.

Specified by:

getContext in interface Event

setContext

public void setContext(Context newValue)

Sets the meaning of the event.

Parameters:

newValue - The new context value.

getSequence

public Sequence getSequence()

Returns the relative time ordering of the event.

Specified by:

getSequence in interface Event

setSequence

public void setSequence(Sequence newValue)

Sets the relative time ordering of the event.

Parameters:

newValue - The new sequence value.

getTime

public Date getTime()

Returns the time the event occurred.

Specified by:

getTime in interface Event

setTime

public void setTime(Date newValue)

Sets the time the event occurred.

Parameters:

newValue - The new time value.

getExpectedObjectives

public Collection<Objective> getExpectedObjectives()

Returns the objective or objectives satisfied by an event.

Specified by:

getExpectedObjectives in interface Event

setExpectedObjectives

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

Sets the objective or objectives satisfied by an event.

Parameters:

newValues - The new expected objectives values.

getRelatedPass

public PlatformPass getRelatedPass()

Returns the pass during which an event occurs. null if unspecified.

Specified by:

getRelatedPass in interface Event

setRelatedPass

public void setRelatedPass(PlatformPass newValue)

Sets the pass during which an event occurs.

Parameters:

newValue - The new platform pass value.

getRelatedSensors

public Collection<? extends Instrument> getRelatedSensors()

Returns the instrument or instruments for which the event is meaningful.

Specified by:

getRelatedSensors in interface Event

setRelatedSensors

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

Sets the instrument or instruments for which the event is meaningful.

Parameters:

newValues - The new instrument values.