Class 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

    Defined in the sis-metadata module

    • Constructor Detail

      • 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, since 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 Detail

      • 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, since 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.
      • 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.
      • 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.