Interface WritableTiledResource

All Superinterfaces:

Resource, Tiled­Resource

public interface WritableTiledResource
extends TiledResource

A Tiled­Resource that can write and delete tile matrix sets.

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

Since:

1.2

Nested Class Summary

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
Writable­Tile­Matrix­Set	create­Tile­Matrix­Set(Tile­Matrix­Set tiles)	Adds the given tile matrix set to this resource and returns a writable instance for later completion.
void	delete­Tile­Matrix­Set(String identifier)	Deletes a Tile­Matrix­Set identified by the given name.
Collection<? extends Writable­Tile­Matrix­Set>	get­Tile­Matrix­Sets()	Returns the collection of all available tile matrix sets in this resource.

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

getTileMatrixSets

Collection<? extends WritableTileMatrixSet> getTileMatrixSets()
                                                       throws DataStoreException

Returns the collection of all available tile matrix sets in this resource. The returned collection is unmodifiable but live: additions or removals of tile matrix sets in this resource are reflected in the returned collection.

Specified by:

get­Tile­Matrix­Sets in interface Tiled­Resource

Returns:

an unmodifiable view of all Tile­Matrix­Set instances in this resource.

Throws:

Data­Store­Exception - if an error occurred while fetching the tile matrix sets.

createTileMatrixSet

WritableTileMatrixSet createTileMatrixSet(TileMatrixSet tiles)
                                   throws DataStoreException

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

This method returns a writable tile matrix set with the same tiles as the given Tile­Matrix­Set. The identifier and the envelope of the returned set may be different, but the CRS and tiling scheme shall be equivalent with a tolerance for rounding errors.

Parameters:

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

Returns:

a writable tile matrix set to use for adding more tiles.

Throws:

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

Incompatible­Resource­Exception - if the given tile matrix set is incompatible with this resource.

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

deleteTileMatrixSet

void deleteTileMatrixSet(String identifier)
                  throws DataStoreException

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

Parameters:

identifier - identifier of the Tile­Matrix­Set to delete.

Throws:

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

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

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