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.Solid;
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 coverage whose domain consists of a collection of {@linkplain Solid solids}. Solids or their
045 * boundaries may be of any shape. Generally, the solids that constitute the domain of a coverage
046 * are mutually exclusive and exhaustively partition the extent of the coverage, but this is not
047 * required.
048 * <p>
049 * <b>Example:</b> Buildings in an urban area could be represented as a set of unconnected
050 * {@linkplain Solid solids} each with attributes such as building name,
051 * address, floor space, and number of occupants.
052 * <p>
053 * As in the case of surfaces, the spatial domain of a discrete solid coverage may be a regular or
054 * semiregular tessellation of the extent of the coverage. The tessellation can be defined in terms
055 * of a 3 dimensional grid, where the set of grid cells is the spatial domain of the coverage.
056 *
057 * @version ISO 19123:2004
058 * @author Alessio Fabiani
059 * @since GeoAPI 2.1
060 *
061 * @todo evaluate and evaluateInverse
062 */
063 @UML(identifier="CV_DiscreteSolidCoverage", specification=ISO_19123)
064 public interface DiscreteSolidCoverage extends DiscreteCoverage {
065 /**
066 * Returns the set of <var>solid</var>-<var>value</var> pairs included in this coverage.
067 */
068 @UML(identifier="element", obligation=OPTIONAL, specification=ISO_19123)
069 Set<SolidValuePair> getElements();
070
071 /**
072 * Returns the set of <var>solid</var>-<var>value</var> pairs that include the
073 * {@linkplain DomainObject domain objects} containing the specified direct position.
074 */
075 @UML(identifier="locate", obligation=OPTIONAL, specification=ISO_19123)
076 Set<SolidValuePair> locate(DirectPosition p);
077
078 /**
079 * Returns the dictionary of <var>solid</var>-<var>value</var> pairs that contain the
080 * {@linkplain DomainObject objects} in the domain of the coverage each paired with its
081 * record of feature attribute values.
082 */
083 @UML(identifier="list", obligation=MANDATORY, specification=ISO_19123)
084 Set<SolidValuePair> list();
085
086 /**
087 * Returns the nearest <var>solid</var>-<var>value</var> pair from the specified direct
088 * position. This is a shortcut for <code>{@linkplain #find(DirectPosition,int) find}(p,1)</code>.
089 */
090 @UML(identifier="find", obligation=MANDATORY, specification=ISO_19123)
091 SolidValuePair find(DirectPosition p);
092 }