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.quality;
033    
034    import java.util.Collection;
035    import org.opengis.metadata.lineage.Lineage;
036    import org.opengis.annotation.UML;
037    import org.opengis.annotation.Profile;
038    
039    import static org.opengis.annotation.Obligation.*;
040    import static org.opengis.annotation.Specification.*;
041    import static org.opengis.annotation.ComplianceLevel.*;
042    
043    
044    /**
045     * Quality information for the data specified by a data quality scope.
046     *
047     * @author  Martin Desruisseaux (IRD)
048     * @version 3.0
049     * @since   2.0
050     *
051     * @navassoc 1 - - Scope
052     * @navassoc - - - Element
053     * @navassoc 1 - - Lineage
054     */
055    @UML(identifier="DQ_DataQuality", specification=ISO_19115)
056    public interface DataQuality {
057        /**
058         * The specific data to which the data quality information applies.
059         *
060         * @return The specific data to which the data quality information applies.
061         */
062        @UML(identifier="scope", obligation=MANDATORY, specification=ISO_19115)
063        Scope getScope();
064    
065        /**
066         * Quantitative quality information for the data specified by the scope.
067         * Shall be provided only if {@linkplain Scope#getLevel scope level} is
068         * {@linkplain org.opengis.metadata.maintenance.ScopeCode#DATASET dataset}.
069         *
070         * @return Quantitative quality information for the data.
071         *
072         * @condition {@linkplain #getLineage() Lineage} not provided.
073         */
074        @UML(identifier="report", obligation=CONDITIONAL, specification=ISO_19115)
075        Collection<? extends Element> getReports();
076    
077        /**
078         * Non-quantitative quality information about the lineage of the data specified by the scope.
079         * Shall be provided only if {@linkplain Scope#getLevel scope level} is
080         * {@linkplain org.opengis.metadata.maintenance.ScopeCode#DATASET dataset}.
081         *
082         * @return Non-quantitative quality information about the lineage of the data specified,
083         *         or {@code null}.
084         *
085         * @condition {@linkplain #getReports() Report} not provided.
086         */
087        @Profile(level=CORE)
088        @UML(identifier="lineage", obligation=CONDITIONAL, specification=ISO_19115)
089        Lineage getLineage();
090    }