SqlTileWriter (osmdroid-android 6.0.0 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 String`	`COLUMN_EXPIRES`
`static String`	`DATABASE_FILENAME`
`protected SQLiteDatabase`	`db`
`protected File`	`db_file`
`(package private) static boolean`	`hasInited`
`protected long`	`lastSizeCheck`
`(package private) long`	`tileSize` mean tile size computed on first use.

Constructor Summary

Constructors
Constructor and Description

SqlTileWriter()

Constructors
Constructor and Description
`SqlTileWriter()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`exists(ITileSource pTileSource, long pMapTileIndex)` Returns true if the given tile source and tile coordinates exist in the cache
`boolean`	`exists(String pTileSource, long pMapTileIndex)` Returns true if the given tile source and tile coordinates exist in the cache
`Long`	`getExpirationTimestamp(ITileSource pTileSource, long pMapTileIndex)` Gets the cache expiration timestamp of a tile
`long`	`getFirstExpiry()` Returns the expiry time of the tile that expires first.
`static long`	`getIndex(long pMapTileIndex)` Gets the single column index value for a map tile Unluckily, "map tile index" and "sql pk" don't match
`static long`	`getIndex(long pX, long pY, long pZ)`
`static String`	`getPrimaryKey()`
`static String[]`	`getPrimaryKeyParameters(long pIndex, ITileSource pTileSourceInfo)`
`static String[]`	`getPrimaryKeyParameters(long pIndex, String pTileSourceInfo)`
`long`	`getRowCount(String tileSourceName)` Returns the number of tiles in the cache for the specified tile source name
`long`	`getSize()` Returns the size of the database file in bytes.
`Cursor`	`getTileCursor(String[] pPrimaryKeyParameters, String[] pColumns)`
`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.
`Drawable`	`loadTile(ITileSource pTileSource, long pMapTileIndex)` Gets the tile drawable
`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, long pMapTileIndex)` 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, long pMapTileIndex, InputStream pStream, Long pExpirationTime)` Save an InputStream as the specified tile in the file system cache for the specified tile source.
`static void`	`setCleanupOnStart(boolean value)`

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
  - db_file
```
protected File db_file
```
  - db
```
protected SQLiteDatabase db
```
  - lastSizeCheck
```
protected long lastSizeCheck
```
  - tileSize
```
long tileSize
```
    mean tile size computed on first use. Sizes are quite variable and a significant underestimate will result in too many tiles being purged.
  - hasInited
```
static boolean hasInited
```
- Constructor Detail
  - SqlTileWriter
```
public SqlTileWriter()
```
- Method Detail
  - setCleanupOnStart
```
public static void setCleanupOnStart(boolean value)
```
  - 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,
                        long pMapTileIndex,
                        InputStream pStream,
                        Long pExpirationTime)
```
    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
    
    pMapTileIndex - a tile
    
    pStream - an InputStream
    
    Returns:
  - exists
```
public boolean exists(String pTileSource,
                      long pMapTileIndex)
```
    Returns true if the given tile source and tile coordinates exist in the cache
    
    Since:
    
    5.6
  - exists
```
public boolean exists(ITileSource pTileSource,
                      long pMapTileIndex)
```
    Returns true if the given tile source and tile coordinates exist in the cache
    
    Specified by:
    
    exists in interface IFilesystemCache
    
    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,
                      long pMapTileIndex)
```
    Removes a specific tile from the cache
    
    Specified by:
    
    remove in interface IFilesystemCache
    
    Returns:
    
    true if it was removed, false otherwise
    
    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
  - getSize
```
public long getSize()
```
    Returns the size of the database file in bytes.
  - getFirstExpiry
```
public long getFirstExpiry()
```
    Returns the expiry time of the tile that expires first.
  - getIndex
```
public static long getIndex(long pX,
                            long pY,
                            long pZ)
```
    Parameters:
    
    pX -
    
    pY -
    
    pZ -
    
    Returns:
    
    Since:
    
    5.6.5
  - getIndex
```
public static long getIndex(long pMapTileIndex)
```
    Gets the single column index value for a map tile Unluckily, "map tile index" and "sql pk" don't match
    
    Parameters:
    
    pMapTileIndex -
    
    Since:
    
    5.6.5
  - getExpirationTimestamp
```
public Long getExpirationTimestamp(ITileSource pTileSource,
                                   long pMapTileIndex)
```
    Description copied from interface: IFilesystemCache
    
    Gets the cache expiration timestamp of a tile
    
    Specified by:
    
    getExpirationTimestamp in interface IFilesystemCache
    
    Returns:
    
    cache expiration timestamp in time since UTC epoch (in milliseconds), or null if expiration timestamp is not supported or if the tile is not cached
  - getPrimaryKey
```
public static String getPrimaryKey()
```
  - getPrimaryKeyParameters
```
public static String[] getPrimaryKeyParameters(long pIndex,
                                               ITileSource pTileSourceInfo)
```
    Parameters:
    
    pIndex -
    
    pTileSourceInfo -
    
    Returns:
    
    Since:
    
    5.6.5
  - getPrimaryKeyParameters
```
public static String[] getPrimaryKeyParameters(long pIndex,
                                               String pTileSourceInfo)
```
    Parameters:
    
    pIndex -
    
    pTileSourceInfo -
    
    Returns:
    
    Since:
    
    5.6.5
  - getTileCursor
```
public Cursor getTileCursor(String[] pPrimaryKeyParameters,
                            String[] pColumns)
```
    Parameters:
    
    pPrimaryKeyParameters -
    
    pColumns -
    
    Returns:
    
    Since:
    
    5.6.5
  - loadTile
```
public Drawable loadTile(ITileSource pTileSource,
                         long pMapTileIndex)
                  throws Exception
```
    Description copied from interface: IFilesystemCache
    
    Gets the tile drawable
    
    Specified by:
    
    loadTile in interface IFilesystemCache
    
    Throws:
    
    Exception

Class SqlTileWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATABASE_FILENAME

COLUMN_EXPIRES

db_file

db

lastSizeCheck

tileSize

hasInited

Constructor Detail

SqlTileWriter

Method Detail

setCleanupOnStart

runCleanupOperation

saveFile

exists

exists

onDetach

purgeCache

purgeCache

importFromFileCache

remove

getRowCount

getSize

getFirstExpiry

getIndex

getIndex

getExpirationTimestamp

getPrimaryKey

getPrimaryKeyParameters

getPrimaryKeyParameters

getTileCursor

loadTile