com.threerings.media.tile
Interface TileSetIDBroker

All Known Implementing Classes:

MapFileTileSetIDBroker

public interface TileSetIDBroker

Brokers tileset ids. The tileset repository interface makes available a collection of tilesets based on a unique identifier. The expectation is that a collection of tilesets will be used to populate a repository and in that population process, tileset ids will be assigned to the tilesets. The tileset id broker system provides a means by which named tilesets can be mapped consistently to a set of tileset ids. Humans can then be responsible for assigning unique names to the tilesets and the broker will ensure that those names map to unique ids that won't change if the repository is rebuilt from the source tilesets.

Method Summary

void	commit() When the user of a tilset id broker is done obtaining tileset ids, it must call this method to give the tileset id broker an opportunity to flush any newly created tileset ids back to its persistent store.
int	getTileSetID(String tileSetName) Returns the unique identifier for the named tileset.
boolean	tileSetMapped(String tileSetName) Returns true if the specified tileset name is currently mapped to some value by this broker.

Method Detail

getTileSetID

int getTileSetID(String tileSetName)
                 throws PersistenceException

Returns the unique identifier for the named tileset. If no identifier has yet been assigned to the specified named tileset, one should be assigned and returned.

Throws:

PersistenceException - thrown if an error occurs communicating with the underlying persistence mechanism used to store the name to id mappings.

tileSetMapped

boolean tileSetMapped(String tileSetName)
                      throws PersistenceException

Returns true if the specified tileset name is currently mapped to some value by this broker.

Throws:

PersistenceException - thrown if an error occurs communicating with the underlying persistence mechanism used to store the name to id mappings.

commit

void commit()
            throws PersistenceException

When the user of a tilset id broker is done obtaining tileset ids, it must call this method to give the tileset id broker an opportunity to flush any newly created tileset ids back to its persistent store.

Throws:

PersistenceException