001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2009-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
036 import org.opengis.annotation.UML;
037 import org.opengis.metadata.Identifier;
038 import org.opengis.metadata.citation.Citation;
039 import org.opengis.util.InternationalString;
040
041 import static org.opengis.annotation.Obligation.*;
042 import static org.opengis.annotation.Specification.*;
043
044
045 /**
046 * Comprehensive information about the procedure(s), process(es) and algorithm(s) applied
047 * in the process step.
048 *
049 * @author Cédric Briançon (Geomatys)
050 * @version 3.0
051 * @since 2.3
052 *
053 * @navassoc 1 - - Identifier
054 * @navassoc - - - Citation
055 * @navassoc - - - Algorithm
056 */
057 @UML(identifier="LE_Processing", specification=ISO_19115_2)
058 public interface Processing {
059 /**
060 * Information to identify the processing package that produced the data.
061 *
062 * @return Identifier of the processing package that produced the data.
063 */
064 @UML(identifier="identifier", obligation=MANDATORY, specification=ISO_19115_2)
065 Identifier getIdentifier();
066
067 /**
068 * Reference to document describing processing software.
069 *
070 * @return Document describing processing software.
071 */
072 @UML(identifier="softwareReference", obligation=OPTIONAL, specification=ISO_19115_2)
073 Collection<? extends Citation> getSoftwareReferences();
074
075 /**
076 * Additional details about the processing procedures.
077 *
078 * @return Processing procedures.
079 */
080 @UML(identifier="procedureDescription", obligation=OPTIONAL, specification=ISO_19115_2)
081 InternationalString getProcedureDescription();
082
083 /**
084 * Reference to documentation describing the processing.
085 *
086 * @return Documentation describing the processing.
087 */
088 @UML(identifier="documentation", obligation=OPTIONAL, specification=ISO_19115_2)
089 Collection<? extends Citation> getDocumentations();
090
091 /**
092 * Parameters to control the processing operations, entered at run time.
093 *
094 * @return Parameters to control the processing operations.
095 */
096 @UML(identifier="runTimeParameters", obligation=OPTIONAL, specification=ISO_19115_2)
097 InternationalString getRunTimeParameters();
098
099 /**
100 * Details of the methodology by which geographic information was derived from the
101 * instrument readings.
102 *
103 * @return Methodology by which geographic information was derived from the
104 * instrument readings.
105 */
106 @UML(identifier="algorithm", obligation=OPTIONAL, specification=ISO_19115_2)
107 Collection<? extends Algorithm> getAlgorithms();
108 }