001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 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.lineage;
033
034 import java.util.Collection;
035 import java.util.Date;
036 import org.opengis.util.InternationalString;
037 import org.opengis.metadata.citation.ResponsibleParty;
038 import org.opengis.annotation.UML;
039
040 import static org.opengis.annotation.Obligation.*;
041 import static org.opengis.annotation.Specification.*;
042
043
044 /**
045 * Description of the event, including related parameters or tolerances.
046 *
047 * @author Martin Desruisseaux (IRD)
048 * @author Cédric Briançon (Geomatys)
049 * @version 3.0
050 * @since 2.0
051 *
052 * @navassoc - - - ResponsibleParty
053 * @navassoc - - - Source
054 */
055 @UML(identifier="LI_ProcessStep", specification=ISO_19115)
056 public interface ProcessStep {
057 /**
058 * Description of the event, including related parameters or tolerances.
059 *
060 * @return Description of the event.
061 */
062 @UML(identifier="description", obligation=MANDATORY, specification=ISO_19115)
063 InternationalString getDescription();
064
065 /**
066 * Requirement or purpose for the process step.
067 *
068 * @return Requirement or purpose for the process step, or {@code null}.
069 */
070 @UML(identifier="rationale", obligation=OPTIONAL, specification=ISO_19115)
071 InternationalString getRationale();
072
073 /**
074 * Date and time or range of date and time on or over which the process step occurred.
075 * <p>
076 * <TABLE WIDTH="80%" ALIGN="center" CELLPADDING="18" BORDER="4" BGCOLOR="#FFE0B0">
077 * <TR><TD>
078 * <P align="justify"><B>Warning:</B> The return type of this method may change
079 * in GeoAPI 3.1 release. It may be replaced by a type matching more closely
080 * either ISO 19108 (<cite>Temporal Schema</cite>) or ISO 19103.</P>
081 * </TD></TR>
082 * </TABLE>
083 *
084 * @return Date on or over which the process step occurred, or {@code null}.
085 */
086 @UML(identifier="dateTime", obligation=OPTIONAL, specification=ISO_19115)
087 Date getDate();
088
089 /**
090 * Identification of, and means of communication with, person(s) and
091 * organization(s) associated with the process step.
092 *
093 * @return Means of communication with person(s) and organization(s) associated
094 * with the process step.
095 */
096 @UML(identifier="processor", obligation=OPTIONAL, specification=ISO_19115)
097 Collection<? extends ResponsibleParty> getProcessors();
098
099 /**
100 * Information about the source data used in creating the data specified by the scope.
101 *
102 * @return Information about the source data used in creating the data.
103 */
104 @UML(identifier="source", obligation=OPTIONAL, specification=ISO_19115)
105 Collection<? extends Source> getSources();
106
107 /**
108 * Description of the product generated as a result of the process step.
109 *
110 * @return Product generated as a result of the process step.
111 *
112 * @since 2.3
113 */
114 @UML(identifier="output", obligation=OPTIONAL, specification=ISO_19115_2)
115 Collection<? extends Source> getOutputs();
116
117 /**
118 * Comprehensive information about the procedure by which the algorithm was applied
119 * to derive geographic data from the raw instrument measurements, such as datasets,
120 * software used, and the processing environment.
121 *
122 * @return Procedure by which the algorithm was applied to derive geographic data
123 * from the raw instrument measurements
124 *
125 * @since 2.3
126 */
127 @UML(identifier="processingInformation", obligation=OPTIONAL, specification=ISO_19115_2)
128 Processing getProcessingInformation();
129
130 /**
131 * Report generated by the process step.
132 *
133 * @return Report generated by the process step.
134 *
135 * @since 2.3
136 */
137 @UML(identifier="report", obligation=OPTIONAL, specification=ISO_19115_2)
138 Collection<? extends ProcessStepReport> getReports();
139 }