001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2005-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.coverage;
033
034 import java.util.Collection; // For javadoc
035 import org.opengis.util.Record;
036 import org.opengis.geometry.DirectPosition; // For javadoc
037 import org.opengis.annotation.UML;
038
039 import static org.opengis.annotation.Obligation.*;
040 import static org.opengis.annotation.Specification.*;
041
042
043 /**
044 * Describes an element of a set that defines the relationships of a
045 * {@linkplain DiscreteCoverage discrete coverage}. Each member of this class consists of two parts:
046 * a {@linkplain DomainObject domain object} from the domain of the coverage to which it belongs and
047 * a record of feature attribute values from the range of the coverage to which it belongs.
048 * <var>geometry</var>-<var>value</var> pairs may be generated in the execution of an
049 * {@link Coverage#evaluate(DirectPosition,Collection) evaluate} operation, and need not be
050 * persistent. {@code GeometryValuePair} is subclassed to restrict the pairing of a feature
051 * attribute value record to a specific subtype of domain object.
052 *
053 * @version ISO 19123:2004
054 * @author Stephane Fellah
055 * @author Martin Desruisseaux (IRD)
056 * @since GeoAPI 2.1
057 *
058 * @see Coverage#evaluate(DirectPosition,Collection)
059 * @see Coverage#select
060 * @see Coverage#find(DirectPosition,int)
061 * @see Coverage#list
062 */
063 @UML(identifier="CV_GeometryValuePair", specification=ISO_19123)
064 public interface GeometryValuePair {
065 /**
066 * The domain object that is a member of this <var>geometry</var>-<var>value</var> pair.
067 *
068 * @return The geometry member of the pair.
069 */
070 @UML(identifier="geometry", obligation=MANDATORY, specification=ISO_19123)
071 DomainObject<?> getGeometry();
072
073 /**
074 * Holds the record of feature attribute values associated with the domain object.
075 *
076 * @return The value member of the pair.
077 */
078 @UML(identifier="value", obligation=MANDATORY, specification=ISO_19123)
079 Record getValue();
080 }