|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GridCoverageWriter
Support for writing grid coverages into a persistent store. Instance
of GridCoverageWriter
are obtained through a call to
GridCoverageExchange#getWriter
. Grid coverages are usually
added to the output stream in a sequential order.
GridCoverageExchange#getWriter
,
ImageWriter
Method Summary | |
---|---|
void |
dispose()
Allows any resources held by this object to be released. |
Object |
getDestination()
Returns the output destination. |
Format |
getFormat()
Returns the format handled by this GridCoverageWriter . |
String[] |
getMetadataNames()
Returns the list of metadata keywords associated with the output destination as a whole (not associated with any particular grid coverage). |
void |
setCurrentSubname(String name)
Set the name for the next grid coverage to write within the output destination. |
void |
setMetadataValue(String name,
String value)
Sets the metadata value for a given metadata name. |
void |
write(GridCoverage coverage,
GeneralParameterValue[] parameters)
Writes the specified grid coverage. |
Method Detail |
---|
Format getFormat()
GridCoverageWriter
.
Object getDestination()
GridCoverageExchange#getWriter
method. It can be a
String
, an OutputStream
,
a FileChannel
, etc.
String[] getMetadataNames()
IOException
- if an error occurs during reading or writing.void setMetadataValue(String name, String value) throws IOException
name
- Metadata keyword for which to set the metadata.value
- The metadata value for the given metadata name.
IOException
- if an error occurs during writing.void setCurrentSubname(String name) throws IOException
IOException
- if an error occurs during writing.void write(GridCoverage coverage, GeneralParameterValue[] parameters) throws IllegalArgumentException, IOException
coverage
- The grid coverage to write.parameters
- An optional set of parameters. Should be any or all of the
parameters returned by Format.getWriteParameters()
.
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.
FileFormatNotCompatibleWithGridCoverageException
- if the grid coverage
can't be exported in the writer format.
IOException
- if the export failed for some other input/output reason, including
IIOException
if an error was thrown by the underlying
image library.
IllegalArgumentException
void dispose() throws IOException
GridCoverageWriter
.
Otherwise, the writer may continue to hold on to resources indefinitely.
IOException
- if an error occured while disposing resources
(for example while flushing data and closing a file).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |