org.geotools.mbtiles

Class MBTilesFile

Object

MBTilesFile

All Implemented Interfaces:

AutoCloseable

public class MBTilesFile
extends Object
implements AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MBTilesFile.TileIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSource	connPool connection pool
protected JDBCDataStore	dataStore datastore for vector access, lazily created
protected boolean	disableJournal Boolean indicating if journal must be disabled or not
protected File	file database file
protected static Logger	LOGGER Logger
protected String	MD_ATTRIBUTION
protected String	MD_BOUNDS
protected String	MD_DESCRIPTION
protected String	MD_FORMAT
protected String	MD_MAXZOOM
protected String	MD_MINZOOM
protected String	MD_NAME
protected String	MD_TYPE
protected String	MD_VERSION
static String	PRAGMA_JOURNAL_MODE_OFF
protected String	TABLE_GRID_DATA
protected String	TABLE_GRIDS
protected String	TABLE_METADATA
protected String	TABLE_TILES

Constructor Summary

Constructors

Constructor and Description
MBTilesFile() Creates a new empty MbTilesFile, generating a new file.
MBTilesFile(boolean disableJournal) Creates a new empty MbTilesFile, generating a new file, also deciding if journal must be disabled or not.
MBTilesFile(DataSource dataSource) Create an MBTilesFile from an SQL DataSource connected to an MBTiles file.
MBTilesFile(File file) Creates a MbTilesFile from an existing file.
MBTilesFile(File file, boolean disableJournal) Creates a MbTilesFile from an existing file, also deciding if journal must be disabled or not.
MBTilesFile(File file, String user, String passwd, boolean disableJournal) Creates a MbTilesFile from an existing file specifying database credentials.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the mbtiles database connection.
long	closestZoom(long zoomLevel)
File	getFile() The underlying database file.
void	init() Initializes the mbtiles database.
protected void	init(Connection cx) Initializes a mbtiles connection.
MBTilesGrid	loadGrid(long zoomLevel, long column, long row)
MBTilesGrid	loadGrid(MBTilesGrid entry)
MBTilesMetadata	loadMetaData()
MBTilesMetadata	loadMetaData(MBTilesMetadata metaData)
protected String	loadMetaDataEntry(String name, Connection cx)
MBTilesTile	loadTile(long zoomLevel, long column, long row)
MBTilesTile	loadTile(MBTilesTile entry)
long	maxColumn(long zoomLevel)
long	maxRow(long zoomLevel)
long	maxZoom()
long	minColumn(long zoomLevel)
long	minRow(long zoomLevel)
long	minZoom()
int	numberOfTiles()
int	numberOfTiles(long zoomLevel)
protected void	runScript(String filename, Connection cx)
void	saveGrid(MBTilesGrid entry) Store a grid
void	saveMetaData(MBTilesMetadata metaData) Store MetaData in file
protected void	saveMetaDataEntry(String name, String value, Connection cx)
void	saveMinMaxZoomMetadata(int min, int max) Save the minimum and maximum zoom level as metadata items.
void	saveTile(MBTilesTile entry) Store a tile
MBTilesFile.TileIterator	tiles()
MBTilesFile.TileIterator	tiles(long zoomLevel)
MBTilesFile.TileIterator	tiles(long zoomLevel, long leftTile, long bottomTile, long rightTile, long topTile)

Methods inherited from class Object

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

Field Detail

PRAGMA_JOURNAL_MODE_OFF

public static final String PRAGMA_JOURNAL_MODE_OFF

See Also:

Constant Field Values

TABLE_METADATA

protected final String TABLE_METADATA

See Also:

Constant Field Values

TABLE_TILES

protected final String TABLE_TILES

See Also:

Constant Field Values

TABLE_GRIDS

protected final String TABLE_GRIDS

See Also:

Constant Field Values

TABLE_GRID_DATA

protected final String TABLE_GRID_DATA

See Also:

Constant Field Values

MD_NAME

protected final String MD_NAME

See Also:

Constant Field Values

MD_TYPE

protected final String MD_TYPE

See Also:

Constant Field Values

MD_VERSION

protected final String MD_VERSION

See Also:

Constant Field Values

MD_DESCRIPTION

protected final String MD_DESCRIPTION

See Also:

Constant Field Values

MD_FORMAT

protected final String MD_FORMAT

See Also:

Constant Field Values

MD_BOUNDS

protected final String MD_BOUNDS

See Also:

Constant Field Values

MD_ATTRIBUTION

protected final String MD_ATTRIBUTION

See Also:

Constant Field Values

MD_MINZOOM

protected final String MD_MINZOOM

See Also:

Constant Field Values

MD_MAXZOOM

protected final String MD_MAXZOOM

See Also:

Constant Field Values

LOGGER

protected static final Logger LOGGER

Logger

file

protected File file

database file

connPool

protected final DataSource connPool

connection pool

dataStore

protected volatile JDBCDataStore dataStore

datastore for vector access, lazily created

disableJournal

protected boolean disableJournal

Boolean indicating if journal must be disabled or not

Constructor Detail

MBTilesFile

