001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/model/coverage/grid/GridCoverage.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2008 by:
006 EXSE, Department of Geography, University of Bonn
007 http://www.giub.uni-bonn.de/deegree/
008 lat/lon GmbH
009 http://www.lat-lon.de
010
011 This library is free software; you can redistribute it and/or
012 modify it under the terms of the GNU Lesser General Public
013 License as published by the Free Software Foundation; either
014 version 2.1 of the License, or (at your option) any later version.
015
016 This library is distributed in the hope that it will be useful,
017 but WITHOUT ANY WARRANTY; without even the implied warranty of
018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 Lesser General Public License for more details.
020
021 You should have received a copy of the GNU Lesser General Public
022 License along with this library; if not, write to the Free Software
023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024
025 Contact:
026
027 Andreas Poth
028 lat/lon GmbH
029 Aennchenstr. 19
030 53115 Bonn
031 Germany
032 E-Mail: poth@lat-lon.de
033
034 Prof. Dr. Klaus Greve
035 Department of Geography
036 University of Bonn
037 Meckenheimer Allee 166
038 53115 Bonn
039 Germany
040 E-Mail: greve@giub.uni-bonn.de
041
042
043 ---------------------------------------------------------------------------*/
044 package org.deegree.model.coverage.grid;
045
046 import org.deegree.model.coverage.Coverage;
047
048 /**
049 * Represent the basic implementation which provides access to grid coverage data. A
050 * <code>GridCoverage</code> implementation may provide the ability to update grid values.
051 *
052 * @UML abstract CV_GridCoverage
053 * @author <A HREF="http://www.opengis.org">OpenGIS® consortium</A>
054 * @version <A HREF="http://www.opengis.org/docs/01-004.pdf">Grid Coverage specification 1.0</A>
055 *
056 * @author last edited by: $Author: apoth $
057 *
058 * @version $Revision: 9343 $, $Date: 2007-12-27 14:30:32 +0100 (Do, 27 Dez 2007) $
059 *
060 * @see java.awt.image.RenderedImage
061 * @see javax.media.jai.PixelAccessor
062 */
063 public interface GridCoverage extends Coverage {
064 /**
065 * Returns <code>true</code> if grid data can be edited.
066 *
067 * @return <code>true</code> if grid data can be edited.
068 * @UML mandatory dataEditable
069 */
070 boolean isDataEditable();
071
072 /**
073 * Information for the grid coverage geometry. Grid geometry includes the valid range of grid
074 * coordinates and the georeferencing.
075 *
076 * @return The information for the grid coverage geometry.
077 * @UML mandatory gridGeometry
078 */
079 GridGeometry getGridGeometry();
080
081 /**
082 * Returns the source data for a grid coverage. If the <code>GridCoverage</code> was produced
083 * from an underlying dataset (by {@link GridCoverageReader#read read(...)} for instance) the
084 * getNumSources() method should returns zero, and this method should not be called.
085 *
086 * If the <code>GridCoverage</code> was produced using {link
087 * org.opengis.coverage.processing.GridCoverageProcessor} then it should return the source grid
088 * coverage of the one used as input to <code>GridCoverageProcessor</code>. In general the
089 * <code>getSource(i)</code> method is intended to return the original
090 * <code>GridCoverage</code> on which it depends.
091 *
092 * This is intended to allow applications to establish what <code>GridCoverage</code>s will
093 * be affected when others are updated, as well as to trace back to the "raw data".
094 *
095 * @param sourceDataIndex
096 * Source grid coverage index. Indexes start at 0.
097 * @return The source data for a grid coverage.
098 * @throws IndexOutOfBoundsException
099 * if <code>sourceDataIndex</code> is out of bounds.
100 * @UML operation Coverage.getSource
101 */
102 Coverage getSource( int sourceDataIndex )
103 throws IndexOutOfBoundsException;
104
105 }