SqlTileWriter (osmdroid-android 5.6.4 API)

java.lang.Object
- org.osmdroid.tileprovider.modules.SqlTileWriter

All Implemented Interfaces:

IFilesystemCache
```
public class SqlTileWriter
extends Object
implements IFilesystemCache
```
An implementation of IFilesystemCache based on the original TileWriter. It writes tiles to a sqlite database cache. It supports expiration timestamps if provided by the server from which the tile was downloaded. Trimming of expired
If the database exceeds Configuration#getInstance()#getTileFileSystemCacheTrimBytes() cache exceeds 600 Mb then it will be trimmed to 500 Mb by deleting files that expire first.

Since:

5.1

See Also:

DatabaseFileArchive, SqliteArchiveTileWriter

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`CLEANUP_ON_START` disables cache purge of expired tiled on start up if this is set to false, the database will only purge tiles if manually called or if the storage device runs out of space.
`static String`	`COLUMN_EXPIRES`
`static String`	`DATABASE_FILENAME`
`protected SQLiteDatabase`	`db`
`protected File`	`db_file`
`(package private) static boolean`	`hasInited`
`protected long`	`lastSizeCheck`
`(package private) int`	`questimate` a questimated size (average-ish) size of a tile

Constructor Summary

Constructors
Constructor and Description

SqlTileWriter()

Constructors
Constructor and Description
`SqlTileWriter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`exists(ITileSource pTileSource, MapTile pTile)` Returns true if the given tile source and tile coordinates exist in the cache
`boolean`	`exists(String pTileSource, MapTile pTile)` Returns true if the given tile source and tile coordinates exist in the cache
`long`	`getRowCount(String tileSourceName)` Returns the number of tiles in the cache for the specified tile source name
`int[]`	`importFromFileCache(boolean removeFromFileSystem)` a helper method to import file system stored map tiles into the sql tile cache on successful import, the tiles are removed from the file system.
`void`	`onDetach()` Used when the map engine is shutdown, use it to perform any clean up activities and to terminate any background threads
`boolean`	`purgeCache()` purges and deletes everything from the cache database
`boolean`	`purgeCache(String mTileSourceName)` purges and deletes all tiles from the given tile source name from the cache database
`boolean`	`remove(ITileSource pTileSourceInfo, MapTile pTile)` Removes a specific tile from the cache
`void`	`runCleanupOperation()` this could be a long running operation, don't run on the UI thread unless necessary.
`boolean`	`saveFile(ITileSource pTileSourceInfo, MapTile pTile, InputStream pStream)` Save an InputStream as the specified tile in the file system cache for the specified tile source.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DATABASE_FILENAME
```
public static final String DATABASE_FILENAME
```
    See Also:
    
    Constant Field Values
  - COLUMN_EXPIRES
```
public static final String COLUMN_EXPIRES
```
    See Also:
    
    Constant Field Values
  - CLEANUP_ON_START
```
public static boolean CLEANUP_ON_START
```
    disables cache purge of expired tiled on start up if this is set to false, the database will only purge tiles if manually called or if the storage device runs out of space. expired tiles will continue to be overwritten as new versions are downloaded regardless
    
    Since:
    
    5.6
  - db_file
```
protected File db_file
```
  - db
```
protected SQLiteDatabase db
```
  - lastSizeCheck
```
protected long lastSizeCheck
```
  - questimate
```
final int questimate
```
    a questimated size (average-ish) size of a tile
    
    See Also:
    
    Constant Field Values
  - hasInited
```
static boolean hasInited
```
- Constructor Detail
  - SqlTileWriter
```
public SqlTileWriter()
```
- Method Detail
  - runCleanupOperation
```
public void runCleanupOperation()
```
    this could be a long running operation, don't run on the UI thread unless necessary. This function prunes the database for old or expired tiles.
    
    Since:
    
    5.6
  - saveFile
```
public boolean saveFile(ITileSource pTileSourceInfo,
                        MapTile pTile,
                        InputStream pStream)
```
    Description copied from interface: IFilesystemCache
    
    Save an InputStream as the specified tile in the file system cache for the specified tile source.
    
    Specified by:
    
    saveFile in interface IFilesystemCache
    
    Parameters:
    
    pTileSourceInfo - a tile source
    
    pTile - a tile
    
    pStream - an InputStream
    
    Returns:
  - exists
```
public boolean exists(String pTileSource,
                      MapTile pTile)
```
    Returns true if the given tile source and tile coordinates exist in the cache
    
    Parameters:
    
    pTileSource -
    
    pTile -
    
    Returns:
    
    Since:
    
    5.6
  - exists
```
public boolean exists(ITileSource pTileSource,
                      MapTile pTile)
```
    Returns true if the given tile source and tile coordinates exist in the cache
    
    Specified by:
    
    exists in interface IFilesystemCache
    
    Parameters:
    
    pTileSource -
    
    pTile -
    
    Returns:
    
    Since:
    
    5.6
  - onDetach
```
public void onDetach()
```
    Description copied from interface: IFilesystemCache
    
    Used when the map engine is shutdown, use it to perform any clean up activities and to terminate any background threads
    
    Specified by:
    
    onDetach in interface IFilesystemCache
  - purgeCache
```
public boolean purgeCache()
```
    purges and deletes everything from the cache database
    
    Returns:
    
    Since:
    
    5.6
  - purgeCache
```
public boolean purgeCache(String mTileSourceName)
```
    purges and deletes all tiles from the given tile source name from the cache database
    
    Returns:
    
    Since:
    
    5.6.1
  - importFromFileCache
```
public int[] importFromFileCache(boolean removeFromFileSystem)
```
    a helper method to import file system stored map tiles into the sql tile cache on successful import, the tiles are removed from the file system.
    This can take a long time, so consider running this off of the main thread.
    
    Returns:
  - remove
```
public boolean remove(ITileSource pTileSourceInfo,
                      MapTile pTile)
```
    Removes a specific tile from the cache
    
    Specified by:
    
    remove in interface IFilesystemCache
    
    Parameters:
    
    pTileSourceInfo -
    
    pTile -
    
    Returns:
    
    Since:
    
    5.6
  - getRowCount
```
public long getRowCount(String tileSourceName)
```
    Returns the number of tiles in the cache for the specified tile source name
    
    Parameters:
    
    tileSourceName -
    
    Returns:
    
    Since:
    
    5.6

Class SqlTileWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATABASE_FILENAME

COLUMN_EXPIRES

CLEANUP_ON_START

db_file

db

lastSizeCheck

questimate

hasInited

Constructor Detail

SqlTileWriter

Method Detail

runCleanupOperation

saveFile

exists

exists

onDetach

purgeCache

purgeCache

importFromFileCache

remove

getRowCount