org.geotools.data.spatialite
Class SpatiaLiteDialect

java.lang.Object
  extended by org.geotools.jdbc.SQLDialect
      extended by org.geotools.jdbc.BasicSQLDialect
          extended by org.geotools.data.spatialite.SpatiaLiteDialect

public class SpatiaLiteDialect
extends BasicSQLDialect

Dialect for SpatiaLite embedded database.

Author:
Justin Deoliveira, OpenGeo

Field Summary
static java.lang.String SPATIALITE_SPATIAL_INDEX
           
 
Fields inherited from class org.geotools.jdbc.SQLDialect
BASE_DBMS_CAPABILITIES, dataStore, LOGGER
 
Constructor Summary
SpatiaLiteDialect(JDBCDataStore dataStore)
           
 
Method Summary
 void applyLimitOffset(java.lang.StringBuffer sql, int limit, int offset)
          Alters the query provided so that limit and offset are natively dealt with.
 FilterToSQL createFilterToSQL()
          Creates the filter encoder to be used by the datastore when encoding query predicates.
 com.vividsolutions.jts.geom.Envelope decodeGeometryEnvelope(java.sql.ResultSet rs, int column, java.sql.Connection cx)
          Decodes the result of a spatial extent function in a SELECT statement.
 com.vividsolutions.jts.geom.Geometry decodeGeometryValue(org.opengis.feature.type.GeometryDescriptor descriptor, java.sql.ResultSet rs, int column, com.vividsolutions.jts.geom.GeometryFactory factory, java.sql.Connection cx)
          Decodes a geometry value from the result of a query specifying the column as an index.
 com.vividsolutions.jts.geom.Geometry decodeGeometryValue(org.opengis.feature.type.GeometryDescriptor descriptor, java.sql.ResultSet rs, java.lang.String column, com.vividsolutions.jts.geom.GeometryFactory factory, java.sql.Connection cx)
          Decodes a geometry value from the result of a query.
 void encodeGeometryColumn(org.opengis.feature.type.GeometryDescriptor gatt, int srid, java.lang.StringBuffer sql)
          Encodes the name of a geometry column in a SELECT statement.
 void encodeGeometryEnvelope(java.lang.String tableName, java.lang.String geometryColumn, java.lang.StringBuffer sql)
          Encodes the spatial extent function of a geometry column in a SELECT statement.
 void encodeGeometryValue(com.vividsolutions.jts.geom.Geometry value, int srid, java.lang.StringBuffer sql)
          Encodes a geometry value in an sql statement.
 java.lang.Integer getGeometrySRID(java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.sql.Connection cx)
          Returns the spatial reference system identifier (srid) for a particular geometry column.
 java.lang.String getGeometryTypeName(java.lang.Integer type)
          Returns the name of a geometric type based on its integer constant.
 java.lang.Object getLastAutoGeneratedValue(java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.sql.Connection cx)
          Obtains the last value of an auto generated column.
 java.lang.Class<?> getMapping(java.sql.ResultSet columnMetaData, java.sql.Connection cx)
          Determines the class mapping for a particular column of a table.
 void initializeConnection(java.sql.Connection cx)
          Initializes a newly created database connection.
 boolean isLimitOffsetSupported()
          Returns true if this dialect can encode both Query.getStartIndex() and Query.getMaxFeatures() into native SQL.
 boolean lookupGeneratedValuesPostInsert()
          Controls whether keys are looked up post or pre insert.
 void postCreateFeatureType(org.opengis.feature.simple.SimpleFeatureType featureType, java.sql.DatabaseMetaData metadata, java.lang.String schemaName, java.sql.Connection cx)
          Callback which executes after a feature type has been built from a database table.
 void postCreateTable(java.lang.String schemaName, org.opengis.feature.simple.SimpleFeatureType featureType, java.sql.Connection cx)
          Callback to execute any additional sql statements post a create table statement.
 void registerClassToSqlMappings(java.util.Map<java.lang.Class<?>,java.lang.Integer> mappings)
          Registers the java type to sql type mappings that the datastore uses when reading and writing objects to and from the database.
 
Methods inherited from class org.geotools.jdbc.BasicSQLDialect
encodeValue
 
