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.

Nested classes/interfaces inherited from interface Resource

Resource.File­Set

Modifier and Type	Interface	Description
static class	Resource.File­Set	Paths to the files potentially used by the enclosing resource.

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 GridCoverageResource

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

Modifier and Type	Method	Description
default List<double[]>	get­Available­Resolutions()	Returns the preferred resolutions (in units of CRS axes) for read operations in this data store.
default Optional<Envelope>	get­Envelope()	Returns the spatiotemporal extent of this resource in its most natural coordinate reference system.
Grid­Geometry	get­Grid­Geometry()	Returns the valid extent of grid coordinates together with the conversion from those grid coordinates to real world coordinates.
default Raster­Loading­Strategy	get­Loading­Strategy()	Returns an indication about when the "physical" loading of raster data will happen.
default List<double[]>	get­Resolutions()	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by Grid­Coverage­Resource.get­Available­Resolutions() but with opposite order.
List<Sample­Dimension>	get­Sample­Dimensions()	Returns the ranges of sample values together with the conversion from samples to real values.
Grid­Coverage	read(Grid­Geometry domain, int... ranges)	Loads a subset of the grid coverage represented by this resource.
default boolean	set­Loading­Strategy(Raster­Loading­Strategy strategy)	Sets the preferred strategy about when to do the "physical" loading of raster data.
default Grid­Coverage­Resource	subset(Query query)	Requests a subset of the coverage.

Methods inherited from interface Resource

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

Modifier and Type	Method	Description
default <T extends Store­Event> void	add­Listener(Class<T> event­Type, Store­Listener<? super T> listener)	Registers a listener to notify when the specified kind of event occurs in this resource or in children.
default Optional<Resource.File­Set>	get­File­Set()	Gets the paths to the files potentially used by this resource.
default Optional<Generic­Name>	get­Identifier()	Returns the resource persistent identifier.
Metadata	get­Metadata()	Returns information about this resource.
default <T extends Store­Event> void	remove­Listener(Class<T> event­Type, Store­Listener<? super T> listener)	Unregisters a listener previously added to this resource for the given type of events.

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.