org.geotools.geopkg
Class GeoPkgDialect

Object
  extended by SQLDialect
      extended by PreparedStatementSQLDialect
          extended by GeoPkgDialect

public class GeoPkgDialect
extends PreparedStatementSQLDialect


Field Summary
 
Fields inherited from class SQLDialect
BASE_DBMS_CAPABILITIES, dataStore, LOGGER
 
Constructor Summary
GeoPkgDialect(JDBCDataStore dataStore)
           
 
Method Summary
 CoordinateReferenceSystem createCRS(int srid, Connection cx)
          Turns the specified srid into a CoordinateReferenceSystem, or returns null if not possible.
 Envelope decodeGeometryEnvelope(ResultSet rs, int column, Connection cx)
          Decodes the result of a spatial extent function in a SELECT statement.
 Geometry decodeGeometryValue(GeometryDescriptor descriptor, ResultSet rs, String column, GeometryFactory factory, Connection cx)
          Decodes a geometry value from the result of a query.
 void encodeGeometryEnvelope(String tableName, String geometryColumn, StringBuffer sql)
          Encodes the spatial extent function of a geometry column in a SELECT statement.
 Integer getGeometrySRID(String schemaName, String tableName, String columnName, Connection cx)
          Returns the spatial reference system identifier (srid) for a particular geometry column.
 String getGeometryTypeName(Integer type)
          Returns the name of a geometric type based on its integer constant.
 Class<?> getMapping(ResultSet columns, Connection cx)
          Determines the class mapping for a particular column of a table.
 boolean includeTable(String schemaName, String tableName, Connection cx)
          Determines if the specified table should be included in those published by the datastore.
 void initializeConnection(Connection cx)
          Initializes a newly created database connection.
 void postCreateTable(String schemaName, SimpleFeatureType featureType, Connection cx)
          Callback to execute any additional sql statements post a create table statement.
 void registerClassToSqlMappings(Map<Class<?>,Integer> mappings)
          Registers the java type to sql type mappings that the datastore uses when reading and writing objects to and from the database
 void registerSqlTypeNameToClassMappings(Map<String,Class<?>> mappings)
          Registers the sql type name to java type mappings that the dialect uses when reading and writing objects to and from the database.
 void setGeometryValue(Geometry g, int dimension, int srid, Class binding, PreparedStatement ps, int column)
          Sets the geometry value into the prepared statement.
 
Methods inherited from class PreparedStatementSQLDialect
createPreparedFilterToSQL, onDelete, onInsert, onSelect, onUpdate, prepareFunctionArgument, prepareGeometryValue, setValue
 
Methods inherited from class SQLDialect
addSupportedHints, applyLimitOffset, createIndex, decodeGeometryValue, dropIndex, encodeColumnAlias, encodeColumnName, encodeColumnName, encodeColumnType, encodeGeometryColumn, encodeGeometryColumn, encodeGeometryColumn, encodeGeometryColumnGeneralized, encodeGeometryColumnGeneralized, encodeGeometryColumnSimplified, encodeGeometryColumnSimplified, encodeJoin, encodePostColumnCreateTable, encodePostCreateTable, encodePostSelect, encodePrimaryKey, encodeSchemaName, encodeTableAlias, encodeTableName, getDefaultVarcharSize, getGeometryDimension, getIndexes, getLastAutoGeneratedValue, getNameEscape, getNextAutoGeneratedValue, getNextSequenceValue, getOptimizedBounds, getSequenceForColumn, handleUserDefinedType, isAutoCommitQuery, isLimitOffsetSupported, lookupGeneratedValuesPostInsert, ne, postCreateAttribute, postCreateFeatureType, postDropTable, preDropTable, registerAggregateFunctions, registerSqlTypeToClassMappings, registerSqlTypeToSqlTypeNameOverrides
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GeoPkgDialect

public GeoPkgDialect(JDBCDataStore dataStore)
Method Detail

initializeConnection

