Interface WritableTileMatrix

All Superinterfaces:

Tile­Matrix

public interface WritableTileMatrix
extends TileMatrix

A Tile­Matrix that can write and delete tiles.

All methods in this interface expect non-null arguments.

Since:

1.2

Method Summary

Modifier and Type	Method	Description
long	delete­Tiles(Grid­Extent indices­Ranges)	Deletes all existing tiles in the given region.
void	write­Tiles(Stream<Tile> tiles)	Writes a stream of tiles.

Methods inherited from interface TileMatrix

get­Identifier, get­Metadata, get­Resolution, get­Tile, get­Tiles, get­Tile­Status, get­Tiling­Scheme

Modifier and Type	Method	Description
Generic­Name	get­Identifier()	Returns an alphanumeric identifier which is unique in the Tile­Matrix­Set that contains this Tile­Matrix.
default Metadata	get­Metadata()	Returns information about this tile matrix.
double[]	get­Resolution()	Returns the resolution (in units of CRS axes) at which tiles in this matrix should be used.
Optional<Tile>	get­Tile(long... indices)	Gets a tile at the given indices.
Stream<Tile>	get­Tiles(Grid­Extent indice­Ranges, boolean parallel)	Retrieves a stream of existing tiles in the specified region.
Tile­Status	get­Tile­Status(long... indices)	Fetches information about whether a tile exists, is missing or failed to load.
Grid­Geometry	get­Tiling­Scheme()	Returns a description about how space is partitioned into individual tiled units.

Method Details

writeTiles

void writeTiles(Stream<Tile> tiles)
         throws DataStoreException

Writes a stream of tiles. The caller must ensure that all tiles are compatible with the tiling scheme of this tile matrix set. If a tile already exists, it will be overwritten.

Parameters:

tiles - the tiles to write.

Throws:

Read­Only­Storage­Exception - if this tile matrix is not writable. It may be caused by insufficient credentials.

Incompatible­Resource­Exception - if a tile is not compatible with the tiling scheme of this tile matrix.

Data­Store­Exception - if writing the tiles failed for another reason.

deleteTiles

long deleteTiles(GridExtent indicesRanges)
          throws DataStoreException

Deletes all existing tiles in the given region. After this method call, the status of all tiles in the given region become Tile­Status.MISSING. Tiles that were already missing are silently ignored.

Parameters:

indices­Ranges - ranges of tile indices in all dimensions, or null for all tiles.

Returns:

number of tiles deleted (i.e. not counting the tiles that were already missing).

Throws:

Read­Only­Storage­Exception - if this tile matrix is not writable. It may be caused by insufficient credentials.

Data­Store­Exception - if deleting the tile failed for another reason.