Methods inherited from class org.geotools.jdbc.SQLDialect
addSupportedHints, createCRS, encodeColumnAlias, encodeColumnName, encodeColumnType, encodeGeometryColumnGeneralized, encodeGeometryColumnSimplified, encodePostColumnCreateTable, encodePostCreateTable, encodePrimaryKey, encodeSchemaName, encodeTableAlias, encodeTableName, getNameEscape, getNextAutoGeneratedValue, getNextSequenceValue, getSequenceForColumn, includeTable, ne, postCreateAttribute, registerAggregateFunctions, registerSqlTypeNameToClassMappings, registerSqlTypeToClassMappings, registerSqlTypeToSqlTypeNameOverrides
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SPATIALITE_SPATIAL_INDEX

public static java.lang.String SPATIALITE_SPATIAL_INDEX
Constructor Detail

SpatiaLiteDialect

public SpatiaLiteDialect(JDBCDataStore dataStore)
Method Detail

initializeConnection

public void initializeConnection(java.sql.Connection cx)
                          throws java.sql.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:
java.sql.SQLException

getMapping

public java.lang.Class<?> getMapping(java.sql.ResultSet columnMetaData,
                                     java.sql.Connection cx)
                              throws java.sql.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:
columnMetaData - The column metadata
Returns:
The class mapped to the to column, or null.
Throws:
java.sql.SQLException

registerClassToSqlMappings

