Java Doc for GridCoverageReader.java in » GIS » GeoTools-2.4.1 » org » geotools » coverage » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » GIS » GeoTools 2.4.1 » org.geotools.coverage.io

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.geotools.coverage.io .GridCoverageReader

All known Subclasses:   org.geotools.coverage.io .AbstractGridCoverageReader,
GridCoverageReader
public interface GridCoverageReader (Code)
Interface for reading GridCoverage objects. Reading is a two steps process: The input file must be set first, then the actual reading is performed with the GridCoverageReader.getGridCoverage . Example:
GridCoverageReader reader = ... reader. (new File("MyCoverage.dat"), true); GridCoverage coverage = reader. (0);

since:
   2.4
version:
   $Id: GridCoverageReader.java 25699 2007-05-31 15:55:07Z desruisseaux $
author:
   Martin Desruisseaux

Method Summary
CoordinateReferenceSystem getCoordinateReferenceSystem(int index)
     Returns the coordinate reference system for the GridCoverage to be read.
Parameters:
  index - The index of the image to be queried.
Envelope getEnvelope(int index)
     Returns the envelope for the GridCoverage to be read. The envelope must have the same number of dimensions than the coordinate reference system.
Parameters:
  index - The index of the image to be queried.
GridCoverage getGridCoverage(int index)
     Reads the grid coverage.
Parameters:
  index - The index of the image to be queried.
GridRange getGridRange(int index)
     Returns the grid range for the GridCoverage to be read. The grid range must have the same number of dimensions than the envelope.
Parameters:
  index - The index of the image to be queried.
MathTransform getMathTransform(int index)
     Returns the transform from to coordinates.
String getName(int index)
     Gets the GridCoverage name at the specified index.
Parameters:
  index - The index of the image to be queried.
int getNumImages(boolean allowSearch)
     Returns the number of images available from the current input source. Note that some image formats do not specify how many images are present in the stream.
GridSampleDimension[] getSampleDimensions(int index)
     Returns the sample dimensions for each band of the GridCoverage to be read.
void reset()
     Restores the GridCoverageReader to its initial state.
void setInput(Object input, boolean seekForwardOnly)
     Sets the input source to the given object.

Method Detail
getCoordinateReferenceSystem
CoordinateReferenceSystem getCoordinateReferenceSystem(int index) throws IOException(Code)
Returns the coordinate reference system for the GridCoverage to be read.
Parameters:
  index - The index of the image to be queried. The coordinate reference system for the GridCoverage at the specified index.
throws:
  IllegalStateException - if the input source has not been set.
throws:
  IndexOutOfBoundsException - if the supplied index is out of bounds.
throws:
  IOException - if an error occurs reading the width information from the input source.

getEnvelope
Envelope getEnvelope(int index) throws IOException(Code)
Returns the envelope for the GridCoverage to be read. The envelope must have the same number of dimensions than the coordinate reference system.
Parameters:
  index - The index of the image to be queried. The envelope for the GridCoverage at the specified index.
throws:
  IllegalStateException - if the input source has not been set.
throws:
  IndexOutOfBoundsException - if the supplied index is out of bounds.
throws:
  IOException - if an error occurs reading the width information from the input source.

getGridCoverage
GridCoverage getGridCoverage(int index) throws IOException(Code)
Reads the grid coverage.
Parameters:
  index - The index of the image to be queried. The GridCoverage at the specified index.
throws:
  IllegalStateException - if the input source has not been set.
throws:
  IndexOutOfBoundsException - if the supplied index is out of bounds.
throws:
  IOException - if an error occurs reading the width information from the input source.

getGridRange
GridRange getGridRange(int index) throws IOException(Code)
Returns the grid range for the GridCoverage to be read. The grid range must have the same number of dimensions than the envelope.
Parameters:
  index - The index of the image to be queried. The grid range for the GridCoverage at the specified index.
throws:
  IllegalStateException - if the input source has not been set.
throws:
  IndexOutOfBoundsException - if the supplied index is out of bounds.
throws:
  IOException - if an error occurs reading the width information from the input source.

getMathTransform
MathTransform getMathTransform(int index) throws IOException(Code)
Returns the transform from to coordinates.

getName
String getName(int index) throws IOException(Code)
Gets the GridCoverage name at the specified index.
Parameters:
  index - The index of the image to be queried. The name for the GridCoverage at the specified index.
throws:
  IllegalStateException - if the input source has not been set.
throws:
  IndexOutOfBoundsException - if the supplied index is out of bounds.
throws:
  IOException - if an error occurs reading the information from the input source.

getNumImages
int getNumImages(boolean allowSearch) throws IOException(Code)
Returns the number of images available from the current input source. Note that some image formats do not specify how many images are present in the stream. Thus determining the number of images will require the entire stream to be scanned and may require memory for buffering. The allowSearch parameter may be set to false to indicate that an exhaustive search is not desired.
Parameters:
  allowSearch - If true , the true number of images willbe returned even if a search is required. If false ,the reader may return -1 without performing the search. The number of images, or -1 if allowSearch is false and a search would be required.
throws:
  IllegalStateException - If the input source has not been set, or ifthe input has been specified with seekForwardOnly set to true .
throws:
  IOException - If an error occurs reading the information from the input source.

getSampleDimensions
GridSampleDimension[] getSampleDimensions(int index) throws IOException(Code)
Returns the sample dimensions for each band of the GridCoverage to be read. If sample dimensions are not known, then this method returns null .
Parameters:
  index - The index of the image to be queried. The category lists for the GridCoverage at the specified index.This array's length must be equals to the number of bands in GridCoverage.
throws:
  IllegalStateException - if the input source has not been set.
throws:
  IndexOutOfBoundsException - if the supplied index is out of bounds.
throws:
  IOException - if an error occurs reading the width information from the input source.

reset
void reset() throws IOException(Code)
Restores the GridCoverageReader to its initial state.
throws:
  IOException - if an error occurs while disposing resources.

setInput
void setInput(Object input, boolean seekForwardOnly) throws IOException(Code)
Sets the input source to the given object. The input is usually a java.io.File or an java.net.URL object. But some other types (e.g. javax.imageio.stream.ImageInputStream ) may be accepted as well.
Parameters:
  input - The java.io.File or java.net.URL to be read.
Parameters:
  seekForwardOnly - if true , grid coveragesand metadata may only be read in ascending order fromthe input source.
throws:
  IOException - if an I/O operation failed.
throws:
  IllegalArgumentException - if input is not a valid instance.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.