Class DefaultEvent
Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultEvent
- All Implemented Interfaces:
- Serializable,- Emptiable,- LenientComparable,- IdentifiedObject,- 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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs an initially empty acquisition information.DefaultEvent(Event object) Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptionstatic DefaultEventcastOrCopy(Event object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Meaning of the event.Returns the objective or objectives satisfied by an event.Returns the event name or number.Returns the pass during which an event occurs.Collection<? extends Instrument>Returns the instrument or instruments for which the event is meaningful.Returns the relative time ordering of the event.getTime()Returns the time the event occurred.Returns the initiator of the event.voidsetContext(Context newValue) Sets the meaning of the event.voidsetExpectedObjectives(Collection<? extends Objective> newValues) Sets the objective or objectives satisfied by an event.voidsetIdentifier(Identifier newValue) Sets the event name or number.voidsetRelatedPass(PlatformPass newValue) Sets the pass during which an event occurs.voidsetRelatedSensors(Collection<? extends Instrument> newValues) Sets the instrument or instruments for which the event is meaningful.voidsetSequence(Sequence newValue) Sets the relative time ordering of the event.voidSets the time the event occurred.voidsetTrigger(Trigger newValue) Sets the initiator of the event.Methods inherited from class ISOMetadatagetIdentifierMap, getIdentifiers, getStandard, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
- 
Constructor Details- 
DefaultEventpublic DefaultEvent()Constructs an initially empty acquisition information.
- 
DefaultEventConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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
       DefaultEvent, then it is returned unchanged.
- Otherwise a new DefaultEventinstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getIdentifierReturns the event name or number.- Specified by:
- getIdentifierin interface- Event
- Overrides:
- getIdentifierin class- ISOMetadata
- Returns:
- event name or number, or null.
 
- 
setIdentifierSets the event name or number.- Overrides:
- setIdentifierin class- ISOMetadata
- Parameters:
- newValue- the event identifier value.
 
- 
getTriggerReturns the initiator of the event.- Specified by:
- getTriggerin interface- Event
- Returns:
- initiator of the event, or null.
 
- 
setTriggerSets the initiator of the event.- Parameters:
- newValue- the new trigger value.
 
- 
getContextMeaning of the event.- Specified by:
- getContextin interface- Event
- Returns:
- meaning of the event, or null.
 
- 
setContextSets the meaning of the event.- Parameters:
- newValue- the new context value.
 
- 
getSequenceReturns the relative time ordering of the event.- Specified by:
- getSequencein interface- Event
- Returns:
- relative time ordering, or null.
 
- 
setSequenceSets the relative time ordering of the event.- Parameters:
- newValue- the new sequence value.
 
- 
getTimeReturns the time the event occurred.
- 
setTimeSets the time the event occurred.- Parameters:
- newValue- the new time value.
 
- 
getExpectedObjectivesReturns the objective or objectives satisfied by an event.- Specified by:
- getExpectedObjectivesin interface- Event
- Returns:
- objectives satisfied by an event.
 
- 
setExpectedObjectivesSets the objective or objectives satisfied by an event.- Parameters:
- newValues- the new expected objectives values.
 
- 
getRelatedPassReturns the pass during which an event occurs.nullif unspecified.- Specified by:
- getRelatedPassin interface- Event
- Returns:
- pass during which an event occurs, or null.
 
- 
setRelatedPassSets the pass during which an event occurs.- Parameters:
- newValue- the new platform pass value.
 
- 
getRelatedSensorsReturns the instrument or instruments for which the event is meaningful.- Specified by:
- getRelatedSensorsin interface- Event
- Returns:
- instruments for which the event is meaningful.
 
- 
setRelatedSensorsSets the instrument or instruments for which the event is meaningful.- Parameters:
- newValues- the new instrument values.
 
 
-