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.Set;
035 import org.opengis.geometry.DirectPosition;
036 import org.opengis.geometry.primitive.Curve;
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 * A discrete coverage characterized by a finite spatial domain consisting of
045 * {@linkplain Curve curves}. Often the curves represent features such as roads,
046 * railroads, or streams. They may be elements of a network.
047 * <p>
048 * <b>Example:</b> A coverage that assigns a route a number, a name, a pavement width,
049 * and a pavement material type to each segment of a road system.
050 *
051 * @version ISO 19123:2004
052 * @author Alessio Fabiani
053 * @since GeoAPI 2.1
054 *
055 * @todo evaluate and evaluateInverse
056 */
057 @UML(identifier="CV_DiscreteCurveCoverage", specification=ISO_19123)
058 public interface DiscreteCurveCoverage extends DiscreteCoverage {
059 /**
060 * Returns the set of <var>curve</var>-<var>value</var> pairs included in this coverage.
061 */
062 @UML(identifier="element", obligation=OPTIONAL, specification=ISO_19123)
063 Set<CurveValuePair> getElements();
064
065 /**
066 * Returns the set of <var>curve</var>-<var>value</var> pairs that include the
067 * {@linkplain DomainObject domain objects} containing the specified direct position.
068 */
069 @UML(identifier="locate", obligation=OPTIONAL, specification=ISO_19123)
070 Set<CurveValuePair> locate(DirectPosition p);
071
072 /**
073 * Returns the dictionary of <var>curve</var>-<var>value</var> pairs that contain the
074 * {@linkplain DomainObject objects} in the domain of the coverage each paired with its
075 * record of feature attribute values.
076 */
077 @UML(identifier="list", obligation=MANDATORY, specification=ISO_19123)
078 Set<CurveValuePair> list();
079
080 /**
081 * Returns the nearest <var>curve</var>-<var>value</var> pair from the specified direct
082 * position. This is a shortcut for <code>{@linkplain #find(DirectPosition,int) find}(p,1)</code>.
083 */
084 @UML(identifier="find", obligation=MANDATORY, specification=ISO_19123)
085 CurveValuePair find(DirectPosition p);
086 }