org.osmdroid.tileprovider.modules

Class ZipFileArchive

java.lang.Object

org.osmdroid.tileprovider.modules.ZipFileArchive

All Implemented Interfaces:

IArchiveFile

public class ZipFileArchive
extends Object
implements IArchiveFile

Field Summary

Fields

Modifier and Type	Field and Description
protected ZipFile	mZipFile

Constructor Summary

Constructors

Constructor and Description
ZipFileArchive()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the archive file and releases resources.
InputStream	getInputStream(ITileSource pTileSource, 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.
static ZipFileArchive	getZipFileArchive(File pFile)
void	init(File pFile) initialize the file archive, such as performing initial scans, queries, opening a database, etc
void	setIgnoreTileSource(boolean pIgnoreTileSource)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

mZipFile

protected ZipFile mZipFile

Constructor Detail

ZipFileArchive

public ZipFileArchive()

Method Detail

getZipFileArchive

public static ZipFileArchive getZipFileArchive(File pFile)
                                        throws ZipException,
                                               IOException

Throws:

ZipException

IOException

setIgnoreTileSource

public void setIgnoreTileSource(boolean pIgnoreTileSource)

Specified by:

setIgnoreTileSource in interface IArchiveFile

Since:

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

init

public void init(File pFile)
          throws Exception

Description copied from interface: IArchiveFile

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

Specified by:

init in interface IArchiveFile

Throws:

Exception

getInputStream

public InputStream getInputStream(ITileSource pTileSource,
                                  long pMapTileIndex)

Description copied from interface: IArchiveFile

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.

Specified by:

getInputStream in interface IArchiveFile

Returns:

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

See Also:

TileSourceFactory

getTileSources

public Set<String> getTileSources()

Description copied from interface: IArchiveFile

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

Specified by:

getTileSources in interface IArchiveFile

Returns:

close

public void close()

Description copied from interface: IArchiveFile

Closes the archive file and releases resources.

Specified by:

close in interface IArchiveFile

toString

public String toString()

Overrides:

toString in class Object