public void initializeConnection(Connection cx)
                          throws SQLException
Description copied from class: SQLDialect
Initializes a newly created database connection.

Subclasses should override this method if there is some additional action that needs to be taken when a new connection to the database is created. The default implementation does nothing.

Overrides:
initializeConnection in class SQLDialect
Parameters:
cx - The new database connection.
Throws:
SQLException

includeTable

public boolean includeTable(String schemaName,
                            String tableName,
                            Connection cx)
                     throws SQLException
Description copied from class: SQLDialect
Determines if the specified table should be included in those published by the datastore.

This method returns true if the table should be published as a feature type, otherwise it returns false. Subclasses should override this method, this default implementation returns true.

A database connection is provided to the dialect but it should not be closed. However any statements objects or result sets that are instantiated from it must be closed.

Overrides:
includeTable in class SQLDialect
Parameters:
schemaName - The schema of the table, might be null..
tableName - The name of the table.
cx - Database connection.
Throws:
SQLException

encodeGeometryEnvelope

public void encodeGeometryEnvelope(String tableName,
                                   String geometryColumn,
                                   StringBuffer sql)
Description copied from class: SQLDialect
Encodes the spatial extent function of a geometry column in a SELECT statement.

This method must also be sure to properly encode the name of the column with the SQLDialect.encodeColumnName(String, StringBuffer) function.

Specified by:
encodeGeometryEnvelope in class SQLDialect

decodeGeometryEnvelope

public Envelope decodeGeometryEnvelope(ResultSet rs,
                                       int column,
                                       Connection cx)
                                throws SQLException,
                                       IOException
Description copied from class: SQLDialect
Decodes the result of a spatial extent function in a SELECT statement.

This method is given direct access to a result set. The column parameter is the index into the result set which contains the spatial extent value. The query for this value is build with the SQLDialect.encodeGeometryEnvelope(String, String, StringBuffer) method.

This method must not read any other objects from the result set other then the one referenced by column.

Specified by:
decodeGeometryEnvelope in class SQLDialect
Parameters:
rs - A result set
column - Index into the result set which points at the spatial extent value.
Throws:
SQLException
IOException

decodeGeometryValue

public Geometry decodeGeometryValue(GeometryDescriptor descriptor,
                                    ResultSet rs,
                                    String column,
                                    GeometryFactory factory,
                                    Connection cx)
                             throws IOException,
                                    SQLException
Description copied from class: SQLDialect
Decodes a geometry value from the result of a query.

This method is given direct access to a result set. The column parameter is the index into the result set which contains the geometric value.

An implementation should deserialize the value provided by the result set into Geometry object. For example, consider an implementation which deserializes from well known text:

   String wkt = rs.getString( column );
   if ( wkt == null ) {
     return null;
   }
   return new WKTReader(factory).read( wkt );
   
Note that implementations must handle null values.

The factory parameter should be used to instantiate any geometry objects.

Specified by:
decodeGeometryValue in class SQLDialect
Throws:
IOException
SQLException

setGeometryValue

public void setGeometryValue(Geometry g,
                             int dimension,
                             int srid,
                             Class binding,
                             PreparedStatement ps,
                             int column)
                      throws SQLException
Description copied from class: PreparedStatementSQLDialect
Sets the geometry value into the prepared statement.

Specified by:
setGeometryValue in class PreparedStatementSQLDialect
Parameters:
g - The geometry
srid - the geometry native srid (should be forced into the encoded geometry)
binding - the geometry type
ps - the prepared statement
column - the column index where the geometry is to be set
Throws:
SQLException

getGeometryTypeName

public String getGeometryTypeName(Integer type)
Description copied from class: SQLDialect
Returns the name of a geometric type based on its integer constant.

The constant, type, is registered in SQLDialect.registerSqlTypeNameToClassMappings(Map).

This default implementation returns null, subclasses should override.

Overrides:
getGeometryTypeName in class SQLDialect

registerSqlTypeNameToClassMappings

