Module org.apache.sis.metadata

Package org.apache.sis.metadata.iso.acquisition

Class DefaultEvent

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultEvent

All Implemented Interfaces:

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

public class DefaultEvent
extends ISOMetadata
implements Event

Identification of a significant collection point within an operation. The following properties are mandatory in a well-formed metadata according ISO 19115:

MI_Event ├─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

Field Summary

Fields inherited from class ISOMetadata

identifiers

Constructor Summary

Constructors

Constructor	Description
Default­Event()	Constructs an initially empty acquisition information.
Default­Event(Event object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Event	cast­Or­Copy(Event object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Context	get­Context()	Meaning of the event.
Collection<Objective>	get­Expected­Objectives()	Returns the objective or objectives satisfied by an event.
Identifier	get­Identifier()	Returns the event name or number.
Platform­Pass	get­Related­Pass()	Returns the pass during which an event occurs.
Collection<? extends Instrument>	get­Related­Sensors()	Returns the instrument or instruments for which the event is meaningful.
Sequence	get­Sequence()	Returns the relative time ordering of the event.
Date	get­Time()	Returns the time the event occurred.
Trigger	get­Trigger()	Returns the initiator of the event.
void	set­Context(Context new­Value)	Sets the meaning of the event.
void	set­Expected­Objectives(Collection<? extends Objective> new­Values)	Sets the objective or objectives satisfied by an event.
void	set­Identifier(Identifier new­Value)	Sets the event name or number.
void	set­Related­Pass(Platform­Pass new­Value)	Sets the pass during which an event occurs.
void	set­Related­Sensors(Collection<? extends Instrument> new­Values)	Sets the instrument or instruments for which the event is meaningful.
void	set­Sequence(Sequence new­Value)	Sets the relative time ordering of the event.
void	set­Time(Date new­Value)	Sets the time the event occurred.
void	set­Trigger(Trigger new­Value)	Sets the initiator of the event.

Methods inherited from class ISOMetadata

get­Identifier­Map, get­Identifiers, get­Standard, transition­To

Methods inherited from class ModifiableMetadata

check­Write­Permission, collection­Type, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, equals, equals, get­Interface, hash­Code, is­Empty, prune, to­String

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultEvent

public DefaultEvent()

Constructs an initially empty acquisition information.

DefaultEvent

public DefaultEvent(Event 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(Event)

Method Details

castOrCopy

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

getIdentifier

public Identifier getIdentifier()

Returns the event name or number.

Specified by:

get­Identifier in interface Event

Overrides:

get­Identifier in class ISOMetadata

Returns:

event name or number, or null.

setIdentifier

public void setIdentifier(Identifier newValue)

Sets the event name or number.

Overrides:

set­Identifier in class ISOMetadata

Parameters:

new­Value - the event identifier value.

getTrigger

public Trigger getTrigger()

Returns the initiator of the event.

Specified by:

get­Trigger in interface Event

Returns:

initiator of the event, or null.

setTrigger

public void setTrigger(Trigger newValue)

Sets the initiator of the event.

Parameters:

new­Value - the new trigger value.

getContext

public Context getContext()

Meaning of the event.

Specified by:

get­Context in interface Event

Returns:

meaning of the event, or null.

setContext

public void setContext(Context newValue)

Sets the meaning of the event.

Parameters:

new­Value - the new context value.

getSequence

public Sequence getSequence()

Returns the relative time ordering of the event.

Specified by:

get­Sequence in interface Event

Returns:

relative time ordering, or null.

setSequence

public void setSequence(Sequence newValue)

Sets the relative time ordering of the event.

Parameters:

new­Value - the new sequence value.

getTime

public Date getTime()

Returns the time the event occurred.

Specified by:

get­Time in interface Event

Returns:

time the event occurred, or null.

setTime

public void setTime(Date newValue)

Sets the time the event occurred.

Parameters:

new­Value - the new time value.

getExpectedObjectives

public Collection<Objective> getExpectedObjectives()

Returns the objective or objectives satisfied by an event.

Specified by:

get­Expected­Objectives in interface Event

Returns:

objectives satisfied by an event.

setExpectedObjectives

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

Sets the objective or objectives satisfied by an event.

Parameters:

new­Values - the new expected objectives values.

getRelatedPass

public PlatformPass getRelatedPass()

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

Specified by:

get­Related­Pass in interface Event

Returns:

pass during which an event occurs, or null.

setRelatedPass

public void setRelatedPass(PlatformPass newValue)

Sets the pass during which an event occurs.

Parameters:

new­Value - the new platform pass value.

getRelatedSensors

public Collection<? extends Instrument> getRelatedSensors()

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

Specified by:

get­Related­Sensors in interface Event

Returns:

instruments for which the event is meaningful.

setRelatedSensors

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

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

Parameters:

new­Values - the new instrument values.