public void registerClassToSqlMappings(java.util.Map<java.lang.Class<?>,java.lang.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

getGeometryTypeName

public java.lang.String getGeometryTypeName(java.lang.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

getGeometrySRID

public java.lang.Integer getGeometrySRID(java.lang.String schemaName,
                                         java.lang.String tableName,
                                         java.lang.String columnName,
                                         java.sql.Connection cx)
                                  throws java.sql.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:
java.sql.SQLException

encodeGeometryColumn

public void encodeGeometryColumn(org.opengis.feature.type.GeometryDescriptor gatt,
                                 int srid,
                                 java.lang.StringBuffer sql)
Description copied from class: SQLDialect
Encodes the name of a geometry column in a SELECT statement.

This method should wrap the column name in any functions that are used to retrieve its value. For instance, often it is necessary to use the function asText, or asWKB when fetching a geometry.

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

Example:

   
   sql.append( "asText(" );
   column( gatt.getLocalName(), sql );
   sql.append( ")" );
   
 

This default implementation simply uses the column name without any wrapping function, subclasses must override.

Overrides:
encodeGeometryColumn in class SQLDialect

decodeGeometryValue

public com.vividsolutions.jts.geom.Geometry decodeGeometryValue(org.opengis.feature.type.GeometryDescriptor descriptor,
                                                                java.sql.ResultSet rs,
                                                                int column,
                                                                com.vividsolutions.jts.geom.GeometryFactory factory,
                                                                java.sql.Connection cx)
                                                         throws java.io.IOException,
                                                                java.sql.SQLException
Description copied from class: SQLDialect
Decodes a geometry value from the result of a query specifying the column as an index.

See #decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory) for a more in depth description.

Overrides:
decodeGeometryValue in class SQLDialect
Throws:
java.io.IOException
java.sql.SQLException
See Also:
#decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory)}.

encodeGeometryValue

public void encodeGeometryValue(com.vividsolutions.jts.geom.Geometry value,
                                int srid,
                                java.lang.StringBuffer sql)
                         throws java.io.IOException
Description copied from class: BasicSQLDialect
Encodes a geometry value in an sql statement.

An implementations should serialize value into some exchange format which will then be transported to the underlying database. For example, consider an implementation which converts a geometry into its well known text representation:

   
   sql.append( "GeomFromText('" );
   sql.append( new WKTWriter().write( value ) );
   sql.append( ")" );
   
  

The srid parameter is the spatial reference system identifier of the geometry, or 0 if not known.

Specified by:
encodeGeometryValue in class BasicSQLDialect
Throws:
java.io.IOException

decodeGeometryValue

public com.vividsolutions.jts.geom.Geometry decodeGeometryValue(org.opengis.feature.type.GeometryDescriptor descriptor,
                                                                java.sql.ResultSet rs,
                                                                java.lang.String column,
                                                                com.vividsolutions.jts.geom.GeometryFactory factory,
                                                                java.sql.Connection cx)
                                                         throws java.io.IOException,
                                                                java.sql.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:
java.io.IOException
java.sql.SQLException

encodeGeometryEnvelope

public void encodeGeometryEnvelope(java.lang.String tableName,
                                   java.lang.String geometryColumn,
                                   java.lang.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 com.vividsolutions.jts.geom.Envelope decodeGeometryEnvelope(java.sql.ResultSet rs,
                                                                   int column,
                                                                   java.sql.Connection cx)
                                                            throws java.sql.SQLException,
                                                                   java.io.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:
java.sql.SQLException
java.io.IOException

postCreateTable

public void postCreateTable(java.lang.String schemaName,
                            org.opengis.feature.simple.SimpleFeatureType featureType,
                            java.sql.Connection cx)
                     throws java.sql.SQLException,
                            java.io.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:

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:
java.sql.SQLException
java.io.IOException

postCreateFeatureType

public void postCreateFeatureType(org.opengis.feature.simple.SimpleFeatureType featureType,
                                  java.sql.DatabaseMetaData metadata,
                                  java.lang.String schemaName,
                                  java.sql.Connection cx)
                           throws java.sql.SQLException
Description copied from class: SQLDialect
Callback which executes after a feature type has been built from a database table.

This base implementation does nothing, subclasses should override as need be.

Overrides:
postCreateFeatureType in class SQLDialect
Parameters:
featureType - The build feature type.
metadata - The database metadata.
schemaName - The name of the database scheam containing the table containing the column
cx - The database connection.
Throws:
java.sql.SQLException

lookupGeneratedValuesPostInsert

public boolean lookupGeneratedValuesPostInsert()
Description copied from class: SQLDialect
Controls whether keys are looked up post or pre insert.

When a row is inserted into a table, and a key is automatically generated it can be looked up before the insert occurs, or after the insert has been made. Returning false will cause the lookup to occur before the insert via SQLDialect.getNextAutoGeneratedValue(String, String, String, Connection). Returning true will cause the lookup to occur after the insert via SQLDialect.getLastAutoGeneratedValue(String, String, String, Connection).

Subclasses returning false should implement:

Subclasses returning true should implement:

Overrides:
lookupGeneratedValuesPostInsert in class SQLDialect

getLastAutoGeneratedValue

public java.lang.Object getLastAutoGeneratedValue(java.lang.String schemaName,
                                                  java.lang.String tableName,
                                                  java.lang.String columnName,
                                                  java.sql.Connection cx)
                                           throws java.sql.SQLException
Description copied from class: SQLDialect
Obtains the last value of an auto generated column.

This method is only called when SQLDialect.lookupGeneratedValuesPostInsert() returns true. Implementations should determine the previous value of a column for which was automatically generated by the database.

This method is given a direct connection to the database, but this connection should never be closed. However any statements or result sets instantiated from the connection must be closed.

Implementations should handle the case where schemaName is null.

Overrides:
getLastAutoGeneratedValue in class SQLDialect
Parameters:
schemaName - The schema name, this might be null.
tableName - The name of the table.
columnName - The column.
cx - The database connection.
Returns:
The previous value of the column, or null.
Throws:
java.sql.SQLException

isLimitOffsetSupported

public boolean isLimitOffsetSupported()
Description copied from class: SQLDialect
Returns true if this dialect can encode both Query.getStartIndex() and Query.getMaxFeatures() into native SQL.

Overrides:
isLimitOffsetSupported in class SQLDialect
Returns:

applyLimitOffset

public void applyLimitOffset(java.lang.StringBuffer sql,
                             int limit,
                             int offset)
Description copied from class: SQLDialect
Alters the query provided so that limit and offset are natively dealt with. This might mean simply appending some extra directive to the query, or wrapping it into a bigger one.

Overrides:
applyLimitOffset in class SQLDialect

createFilterToSQL

public FilterToSQL createFilterToSQL()
Description copied from class: BasicSQLDialect
Creates the filter encoder to be used by the datastore when encoding query predicates.

Sublcasses can override this method to return a subclass of FilterToSQL if need be.

Overrides:
createFilterToSQL in class BasicSQLDialect


Copyright © 1996-2010 Geotools. All Rights Reserved.