/*$************************************************************************************************
 **
 ** $Id: GridRange.java 831 2006-05-01 00:27:23Z Desruisseaux $
 **
 ** $URL: http://svn.code.sf.net/p/geoapi/code/branches/2.0.x/geoapi/src/main/java/org/opengis/coverage/grid/GridRange.java $
 **
 ** Copyright (C) 2003-2005 Open GIS Consortium, Inc.
 ** All Rights Reserved. http://www.opengis.org/legal/
 **
 *************************************************************************************************/
package org.opengis.coverage.grid;

// Annotations
import org.opengis.annotation.UML;
import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;


/**
 * Specifies the range of valid coordinates for each dimension of the coverage.
 * For example this data type is used to access a block of grid coverage data values.
 *
 * 
 
 * 
 *   
 * 

 *     
WARNING: THIS CLASS WILL CHANGE. Current API is derived from OGC
 *     Grid Coverages Implementation specification 1.0.
 *     We plan to replace it by new interfaces derived from ISO 19123 (Schema for coverage geometry
 *     and functions). Current interfaces should be considered as legacy and are included in this
 *     distribution only because they were part of GeoAPI 1.0 release. We will try to preserve as much 
 *     compatibility as possible, but no migration plan has been determined yet.
 *   
 *
 * @version Grid Coverage specification 1.0
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 1.0
 */
@UML(identifier="CV_GridRange", specification=OGC_01004)
public interface GridRange {
    /**
     * Returns the number of dimensions.
     */
    int getDimension();

    /**
     * The valid minimum inclusive grid coordinate.
     * The sequence contains a minimum value for each dimension of the grid coverage.
     * The lowest valid grid coordinate is zero.
     *
     * @return The valid minimum inclusive grid coordinate.
     */
    @UML(identifier="lo", obligation=MANDATORY, specification=OGC_01004)
    int[] getLowers();

    /**
     * The valid maximum exclusive grid coordinate.
     * The sequence contains a maximum value for each dimension of the grid coverage.
     *
     * @return The valid maximum exclusive grid coordinate.
     */
    @UML(identifier="hi", obligation=MANDATORY, specification=OGC_01004)
    int[] getUppers();
    
    /**
     * Returns the valid minimum inclusive grid
     * coordinate along the specified dimension.
     *
     * @see #getLowers
     */
    int getLower(int dimension);
    
    /**
     * Returns the valid maximum exclusive grid
     * coordinate along the specified dimension.
     *
     * @see #getUppers
     */
    int getUpper(int dimension);
    
    /**
     * Returns the number of integer grid coordinates along the specified dimension.
     * This is equals to {@code getUpper(dimension)-getLower(dimension)}.
     */
    int getLength(int dimension);
}