SqlTileWriter (osmdroid-android 6.1.2 API)

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

All Implemented Interfaces:

IFilesystemCache, SplashScreenable
```
public class SqlTileWriter
extends Object
implements IFilesystemCache, SplashScreenable
```
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`	`COLUMN_EXPIRES_INDEX`
`static String`	`DATABASE_FILENAME`
`protected static File`	`db_file`
`(package private) static boolean`	`hasInited`
`protected long`	`lastSizeCheck`
`protected static SQLiteDatabase`	`mDb`

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
`protected void`	`catchException(Exception pException)`
`long`	`delete(String pTileSourceName, int pZoom, Collection<Rect> pInclude, Collection<Rect> pExclude)` Delete cache tiles
`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
`protected static String`	`extractXFromKeyInSQL(int pZoom)`
`protected static String`	`extractYFromKeyInSQL(int pZoom)`
`protected SQLiteDatabase`	`getDb()`
`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`	`getRowCount(String pTileSourceName, int pZoom, Collection<Rect> pInclude, Collection<Rect> pExclude)` Count cache tiles
`protected long`	`getRowCount(String pWhereClause, String[] pWhereClauseArgs)` Count cache tiles: helper method
`long`	`getSize()` Returns the size of the database file in bytes.
`Cursor`	`getTileCursor(String[] pPrimaryKeyParameters, String[] pColumns)`
`protected StringBuilder`	`getWhereClause(int pZoom, Collection<Rect> pInclude, Collection<Rect> pExclude)`
`protected StringBuilder`	`getWhereClause(int pZoom, Rect pRect)`
`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.
`static boolean`	`isFunctionalException(SQLiteException pSQLiteException)`
`Drawable`	`loadTile(ITileSource pTileSource, long pMapTileIndex)` Gets the tile drawable
`void`	`onDetach()` Now we use only one static instance of database, which should never be closed
`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
`void`	`refreshDb()`
`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.
`void`	`runCleanupOperation(long pToBeDeleted, int pBulkSize, long pPauseMillis, boolean pIncludeUnexpired)`
`void`	`runDuringSplashScreen()`
`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
  - COLUMN_EXPIRES_INDEX
```
public static final String COLUMN_EXPIRES_INDEX
```
    See Also:
    
    Constant Field Values
  - db_file
```
protected static File db_file
```
  - mDb
```
protected static SQLiteDatabase mDb
```
  - lastSizeCheck
```
protected long lastSizeCheck
```
  - 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()
```
    Now we use only one static instance of database, which should never be closed
    
    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
  - getRowCount
```
protected long getRowCount(String pWhereClause,
                           String[] pWhereClauseArgs)
```
    Count cache tiles: helper method
    
    Returns:
    
    the number of tiles, or -1 if a problem occurred
    
    Since:
    
    6.0.2
  - getRowCount
```
public long getRowCount(String pTileSourceName,
                        int pZoom,
                        Collection<Rect> pInclude,
                        Collection<Rect> pExclude)
```
    Count cache tiles
    
    Parameters:
    
    pTileSourceName - the tile source name (possibly null)
    
    pZoom - the zoom level
    
    pInclude - a collection of bounding boxes to include (possibly null/empty)
    
    pExclude - a collection of bounding boxes to exclude (possibly null/empty)
    
    Returns:
    
    the number of corresponding tiles in the cache
    
    Since:
    
    6.0.2
  - 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)
```
    Returns:
    
    a composite key designed as a SQL primary key that includes X, Y and zoom
    
    Since:
    
    5.6.5
    
    See Also:
    
    extractXFromKeyInSQL(int), extractYFromKeyInSQL(int)
  - extractXFromKeyInSQL
```
protected static String extractXFromKeyInSQL(int pZoom)
```
    Returns:
    
    the SQL formula to extract X from the table key for a given zoom level
    
    Since:
    
    6.0.2
    
    See Also:
    
    getIndex(long, long, long)
  - extractYFromKeyInSQL
```
protected static String extractYFromKeyInSQL(int pZoom)
```
    Returns:
    
    the SQL formula to extract Y from the table key for a given zoom level
    
    Since:
    
    6.0.2
    
    See Also:
    
    getIndex(long, long, long)
  - 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
  - runCleanupOperation
```
public void runCleanupOperation(long pToBeDeleted,
                                int pBulkSize,
                                long pPauseMillis,
                                boolean pIncludeUnexpired)
```
    Parameters:
    
    pToBeDeleted - Amount of bytes to delete (as tile blob size)
    
    pBulkSize - Number of tiles to delete in bulk
    
    pPauseMillis - Pause between bulk actions, in order not to play it not aggressive on the CPU
    
    pIncludeUnexpired - Should we also delete tiles that are not expired?
    
    Since:
    
    6.0.2
  - getDb
```
protected SQLiteDatabase getDb()
```
    Since:
    
    6.0.2
  - refreshDb
```
public void refreshDb()
```
    Since:
    
    6.0.2
  - catchException
```
protected void catchException(Exception pException)
```
    Since:
    
    6.0.2
  - isFunctionalException
```
public static boolean isFunctionalException(SQLiteException pSQLiteException)
```
    Returns:
    
    true if it's a mere functional exception (poor SQL code for instance) and false if it's something potentially more serious (no more SQLite database for instance)
    
    Since:
    
    6.0.2
  - runDuringSplashScreen
```
public void runDuringSplashScreen()
```
    Specified by:
    
    runDuringSplashScreen in interface SplashScreenable
    
    Since:
    
    6.0.2
  - getWhereClause
```
protected StringBuilder getWhereClause(int pZoom,
                                       Rect pRect)
```
    Returns:
    
    the part of a SQL where clause used to restrict the selected tiles to - a zoom - a bounding box (possibly null)
    
    Since:
    
    6.0.2
  - getWhereClause
```
protected StringBuilder getWhereClause(int pZoom,
                                       Collection<Rect> pInclude,
                                       Collection<Rect> pExclude)
```
    Returns:
    
    the part of a SQL where clause used to restrict the selected tiles to - a zoom - a collection of bounding boxes to include (possibly null/empty) - a collection of bounding boxes to exclude (possibly null/empty)
    
    Since:
    
    6.0.2
  - delete
```
public long delete(String pTileSourceName,
                   int pZoom,
                   Collection<Rect> pInclude,
                   Collection<Rect> pExclude)
```
    Delete cache tiles
    
    Parameters:
    
    pTileSourceName - the tile source name (possibly null)
    
    pZoom - the zoom level
    
    pInclude - a collection of bounding boxes to include (possibly null/empty)
    
    pExclude - a collection of bounding boxes to exclude (possibly null/empty)
    
    Returns:
    
    the number of corresponding tiles deleted from the cache, or -1 if a problem occurred
    
    Since:
    
    6.0.2

Class SqlTileWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DATABASE_FILENAME

COLUMN_EXPIRES

COLUMN_EXPIRES_INDEX

db_file

mDb

lastSizeCheck

hasInited

Constructor Detail

SqlTileWriter

Method Detail

setCleanupOnStart

runCleanupOperation

saveFile

exists

exists

onDetach

purgeCache

purgeCache

importFromFileCache

remove

getRowCount

getRowCount

getRowCount

getSize

getFirstExpiry

getIndex

extractXFromKeyInSQL

extractYFromKeyInSQL

getIndex

getExpirationTimestamp

getPrimaryKey

getPrimaryKeyParameters

getPrimaryKeyParameters

getTileCursor

loadTile

runCleanupOperation

getDb

refreshDb

catchException

isFunctionalException

runDuringSplashScreen

getWhereClause

getWhereClause

delete