public void registerSqlTypeNameToClassMappings(Map<String,Class<?>> mappings)
Description copied from class: SQLDialect
Registers the sql type name to java type mappings that the dialect uses when reading and writing objects to and from the database.

Subclasses should extend (not override) this method to provide additional mappings, or to override mappings provided by this implementation. This implementation provides the following mappings:

Overrides:
registerSqlTypeNameToClassMappings in class SQLDialect

registerClassToSqlMappings

public void registerClassToSqlMappings(Map<Class<?>,Integer> mappings)
Description copied from class: SQLDialect
Registers the java type to sql type mappings that the datastore uses when reading and writing objects to and from the database. *

Subclasses should extend (not override) this method to provide additional mappings, or to override mappings provided by this implementation. This implementation provides the following mappings:

Overrides:
registerClassToSqlMappings in class SQLDialect

getMapping

public Class<?> getMapping(ResultSet columns,
                           Connection cx)
                    throws SQLException
Description copied from class: SQLDialect
Determines the class mapping for a particular column of a table.

Implementing this method is optional. It is used to allow database to perform custom type mappings based on various column metadata. It is called before the mappings registered in SQLDialect.registerSqlTypeToClassMappings(Map) and #registerSqlTypeNameToClassMappings(Map) are used to determine the mapping. Subclasses should implement as needed, this default implementation returns null.

The columnMetaData argument is provided from {@link DatabaseMetaData#getColumns(String, String, String, String)}.

Overrides:
getMapping in class SQLDialect
Parameters:
columns - The column metadata
Returns:
The class mapped to the to column, or null.
Throws:
SQLException

postCreateTable

public void postCreateTable(String schemaName,
                            SimpleFeatureType featureType,
                            Connection cx)
                     throws SQLException,
                            IOException
Description copied from class: SQLDialect
Callback to execute any additional sql statements post a create table statement.

This method should be implemented by subclasses that need to do some post processing on the database after a table has been created. Examples might include:

  • Creating a sequence for a primary key
  • Registering geometry column metadata
  • Creating a spatial index

A common case is creating an auto incrementing sequence for the primary key of a table. It should be noted that all tables created through the datastore use the column "fid" as the primary key.

A direct connection to the database is provided (cx). This connection must not be closed, however any statements or result sets instantiated from the connection must be closed.

Overrides:
postCreateTable in class SQLDialect
Parameters:
schemaName - The name of the schema, may be null.
featureType - The feature type that has just been created on the database.
cx - Database connection.
Throws:
SQLException
IOException

getGeometrySRID

public Integer getGeometrySRID(String schemaName,
                               String tableName,
                               String columnName,
                               Connection cx)
                        throws SQLException
Description copied from class: SQLDialect
Returns the spatial reference system identifier (srid) for a particular geometry column.

This method is given a direct connection to the database. The connection must not be closed. However any statements or result sets instantiated from the connection must be closed.

In the event that the srid cannot be determined, this method should return null.

Overrides:
getGeometrySRID in class SQLDialect
Parameters:
schemaName - The database schema, could be null.
tableName - The table, never null.
columnName - The column name, never null
cx - The database connection.
Throws:
SQLException

createCRS

public CoordinateReferenceSystem createCRS(int srid,
                                           Connection cx)
                                    throws SQLException
Description copied from class: SQLDialect
Turns the specified srid into a CoordinateReferenceSystem, or returns null if not possible.

The implementation might just use CRS.decode("EPSG:" + srid), but most spatial databases will have their own SRS database that can be queried as well.

As a rule of thumb you should override this method if your spatial database uses codes that are not part of the EPSG standard database, of if for some reason you deem it preferable to use your database definition instead of an official EPSG one.

Most overrides will try out to decode the official EPSG code first, and fall back on the custom database definition otherwise

Overrides:
createCRS in class SQLDialect
Returns:
Throws:
SQLException


Copyright © 1996-2014 Geotools. All Rights Reserved.