|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GridCoverageReader
Support for reading grid coverages out of a persistent store.
ImageReader
Method Summary | |
---|---|
void |
dispose()
Allows any resources held by this object to be released. |
String |
getCurrentSubname()
Deprecated. no replacement for that. |
Format |
getFormat()
Returns the format handled by this GridCoverageReader . |
int |
getGridCoverageCount()
Retrieve the number of coverages contained within the input source. |
String[] |
getGridCoverageNames()
Retrieve the list of coverages contained within the input source. |
String[] |
getMetadataNames()
Returns the list of metadata keywords associated with the input source as a whole (not associated with any particular grid coverage). |
String[] |
getMetadataNames(String coverageName)
Returns the list of metadata keywords associated with a specific gridCoverage referred by name. |
String |
getMetadataValue(String name)
Retrieve the metadata value for a given metadata name. |
String |
getMetadataValue(String coverageName,
String name)
Retrieve the metadata value for a given metadata name for a specified coverage. |
Object |
getSource()
Returns the input source. |
boolean |
hasMoreGridCoverages()
Deprecated. no replacement for that. |
String[] |
listSubNames()
Deprecated. use getGridCoverageNames() |
GridCoverage |
read(GeneralParameterValue[] parameters)
Read the only available grid coverage. |
GridCoverage |
read(String coverageName,
GeneralParameterValue[] parameters)
Read the grid coverage specified by coverageName parameter. |
void |
skip()
Deprecated. no replacement for that. |
Method Detail |
---|
Format getFormat()
GridCoverageReader
.
Object getSource()
String
, an InputStream
, a
FileChannel
, whatever.
String[] getMetadataNames() throws IOException
IOException
- if an error occurs during reading.String[] getMetadataNames(String coverageName) throws IOException
IOException
- if an error occurs during reading.String getMetadataValue(String name) throws IOException
name
- Metadata keyword for which to retrieve metadata.
getMetadataNames()
.
IOException
- if an error occurs during reading.String getMetadataValue(String coverageName, String name) throws IOException
name
- Metadata keyword for which to retrieve metadata.
getMetadataNames()
.
IOException
- if an error occurs during reading.String[] listSubNames() throws IOException
getGridCoverageNames()
IOException
- if an error occurs during reading.String[] getGridCoverageNames() throws IOException
IOException
- if an error occurs during reading.int getGridCoverageCount() throws IOException
IOException
- if an error occurs during reading.String getCurrentSubname() throws IOException
IOException
- if an error occurs during reading.boolean hasMoreGridCoverages() throws IOException
true
if there is at least one more grid coverage
available on the stream.
IOException
GridCoverage read(GeneralParameterValue[] parameters) throws IllegalArgumentException, IOException
read(String, GeneralParameterValue[])
in case of multiple grid coverages available.
parameters
- An optional set of parameters. Should be any or all of the
parameters returned by Format.getReadParameters()
.
InvalidParameterNameException
- if a parameter in parameters
doesn't have a recognized name.
InvalidParameterValueException
- if a parameter in parameters
doesn't have a valid value.
ParameterNotFoundException
- if a parameter was required for the operation but was
not provided in the parameters
list.
CannotCreateGridCoverageException
- if the coverage can't be created for a logical
reason (for example an unsupported format, or an inconsistency found in the data).
IOException
- if a read operation failed for some other input/output reason, including
FileNotFoundException
if no file with the given name
can be
found, or IIOException
if an error was thrown by the
underlying image library.
IllegalArgumentException
GridCoverage read(String coverageName, GeneralParameterValue[] parameters) throws IllegalArgumentException, IOException
parameters
- An optional set of parameters. Should be any or all of the
parameters returned by Format.getReadParameters()
.
InvalidParameterNameException
- if a parameter in parameters
doesn't have a recognized name.
InvalidParameterValueException
- if a parameter in parameters
doesn't have a valid value.
ParameterNotFoundException
- if a parameter was required for the operation but was
not provided in the parameters
list.
CannotCreateGridCoverageException
- if the coverage can't be created for a logical
reason (for example an unsupported format, or an inconsistency found in the data).
IOException
- if a read operation failed for some other input/output reason, including
FileNotFoundException
if no file with the given name
can be
found, or IIOException
if an error was thrown by the
underlying image library.
IllegalArgumentException
void skip() throws IOException
IOException
- if the operation failed.void dispose() throws IOException
GridCoverageReader
.
Otherwise, the reader may continue to hold on to resources indefinitely.
IOException
- if an error occured while disposing resources (for example while closing
a file).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |