Module org.apache.sis.storage

Package org.apache.sis.storage

Interface WritableGridCoverageResource

All Superinterfaces:

Data­Set, Grid­Coverage­Resource, Resource

public interface WritableGridCoverageResource
extends GridCoverageResource

A Grid­Coverage­Resource with writing capabilities. Writable­Grid­Coverage­Resource inherits the reading capabilities from its parent and adds a write operation. Some aspects of the write operation can be controlled by options, which may be Data­Store-specific.

Since:

1.2

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Writable­Grid­Coverage­Resource.Common­Option	Write options that may apply to any data store.
static interface	Writable­Grid­Coverage­Resource.Option	Configuration of the process of writing a coverage in a data store.

Method Summary

Modifier and Type	Method	Description
void	write(Grid­Coverage coverage, Writable­Grid­Coverage­Resource.Option... options)	Writes a new coverage in the data store for this resource.

Methods inherited from interface DataSet

get­Envelope

Methods inherited from interface GridCoverageResource

get­Grid­Geometry, get­Loading­Strategy, get­Resolutions, get­Sample­Dimensions, read, set­Loading­Strategy, subset

Methods inherited from interface Resource

add­Listener, get­Identifier, get­Metadata, remove­Listener

Method Details

write

void write(GridCoverage coverage,
 WritableGridCoverageResource.Option... options)
    throws DataStoreException

Writes a new coverage in the data store for this resource. If a coverage already exists for this resource, then the behavior of this method is determined by the given options. If no option is specified, the default behavior is to fail if writing a coverage would cause an existing coverage to be overwritten. This behavior can be modified by requesting the replacement or update of existing coverages.

Parameters:

coverage - new data to write in the data store for this resource.

options - configuration of the write operation. May be Data­Store-specific options (e.g. for compression, encryption, etc).

Throws:

Illegal­Argument­Exception - if mutually exclusive options are specified.

Read­Only­Storage­Exception - if the resource is (possibly temporarily) read-only.

Resource­Already­Exists­Exception - if a coverage already exists in this resource and no REPLACE or UPDATE option have been specified.

Incompatible­Resource­Exception - if the given resource cannot be written, for example because its grid geometry is unsupported by this resource.

Data­Store­Exception - if another error occurred while writing data in the underlying data store.