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 org.opengis.annotation.UML;
035 import org.opengis.annotation.Extension;
036
037 import static org.opengis.annotation.Obligation.*;
038 import static org.opengis.annotation.Specification.*;
039
040
041 /**
042 * Holds the set of grid coordinates that specifies the location of the
043 * {@linkplain GridPoint grid point} within the {@linkplain Grid grid}.
044 *
045 * @version ISO 19123:2004
046 * @author Martin Schouwenburg
047 * @author Wim Koolhoven
048 * @author Martin Desruisseaux (IRD)
049 * @since GeoAPI 2.1
050 */
051 @UML(identifier="CV_GridCoordinates", specification=ISO_19123)
052 public interface GridCoordinates {
053 /**
054 * Returns the number of dimensions. This method is equivalent to
055 * <code>{@linkplain #getCoordinateValues()}.length</code>. It is
056 * provided for efficiency.
057 *
058 * @return The number of dimensions.
059 */
060 @Extension
061 int getDimension();
062
063 /**
064 * Returns one integer value for each dimension of the grid. The ordering of these coordinate
065 * values shall be the same as that of the elements of {@link Grid#getAxisNames}. The value of
066 * a single coordinate shall be the number of offsets from the origin of the grid in the direction
067 * of a specific axis.
068 *
069 * @return A copy of the coordinates. Changes in the returned array will not be reflected
070 * back in this {@code GridCoordinates} object.
071 */
072 @UML(identifier="coordValues", obligation=MANDATORY, specification=ISO_19123)
073 int[] getCoordinateValues();
074
075 /**
076 * Returns the coordinate value at the specified dimension. This method is equivalent to
077 * <code>{@linkplain #getCoordinateValues()}[<var>i</var>]</code>. It is provided for
078 * efficiency.
079 *
080 * @param dimension The dimension for which to obtain the coordinate value.
081 * @return The coordinate value at the given dimension.
082 * @throws IndexOutOfBoundsException If the given index is negative or is equals or greater
083 * than the {@linkplain #getDimension grid dimension}.
084 */
085 @Extension
086 int getCoordinateValue(int dimension) throws IndexOutOfBoundsException;
087
088 /**
089 * Sets the coordinate value at the specified dimension (optional operation).
090 *
091 * @param dimension The dimension for which to set the coordinate value.
092 * @param value The new value.
093 * @throws IndexOutOfBoundsException If the given index is negative or is equals or greater
094 * than the {@linkplain #getDimension grid dimension}.
095 * @throws UnsupportedOperationException if this grid coordinates is not modifiable.
096 */
097 @Extension
098 void setCoordinateValue(int dimension, int value)
099 throws IndexOutOfBoundsException, UnsupportedOperationException;
100 }