org.osmdroid.tileprovider.modules

Interface IArchiveFile

All Known Implementing Classes:

DatabaseFileArchive, GEMFFileArchive, MBTilesFileArchive, ZipFileArchive

public interface IArchiveFile

The IArchiveFile is primary used to load tiles from a file archive. Generally, this should only be used for archives that require little to no computation in order to provide a given tile. For cases thereby the tiles are rendered or manipulated (such as from another projection)

See Also:

MapTileModuleProviderBase, ArchiveFileFactory

Method Summary

Modifier and Type	Method and Description
void	close() Closes the archive file and releases resources.
InputStream	getInputStream(ITileSource tileSource, long pMapTileIndex) Get the input stream for the requested tile and tile source.
Set<String>	getTileSources() returns a list of tile source names that are available in the archive, if supported.
void	init(File pFile) initialize the file archive, such as performing initial scans, queries, opening a database, etc
void	setIgnoreTileSource(boolean pIgnoreTileSource)

Method Detail

init

void init(File pFile)
   throws Exception

initialize the file archive, such as performing initial scans, queries, opening a database, etc

Parameters:

pFile -

Throws:

Exception

getInputStream

InputStream getInputStream(ITileSource tileSource,
                           long pMapTileIndex)

Get the input stream for the requested tile and tile source. Also keep in mind that the tile source has an explicit tile size in pixels, and tile source name.

Returns:

the input stream, or null if the archive doesn't contain an entry for the requested tile.

See Also:

TileSourceFactory

close

void close()

Closes the archive file and releases resources.

getTileSources

Set<String> getTileSources()

returns a list of tile source names that are available in the archive, if supported. If not supported, return an empty set

Returns:

Since:

5.0

setIgnoreTileSource

void setIgnoreTileSource(boolean pIgnoreTileSource)

Since:

6.0 If set to true, tiles from this archive will be loaded regardless of their associated tile source name