|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectGeoPackage
public class GeoPackage
Provides access to a GeoPackage database.
Nested Class Summary | |
---|---|
static class |
GeoPackage.DataType
|
Field Summary | |
---|---|
static String |
DATA_COLUMN_CONSTRAINTS
|
static String |
EXTENSIONS
|
static String |
GEOMETRY_COLUMNS
|
static String |
GEOPACKAGE_CONTENTS
|
static String |
METADATA
|
static String |
METADATA_REFERENCE
|
static String |
RASTER_COLUMNS
|
static String |
SPATIAL_REF_SYS
|
static String |
TILE_MATRIX_METADATA
|
static String |
TILE_MATRIX_SET
|
Constructor Summary | |
---|---|
GeoPackage()
Creates a new empty GeoPackage, generating a new file. |
|
GeoPackage(File file)
Creates a GeoPackage from an existing file. |
|
GeoPackage(File file,
String user,
String passwd)
Creates a GeoPackage from an existing file specifying database credentials. |
Method Summary | |
---|---|
void |
add(FeatureEntry entry,
SimpleFeatureCollection collection)
Adds a new feature dataset to the geopackage. |
void |
add(FeatureEntry entry,
SimpleFeatureSource source,
Filter filter)
Adds a new feature dataset to the geopackage. |
void |
add(RasterEntry entry,
GridCoverage2D raster,
AbstractGridFormat format)
Adds a new raster dataset to the geopackage. |
void |
add(TileEntry entry,
Tile tile)
Adds a tile to the geopackage. |
void |
addCRS(CoordinateReferenceSystem crs,
String auth,
int srid)
Adds a crs to the geopackage, registring it in the spatial_ref_sys table. |
void |
addCRS(int srid)
Adds an epsg crs to the geopackage, registering it in the spatial_ref_sys table. |
void |
close()
Closes the geopackage database connection. |
List<Entry> |
contents()
Returns list of contents of the geopackage. |
void |
create(FeatureEntry entry,
SimpleFeatureType schema)
Creates a new feature entry in the geopackage. |
void |
create(TileEntry entry)
Creates a new tile entry in the geopackage. |
FeatureEntry |
feature(String name)
Looks up a feature entry by name. |
List<FeatureEntry> |
features()
Lists all the feature entries in the geopackage. |
DataSource |
getDataSource()
The database data source. |
File |
getFile()
The underlying database file. |
int |
getTileBound(TileEntry entry,
int zoom,
boolean isMax,
boolean isRow)
Retrieve tile boundaries (min row, max row, min column and max column) for a particular zoom level, available in the actual data |
void |
init()
Initializes the geopackage database. |
RasterEntry |
raster(String name)
Looks up a raster entry by name. |
List<RasterEntry> |
rasters()
Lists all the raster entries in the geopackage. |
SimpleFeatureReader |
reader(FeatureEntry entry,
Filter filter,
Transaction tx)
Returns a reader for the contents of a feature dataset. |
GridCoverageReader |
reader(RasterEntry entry,
AbstractGridFormat format)
Returns a reader for the contents of a raster dataset. |
TileReader |
reader(TileEntry entry,
Integer lowZoom,
Integer highZoom,
Integer lowCol,
Integer highCol,
Integer lowRow,
Integer highRow)
Retrieve tiles within certain zooms and column/row boundaries |
TileEntry |
tile(String name)
Looks up a tile entry by name. |
List<TileEntry> |
tiles()
Lists all the tile entries in the geopackage. |
SimpleFeatureWriter |
writer(FeatureEntry entry,
boolean append,
Filter filter,
Transaction tx)
Returns a writer used to modify or add to the contents of a feature dataset. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String GEOPACKAGE_CONTENTS
public static final String GEOMETRY_COLUMNS
public static final String SPATIAL_REF_SYS
public static final String RASTER_COLUMNS
public static final String TILE_MATRIX_METADATA
public static final String METADATA
public static final String METADATA_REFERENCE
public static final String TILE_MATRIX_SET
public static final String DATA_COLUMN_CONSTRAINTS
public static final String EXTENSIONS
Constructor Detail |
---|
public GeoPackage() throws IOException
IOException
public GeoPackage(File file) throws IOException
This constructor assumes no credentials are required to connect to the database.
IOException
public GeoPackage(File file, String user, String passwd) throws IOException
IOException
Method Detail |
---|
public File getFile()
Note: this value may be null
depending on how the geopackage was initialized.
public DataSource getDataSource()
public void init() throws IOException
This method creates all the necessary metadata tables.
IOException
public void close()
The application should always call this method when done with a geopackage to prevent connection leakage.
public void addCRS(int srid) throws IOException
This method will look up the srid in the local epsg database. Use
#addCRS(CoordinateReferenceSystem, int)
to specify an explicit CRS, authority, code
entry.
IOException
public void addCRS(CoordinateReferenceSystem crs, String auth, int srid) throws IOException
crs
- The crs to add.auth
- The authority code, example: epsgsrid
- The spatial reference system id.
IOException
public List<Entry> contents()
public List<FeatureEntry> features() throws IOException
IOException
public FeatureEntry feature(String name) throws IOException
name
- THe name of the feature entry.
null
if no such entry exists.
IOException
public void create(FeatureEntry entry, SimpleFeatureType schema) throws IOException
The resulting feature dataset will be empty. The
#writer(FeatureEntry, boolean, Transaction)
method returns a writer object that can
be used to populate the dataset.
entry
- Contains metadata about the feature entry.schema
- The schema of the feature dataset.
IOException
- Any errors occurring while creating the new feature entry.public void add(FeatureEntry entry, SimpleFeatureCollection collection) throws IOException
entry
- Contains metadata about the feature entry.collection
- The simple feature collection to add to the geopackage.
IOException
- Any errors occurring while adding the new feature dataset.public void add(FeatureEntry entry, SimpleFeatureSource source, Filter filter) throws IOException
entry
- Contains metadata about the feature entry.source
- The dataset to add to the geopackage.filter
- Filter specifying what subset of feature dataset to include, may be
null
to specify no filter.
IOException
- Any errors occurring while adding the new feature dataset.public SimpleFeatureWriter writer(FeatureEntry entry, boolean append, Filter filter, Transaction tx) throws IOException
entry
- The feature entry.append
- Flag controlling whether to modify existing contents, or append to the dataset.filter
- Filter determining what subset of dataset to modify, only relevant when
append set to false. May be null
to specify no filter.tx
- Transaction object, may be null
to specify auto commit transaction.
IOException
public SimpleFeatureReader reader(FeatureEntry entry, Filter filter, Transaction tx) throws IOException
entry
- The feature entry.filter
- Filter Filter determining what subset of dataset to return. May be
null
to specify no filter.tx
- Transaction object, may be null
to specify auto commit transaction.
IOException
public List<RasterEntry> rasters() throws IOException
IOException
public RasterEntry raster(String name) throws IOException
name
- THe name of the raster entry.
null
if no such entry exists.
IOException
public void add(RasterEntry entry, GridCoverage2D raster, AbstractGridFormat format) throws IOException
entry
- Contains metadata about the raster entry.raster
- The raster dataset.format
- The format in which to store the raster in the database.
IOException
- Any errors occurring while adding the new feature dataset.public GridCoverageReader reader(RasterEntry entry, AbstractGridFormat format) throws IOException
entry
- The raster entry.format
- Format of the raster dataset.
IOException
public List<TileEntry> tiles() throws IOException
IOException
public TileEntry tile(String name) throws IOException
name
- THe name of the tile entry.
null
if no such entry exists.
IOException
public void create(TileEntry entry) throws IOException
entry
- The tile entry.
IOException
public void add(TileEntry entry, Tile tile) throws IOException
entry
- The tile metadata entry.tile
- The tile.
IOException
public TileReader reader(TileEntry entry, Integer lowZoom, Integer highZoom, Integer lowCol, Integer highCol, Integer lowRow, Integer highRow) throws IOException
entry
- the tile entrylowZoom
- low zoom boundaryhighZoom
- high zoom boundarylowCol
- low column boundaryhighCol
- high column boundarylowRow
- low row boundaryhighRow
- high row boundary
IOException
public int getTileBound(TileEntry entry, int zoom, boolean isMax, boolean isRow) throws IOException
entry
- The tile entryzoom
- the zoom levelisMax
- true for max boundary, false for min boundaryisRow
- true for rows, false for columns
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |