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 javax.measure.unit.Unit;
036 import org.opengis.util.InternationalString;
037 import org.opengis.util.Record;
038 import org.opengis.util.RecordType;
039 import org.opengis.annotation.UML;
040
041 import static org.opengis.annotation.Obligation.*;
042 import static org.opengis.annotation.Specification.*;
043
044
045 /**
046 * Information about the value (or set of values) obtained from applying a data quality measure.
047 *
048 * @author Martin Desruisseaux (IRD)
049 * @author Cory Horner (Refractions Research)
050 * @version 3.0
051 * @since 2.0
052 *
053 * @navassoc - - - Record
054 * @navassoc 1 - - RecordType
055 * @navassoc 1 - - Unit
056 */
057 @UML(identifier="DQ_QuantitativeResult", specification=ISO_19115)
058 public interface QuantitativeResult extends Result {
059 /**
060 * Quantitative value or values, content determined by the evaluation procedure used.
061 *
062 * @return Quantitative value or values.
063 */
064 @UML(identifier="value", obligation=MANDATORY, specification=ISO_19115)
065 Collection<? extends Record> getValues();
066
067 /**
068 * Value type for reporting a data quality result, or {@code null} if none.
069 *
070 * @return Value type for reporting a data quality result, or {@code null}.
071 */
072 @UML(identifier="valueType", obligation=OPTIONAL, specification=ISO_19115)
073 RecordType getValueType();
074
075 /**
076 * Value unit for reporting a data quality result, or {@code null} if none.
077 *
078 * @return Value unit for reporting a data quality result, or {@code null}.
079 */
080 @UML(identifier="valueUnit", obligation=MANDATORY, specification=ISO_19115)
081 Unit<?> getValueUnit();
082
083 /**
084 * Statistical method used to determine the value, or {@code null} if none.
085 *
086 * @return Statistical method used to determine the value, or {@code null}.
087 */
088 @UML(identifier="errorStatistic", obligation=OPTIONAL, specification=ISO_19115)
089 InternationalString getErrorStatistic();
090 }