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.grid;
033
034 import java.util.List;
035 import org.opengis.util.Record;
036 import org.opengis.annotation.UML;
037
038 import static org.opengis.annotation.Obligation.*;
039 import static org.opengis.annotation.Specification.*;
040
041
042 /**
043 * Ties feature attributes values to the a grid geometry. It holds a sequence of records associated
044 * with a sequencing rule that specifies an algorithm for assigning records of feature attribute
045 * values to grid points.
046 *
047 * @version ISO 19123:2004
048 * @author Wim Koolhoven
049 * @author Martin Schouwenburg
050 * @since GeoAPI 2.1
051 */
052 @UML(identifier="CV_GridValuesMatrix", specification=ISO_19123)
053 public interface GridValuesMatrix extends Grid {
054 /**
055 * Returns a sequence of <var>N</var> feature attribute value records where <var>N</var> is the
056 * number of {@linkplain GridPoint grid points} within the section of the grid specified by
057 * the {@linkplain #getExtent extent}.
058 *
059 * @return The feature attribute values records.
060 *
061 * @todo Comment (Wim): Both extracting an image for display and operation chaining require
062 * memory effiecient and fast access to the data. How should the data be structured per
063 * record? Some use cases:
064 * <table border=1>
065 * <tr><td>DTM<td>double<td>List<double>
066 * <tr><td>TM image<td>7 bytes<td>
067 * <tr><td>Landuse map<td>string<td>{@code List<double>} with look up table for the strings
068 * </table>
069 */
070 @UML(identifier="values", obligation=MANDATORY, specification=ISO_19123)
071 List<Record> getValues();
072
073 /**
074 * Describes how the grid points are ordered for association to the elements of the sequence
075 * values.
076 *
077 * @return The sequencing rule.
078 */
079 @UML(identifier="sequencingRule", obligation=MANDATORY, specification=ISO_19123)
080 SequenceRule getSequencingRule();
081
082 /**
083 * Identifies the grid point to be associated with the first record
084 * in the values sequence.
085 *
086 * @return The grid point associated with the first record.
087 */
088 @UML(identifier="startSequence", obligation=MANDATORY, specification=ISO_19123)
089 GridCoordinates getStartSequence();
090
091 /**
092 * Returns the limits of a section of the grid. This envelope can not be empty.
093 */
094 @UML(identifier="extent", obligation=OPTIONAL, specification=ISO_19123)
095 GridEnvelope getExtent();
096 }