public MBTilesFile()
            throws IOException

Creates a new empty MbTilesFile, generating a new file.

Throws:

IOException

MBTilesFile

public MBTilesFile(boolean disableJournal)
            throws IOException

Creates a new empty MbTilesFile, generating a new file, also deciding if journal must be disabled or not.

This constructor assumes no credentials are required to connect to the database.

Throws:

IOException

MBTilesFile

public MBTilesFile(File file)
            throws IOException

Creates a MbTilesFile from an existing file.

This constructor assumes no credentials are required to connect to the database.

Throws:

IOException

MBTilesFile

public MBTilesFile(File file,
                   boolean disableJournal)
            throws IOException

Creates a MbTilesFile from an existing file, also deciding if journal must be disabled or not.

This constructor assumes no credentials are required to connect to the database.

Throws:

IOException

MBTilesFile

public MBTilesFile(File file,
                   String user,
                   String passwd,
                   boolean disableJournal)
            throws IOException

Creates a MbTilesFile from an existing file specifying database credentials.

Throws:

IOException

MBTilesFile

public MBTilesFile(DataSource dataSource)

Create an MBTilesFile from an SQL DataSource connected to an MBTiles file. Behaviour is undefined if the DataSource is any other form of database.

Parameters:

dataSource -

Method Detail

saveMetaData

public void saveMetaData(MBTilesMetadata metaData)
                  throws IOException

Store MetaData in file

Parameters:

metaData -

Throws:

IOException

saveMinMaxZoomMetadata

public void saveMinMaxZoomMetadata(int min,
                                   int max)
                            throws IOException

Save the minimum and maximum zoom level as metadata items. GDAL and QGIS expect these items.

Parameters:

min - The minimum zoom level

max - The maximum zoom level

Throws:

IOException

saveTile

public void saveTile(MBTilesTile entry)
              throws IOException

Store a tile

Throws:

IOException

saveGrid

public void saveGrid(MBTilesGrid entry)
              throws IOException

Store a grid

Throws:

IOException

loadMetaData

public MBTilesMetadata loadMetaData()
                             throws IOException

Throws:

IOException

loadMetaData

public MBTilesMetadata loadMetaData(MBTilesMetadata metaData)
                             throws IOException

Throws:

IOException

loadTile

public MBTilesTile loadTile(long zoomLevel,
                            long column,
                            long row)
                     throws IOException

Throws:

IOException

loadTile

public MBTilesTile loadTile(MBTilesTile entry)
                     throws IOException

Throws:

IOException

loadGrid

public MBTilesGrid loadGrid(long zoomLevel,
                            long column,
                            long row)
                     throws IOException

Throws:

IOException

loadGrid

public MBTilesGrid loadGrid(MBTilesGrid entry)
                     throws IOException

Throws:

IOException

tiles

public MBTilesFile.TileIterator tiles()
                               throws SQLException

Throws:

SQLException

tiles

public MBTilesFile.TileIterator tiles(long zoomLevel)
                               throws SQLException

Throws:

SQLException

tiles

public MBTilesFile.TileIterator tiles(long zoomLevel,
                                      long leftTile,
                                      long bottomTile,
                                      long rightTile,
                                      long topTile)
                               throws SQLException

Throws:

SQLException

numberOfTiles

public int numberOfTiles()
                  throws SQLException

Throws:

SQLException

numberOfTiles

public int numberOfTiles(long zoomLevel)
                  throws SQLException

Throws:

SQLException

closestZoom

public long closestZoom(long zoomLevel)
                 throws SQLException

Throws:

SQLException

minZoom

public long minZoom()
             throws SQLException

Throws:

SQLException

maxZoom

public long maxZoom()
             throws SQLException

Throws:

SQLException

minColumn

public long minColumn(long zoomLevel)
               throws SQLException

Throws:

SQLException

maxColumn

public long maxColumn(long zoomLevel)
               throws SQLException

Throws:

SQLException

minRow

public long minRow(long zoomLevel)
            throws SQLException

Throws:

SQLException

maxRow

public long maxRow(long zoomLevel)
            throws SQLException

Throws:

SQLException

close

public void close()

Closes the mbtiles database connection.

The application should always call this method when done with a mbtiles to prevent connection leakage.

Specified by:

close in interface AutoCloseable

getFile

public File getFile()

The underlying database file.

Note: this value may be null depending on how the geopackage was initialized.

saveMetaDataEntry

protected void saveMetaDataEntry(String name,
                                 String value,
                                 Connection cx)
                          throws SQLException

Throws:

SQLException

loadMetaDataEntry

protected String loadMetaDataEntry(String name,
                                   Connection cx)
                            throws SQLException

Throws:

SQLException

init

public void init()
          throws IOException

Initializes the mbtiles database.

This method creates all the necessary tables.

Throws:

IOException

init

protected void init(Connection cx)
             throws SQLException

Initializes a mbtiles connection.

This method creates all the necessary tables.

Throws:

SQLException

runScript

protected void runScript(String filename,
                         Connection cx)
                  throws SQLException

Throws:

SQLException