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 org.opengis.util.InternationalString;
036 import org.opengis.metadata.quality.Scope;
037 import org.opengis.metadata.maintenance.ScopeCode;
038 import org.opengis.annotation.UML;
039 import org.opengis.annotation.Profile;
040
041 import static org.opengis.annotation.Obligation.*;
042 import static org.opengis.annotation.Specification.*;
043 import static org.opengis.annotation.ComplianceLevel.*;
044
045
046 /**
047 * Information about the events or source data used in constructing the data specified by
048 * the scope or lack of knowledge about lineage.
049 *
050 * Only one of {@linkplain #getStatement statement}, {@linkplain #getProcessSteps process steps}
051 * and {@linkplain #getSources sources} shall be provided.
052 *
053 * @author Martin Desruisseaux (IRD)
054 * @version 3.0
055 * @since 2.0
056 *
057 * @navassoc - - - ProcessStep
058 * @navassoc - - - Source
059 */
060 @UML(identifier="LI_Lineage", specification=ISO_19115)
061 public interface Lineage {
062 /**
063 * General explanation of the data producer's knowledge about the lineage of a dataset.
064 *
065 * @return Explanation of the data producer's knowledge about the lineage, or {@code null}.
066 *
067 * @condition Shall be provided only if {@linkplain Scope#getLevel scope level} is
068 * {@link ScopeCode#DATASET} or {@link ScopeCode#SERIES}.
069 */
070 @Profile(level=CORE)
071 @UML(identifier="statement", obligation=CONDITIONAL, specification=ISO_19115)
072 InternationalString getStatement();
073
074 /**
075 * Information about an event in the creation process for the data specified by the scope.
076 *
077 * @return Information about an event in the creation process.
078 *
079 * @condition Mandatory if {@linkplain #getStatement statement} and
080 * {@linkplain #getSources source} are not provided.
081 */
082 @UML(identifier="processStep", obligation=CONDITIONAL, specification=ISO_19115)
083 Collection<? extends ProcessStep> getProcessSteps();
084
085 /**
086 * Information about the source data used in creating the data specified by the scope.
087 *
088 * @return Information about the source data.
089 *
090 * @condition Mandatory if {@linkplain #getStatement statement} and
091 * {@linkplain #getProcessSteps process step} are not provided.
092 */
093 @UML(identifier="source", obligation=CONDITIONAL, specification=ISO_19115)
094 Collection<? extends Source> getSources();
095 }