abstractgridcoveragereader.html

Geotools是一个开源的Java GIS工具包,可利用它来开发符合标准的地理信息系统。Geotools提供了OGC(Open Geospatial Consortium)规范的一个实现来作为他们的

<TD><CODE><B><A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#getGridRange(int)">getGridRange</A></B>(int&nbsp;index)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the grid range for the <CODE>GridCoverage</CODE> to be read.
 </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#getImageReaders(java.lang.Object)">getImageReaders</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;input)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Iterator.html" title="class or interface in java.util"><CODE>Iterator</CODE></A> containing all currently registered
 <A HREF="http://java.sun.com/j2se/1.4/docs/api/javax/imageio/ImageReader.html" title="class or interface in javax.imageio"><CODE>ImageReader</CODE></A>s that claim to be able to decode the image.
 </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#getLocale()">getLocale</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the currently set <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html" title="class or interface in java.util"><CODE>Locale</CODE></A>, or  if none has been set.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#getName(int)">getName</A></B>(int&nbsp;index)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the <CODE>GridCoverage</CODE> name at the specified index. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#getNumImages(boolean)">getNumImages</A></B>(boolean&nbsp;allowSearch)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of images available from the current input source.
 </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;SampleDimension[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#getSampleDimensions(int)">getSampleDimensions</A></B>(int&nbsp;index)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the sample dimensions for each band of the <CODE>GridCoverage</CODE>
 to be read. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#reset()">reset</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restores the <code>AbstractGridCoverageReader</code> to its initial state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#setInput(java.lang.Object, boolean)">setInput</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;input,
         boolean&nbsp;seekForwardOnly)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the input source to the given object. </TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#setLocale(java.util.Locale)">setLocale</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A>&nbsp;locale)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the current <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html" title="class or interface in java.util"><CODE>Locale</CODE></A> of this <code>AbstractGridCoverageReader</code>
 to the given value. </TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="formatName"><!-- --></A><H3>
formatName</H3>
<PRE>
public final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>formatName</B></PRE>
<DL>
<DD>The format name (e.g. "PNG" or "GeoTIFF"). This format name should
 be understood by <A HREF="http://java.sun.com/j2se/1.4/docs/api/javax/imageio/ImageIO.html#getImageReadersByFormatName(java.lang.String)" title="class or interface in javax.imageio"><CODE>ImageIO.getImageReadersByFormatName(String)</CODE></A>,
 unless <A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#getImageReaders(java.lang.Object)"><CODE>getImageReaders(java.lang.Object)</CODE></A> is overriden.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="reader"><!-- --></A><H3>
reader</H3>
<PRE>
protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/javax/imageio/ImageReader.html" title="class or interface in javax.imageio">ImageReader</A> <B>reader</B></PRE>
<DL>
<DD>The <A HREF="http://java.sun.com/j2se/1.4/docs/api/javax/imageio/ImageReader.html" title="class or interface in javax.imageio"><CODE>ImageReader</CODE></A> to use for decoding <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/awt/image/RenderedImage.html" title="class or interface in java.awt.image"><CODE>RenderedImage</CODE></A>s.
 This reader is initially <code>null</code> and lazily created the
 first time <A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#setInput(java.lang.Object, boolean)"><CODE>setInput(java.lang.Object, boolean)</CODE></A> is invoked. Once created, it is reused
 as much as possible. Invoking <A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#reset()"><CODE>reset()</CODE></A> dispose the reader and
 set it back to <code>null</code>.
<P>
<DL>
</DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="AbstractGridCoverageReader(java.lang.String)"><!-- --></A><H3>
AbstractGridCoverageReader</H3>
<PRE>
public <B>AbstractGridCoverageReader</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;formatName)</PRE>
<DL>
<DD>Constructs a  for the specified format name.
<P>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
public void <B>reset</B>()
           throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Restores the <code>AbstractGridCoverageReader</code> to its initial state.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an error occurs while disposing resources.</DL>
</DD>
</DL>
<HR>

<A NAME="setInput(java.lang.Object, boolean)"><!-- --></A><H3>
setInput</H3>
<PRE>
public void <B>setInput</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;input,
                     boolean&nbsp;seekForwardOnly)
              throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Sets the input source to the given object. The input is usually a
 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html" title="class or interface in java.io"><CODE>File</CODE></A> or an <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/net/URL.html" title="class or interface in java.net"><CODE>URL</CODE></A> object. But some other types (e.g.
 <A HREF="http://java.sun.com/j2se/1.4/docs/api/javax/imageio/stream/ImageInputStream.html" title="class or interface in javax.imageio.stream"><CODE>ImageInputStream</CODE></A>) may be accepted too.
 <p>
 If this method is invoked for the first time or after a call to
 <A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#reset()"><CODE>reset()</CODE></A>, then it will queries <A HREF="../../../../org/geotools/coverage/io/AbstractGridCoverageReader.html#getImageReaders(java.lang.Object)"><CODE>getImageReaders(java.lang.Object)</CODE></A> for
 a list of <A HREF="http://java.sun.com/j2se/1.4/docs/api/javax/imageio/ImageReader.html" title="class or interface in javax.imageio"><CODE>ImageReader</CODE></A>s and select the first one that accept
 the input.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>input</CODE> - The <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html" title="class or interface in java.io"><CODE>File</CODE></A> or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/net/URL.html" title="class or interface in java.net"><CODE>URL</CODE></A> to be read.<DD><CODE>seekForwardOnly</CODE> - if <code>true</code>, grid coverages
         and metadata may only be read in ascending order from
         the input source.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an I/O operation failed.
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if input is not an instance
         of one of the classes declared by the <A HREF="http://java.sun.com/j2se/1.4/docs/api/javax/imageio/ImageReader.html" title="class or interface in javax.imageio"><CODE>ImageReader</CODE></A>
         service provider.</DL>
</DD>
</DL>
<HR>

<A NAME="getNumImages(boolean)"><!-- --></A><H3>
getNumImages</H3>
<PRE>
public int <B>getNumImages</B>(boolean&nbsp;allowSearch)
                 throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>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 <code>allowSearch</code> parameter may be set to <code>false</code>
 to indicate that an exhaustive search is not desired.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>allowSearch</CODE> - If , the true number of images will
         be returned even if a search is required. If ,
         the reader may return -1 without performing the search.
<DT><B>Returns:</B><DD>The number of images, or -1 if  is
          and a search would be required.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - If the input source has not been set, or if
         the input has been specified with  set to .
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - If an error occurs reading the information from the input source.</DL>
</DD>
</DL>
<HR>

<A NAME="getName(int)"><!-- --></A><H3>
getName</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getName</B>(int&nbsp;index)