001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2009-2013 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.metadata.acquisition;
033
034 import java.util.Collection;
035 import java.util.Date;
036
037 import org.opengis.annotation.UML;
038 import org.opengis.metadata.Identifier;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Identification of a significant collection point within an operation.
046 *
047 * @author Cédric Briançon (Geomatys)
048 * @version 3.0
049 * @since 2.3
050 *
051 * @navassoc 1 - - Identifier
052 * @navassoc 1 - - Trigger
053 * @navassoc 1 - - Context
054 * @navassoc 1 - - Sequence
055 * @navassoc - - - Objective
056 * @navassoc 1 - - PlatformPass
057 * @navassoc - - - Instrument
058 */
059 @UML(identifier="MI_Event", specification=ISO_19115_2)
060 public interface Event {
061 /**
062 * Event name or number.
063 *
064 * @return Event name or number.
065 */
066 @UML(identifier="identifier", obligation=MANDATORY, specification=ISO_19115_2)
067 Identifier getIdentifier();
068
069 /**
070 * Initiator of the event.
071 *
072 * @return Initiator of the event.
073 */
074 @UML(identifier="trigger", obligation=MANDATORY, specification=ISO_19115_2)
075 Trigger getTrigger();
076
077 /**
078 * Meaning of the event.
079 *
080 * @return Meaning of the event.
081 */
082 @UML(identifier="context", obligation=MANDATORY, specification=ISO_19115_2)
083 Context getContext();
084
085 /**
086 * Relative time ordering of the event.
087 *
088 * @return Relative time ordering.
089 */
090 @UML(identifier="sequence", obligation=MANDATORY, specification=ISO_19115_2)
091 Sequence getSequence();
092
093 /**
094 * Time the event occurred.
095 * <p>
096 * <TABLE WIDTH="80%" ALIGN="center" CELLPADDING="18" BORDER="4" BGCOLOR="#FFE0B0">
097 * <TR><TD>
098 * <P align="justify"><B>Warning:</B> The return type of this method may change
099 * in GeoAPI 3.1 release. It may be replaced by a type matching more closely
100 * either ISO 19108 (<cite>Temporal Schema</cite>) or ISO 19103.</P>
101 * </TD></TR>
102 * </TABLE>
103 *
104 * @return Time the event occurred
105 */
106 @UML(identifier="time", obligation=MANDATORY, specification=ISO_19115_2)
107 Date getTime();
108
109 /**
110 * Objective or objectives satisfied by an event.
111 *
112 * @return Objectives satisfied by an event.
113 */
114 @UML(identifier="expectedObjective", obligation=OPTIONAL, specification=ISO_19115_2)
115 Collection<? extends Objective> getExpectedObjectives();
116
117 /**
118 * Pass during which an event occurs.
119 *
120 * @return Pass during which an event occurs.
121 */
122 @UML(identifier="relatedPass", obligation=OPTIONAL, specification=ISO_19115_2)
123 PlatformPass getRelatedPass();
124
125 /**
126 * Instrument or instruments for which the event is meaningful.
127 *
128 * @return Instruments for which the event is meaningful.
129 */
130 @UML(identifier="relatedSensor", obligation=OPTIONAL, specification=ISO_19115_2)
131 Collection<? extends Instrument> getRelatedSensors();
132 }