Module org.apache.sis.storage

Package org.apache.sis.storage.tiling

Interface WritableTileMatrixSet

All Superinterfaces:

Tile­Matrix­Set

public interface WritableTileMatrixSet
extends TileMatrixSet

A Tile­Matrix­Set that can write and delete tile matrices.

All methods in this interface expect non-null arguments are return non-null values.

Since:

1.2

Method Summary

Modifier and Type	Method	Description
Writable­Tile­Matrix	create­Tile­Matrix(Tile­Matrix tiles)	Adds the given tile matrix to this set and returns a writable instance for later completion.
void	delete­Tile­Matrix(String identifier)	Deletes a Tile­Matrix identified by the given name.
Sorted­Map<Generic­Name,? extends Writable­Tile­Matrix>	get­Tile­Matrices()	Returns all Writable­Tile­Matrix instances in this set, together with their identifiers.

Methods inherited from interface TileMatrixSet

get­Coordinate­Reference­System, get­Envelope, get­Identifier

Method Details

getTileMatrices

SortedMap<GenericName,? extends WritableTileMatrix> getTileMatrices()

Returns all Writable­Tile­Matrix instances in this set, together with their identifiers. For each value in the map, the associated key is Tile­Matrix.get­Identifier(). Entries are sorted from coarser resolution (highest scale denominator) to most detailed resolution (lowest scale denominator).

The returned view is unmodifiable but live: creations or removals of tile matrices in this set will be reflected on the returned map.

Specified by:

get­Tile­Matrices in interface Tile­Matrix­Set

Returns:

an unmodifiable view of all Writable­Tile­Matrix instances with their identifiers.

createTileMatrix

WritableTileMatrix createTileMatrix(TileMatrix tiles)
                             throws DataStoreException

Adds the given tile matrix to this set and returns a writable instance for later completion. Typically the given Tile­Matrix instance contains no tile and is used only as a template. If the Tile­Matrix is not empty, then the tiles that it contains are written immediately.

The tiling scheme of the given tile matrix must be compatible with this set. In particular, it must use the same CRS than the value returned by Tile­Matrix­Set.get­Coordinate­Reference­System(). If not, an Incompatible­Resource­Exception is thrown.

This method returns a writable tile matrix with the same tiles than the given Tile­Matrix. However, the identifier of the returned tile matrix may be different.

Parameters:

tiles - the (potentially empty) tile matrix to create.

Returns:

a writable tile matrix to use for adding more tiles.

Throws:

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

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

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

deleteTileMatrix

void deleteTileMatrix(String identifier)
               throws DataStoreException

Deletes a Tile­Matrix identified by the given name. The given identifier shall be the Tile­Matrix.get­Identifier().to­String() value of the tile matrix to delete.

Parameters:

identifier - identifier of the Tile­Matrix to delete.

Throws:

No­Such­Data­Exception - if there is no tile matrix associated to the given identifier in this set.

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

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