public class SpatiaLiteDialect extends BasicSQLDialect
| Modifier and Type | Field and Description |
|---|---|
static String |
SPATIALITE_SPATIAL_INDEX |
BASE_DBMS_CAPABILITIES, dataStore, LOGGER| Constructor and Description |
|---|
SpatiaLiteDialect(JDBCDataStore dataStore) |
| Modifier and Type | Method and Description |
|---|---|
void |
applyLimitOffset(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.
|
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,
int column,
GeometryFactory factory,
Connection cx,
Hints hints)
Decodes a geometry value from the result of a query specifying the column as an index.
|
Geometry |
decodeGeometryValue(GeometryDescriptor descriptor,
ResultSet rs,
String column,
GeometryFactory factory,
Connection cx,
Hints hints)
Decodes a geometry value from the result of a query.
|
void |
encodeGeometryColumn(GeometryDescriptor gatt,
String prefix,
int srid,
Hints hints,
StringBuffer sql)
Encodes the name of a geometry column in a SELECT statement.
|
void |
encodeGeometryEnvelope(String tableName,
String geometryColumn,
StringBuffer sql)
Encodes the spatial extent function of a geometry column in a SELECT statement.
|
void |
encodeGeometryValue(Geometry value,
int dimension,
int srid,
StringBuffer sql)
Encodes a geometry value in an sql 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.
|
Object |
getLastAutoGeneratedValue(String schemaName,
String tableName,
String columnName,
Connection cx)
Obtains the last value of an auto generated column.
|
Class<?> |
getMapping(ResultSet columnMetaData,
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.
|
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(SimpleFeatureType featureType,
DatabaseMetaData metadata,
String schemaName,
Connection cx)
Callback which executes after a feature type has been built from a database table.
|
void |
postCreateTable(String schemaName,
SimpleFeatureType featureType,
Connection cx)
Callback to execute any additional sql statements post a create table statement.
|
void |
postDropTable(String schemaName,
SimpleFeatureType featureType,
Connection cx)
Callback which executes after a table has been dropped.
|
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. *
Subclasses should extend (not override) this method to provide additional mappings, or to
override mappings provided by this implementation.
|
void |
registerSqlTypeToSqlTypeNameOverrides(Map<Integer,String> overrides)
Registers any overrides that should occur when mapping an integer sql type value to an
underlying sql type name.
|
encodeValue, onDelete, onInsert, onSelect, onUpdateaddSupportedHints, createCRS, createIndex, dropIndex, encodeAggregateFunction, encodeAggregateFunctionPostfix, encodeAggregateFunctionPrefix, encodeColumnAlias, encodeColumnName, encodeColumnName, encodeColumnType, encodeCreateTable, encodeGeometryColumn, encodeGeometryColumn, encodeGeometryColumnGeneralized, encodeGeometryColumnGeneralized, encodeGeometryColumnSimplified, encodeGeometryColumnSimplified, encodeJoin, encodeNextSequenceValue, encodePostColumnCreateTable, encodePostCreateTable, encodePostSelect, encodePrimaryKey, encodeSchemaName, encodeTableAlias, encodeTableName, getDefaultVarcharSize, getDesiredTablesType, getGeometryDimension, getIndexes, getLastAutoGeneratedValue, getNameEscape, getNextAutoGeneratedValue, getNextSequenceValue, getOptimizedBounds, getPkColumnValue, getPrimaryKey, getSequenceForColumn, handleSelectHints, handleUserDefinedType, isAggregatedSortSupported, isAutoCommitQuery, isGroupBySupported, ne, postCreateAttribute, preDropTable, registerAggregateFunctions, registerFunctions, registerSqlTypeNameToClassMappings, registerSqlTypeToClassMappings, splitFilter, supportsSchemaForIndexpublic static String SPATIALITE_SPATIAL_INDEX
public SpatiaLiteDialect(JDBCDataStore dataStore)
public void initializeConnection(Connection cx) throws SQLException
SQLDialectSubclasses 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.
initializeConnection in class SQLDialectcx - The new database connection.SQLExceptionpublic boolean includeTable(String schemaName, String tableName, Connection cx) throws SQLException
SQLDialect
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.
includeTable in class SQLDialectschemaName - The schema of the table, might be null..tableName - The name of the table.cx - Database connection.SQLExceptionpublic Class<?> getMapping(ResultSet columnMetaData, Connection cx) throws SQLException
SQLDialect
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)}.
getMapping in class SQLDialectcolumnMetaData - The column metadatanull.SQLExceptionpublic void registerClassToSqlMappings(Map<Class<?>,Integer> mappings)
SQLDialectSubclasses should extend (not override) this method to provide additional mappings, or to override mappings provided by this implementation. This implementation provides the following mappings:
registerClassToSqlMappings in class SQLDialectpublic void registerSqlTypeToSqlTypeNameOverrides(Map<Integer,String> overrides)
SQLDialectThe default implementation of this method does nothing. Subclasses should override in cases where:
Types)
registerSqlTypeToSqlTypeNameOverrides in class SQLDialectpublic String getGeometryTypeName(Integer type)
SQLDialectThe constant, type, is registered in SQLDialect.registerSqlTypeNameToClassMappings(Map).
This default implementation returns null, subclasses should override.
getGeometryTypeName in class SQLDialectpublic Integer getGeometrySRID(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
SQLDialectThis 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
.
getGeometrySRID in class SQLDialectschemaName - The database schema, could be null.tableName - The table, never null.columnName - The column name, never nullcx - The database connection.SQLExceptionpublic void encodeGeometryColumn(GeometryDescriptor gatt, String prefix, int srid, Hints hints, StringBuffer sql)
SQLDialectThis 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, String, StringBuffer) function.
Example:
sql.append( "asText(" );
column( gatt.getLocalName(), sql );
sql.append( ")" );
This default implementation calls the deprecated SQLDialect.encodeGeometryColumn(GeometryDescriptor, String, int, StringBuffer) version of this method
for backward compatibility reasons.
encodeGeometryColumn in class SQLDialectpublic Geometry decodeGeometryValue(GeometryDescriptor descriptor, ResultSet rs, int column, GeometryFactory factory, Connection cx, Hints hints) throws IOException, SQLException
SQLDialectSee #decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory)
for a more in depth description.
decodeGeometryValue in class SQLDialectIOExceptionSQLException#decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory)}.public void encodeGeometryValue(Geometry value,
int dimension,
int srid,
StringBuffer sql)
throws IOException
BasicSQLDialectAn 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.
Attention should be paid to emtpy geometries (g.isEmtpy() == true) as they
cannot be encoded in WKB and several databases fail to handle them property. Common treatment
is to equate them to NULL
encodeGeometryValue in class BasicSQLDialectIOExceptionpublic Geometry decodeGeometryValue(GeometryDescriptor descriptor, ResultSet rs, String column, GeometryFactory factory, Connection cx, Hints hints) throws IOException, SQLException
SQLDialectThis 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:
Note that implementations must handle
String wkt = rs.getString( column );
if ( wkt == null ) {
return null;
}
return new WKTReader(factory).read( wkt );
null values.
The factory parameter should be used to instantiate any geometry objects.
decodeGeometryValue in class SQLDialectIOExceptionSQLExceptionpublic void encodeGeometryEnvelope(String tableName, String geometryColumn, StringBuffer sql)
SQLDialectThis method must also be sure to properly encode the name of the column with the SQLDialect.encodeColumnName(String, StringBuffer) function.
encodeGeometryEnvelope in class SQLDialectpublic Envelope decodeGeometryEnvelope(ResultSet rs, int column, Connection cx) throws SQLException, IOException
SQLDialectThis 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.
decodeGeometryEnvelope in class SQLDialectrs - A result setcolumn - Index into the result set which points at the spatial extent value.SQLExceptionIOExceptionpublic void postCreateTable(String schemaName, SimpleFeatureType featureType, Connection cx) throws SQLException, IOException
SQLDialectThis 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.
postCreateTable in class SQLDialectschemaName - The name of the schema, may be null.featureType - The feature type that has just been created on the database.cx - Database connection.SQLExceptionIOExceptionpublic void postCreateFeatureType(SimpleFeatureType featureType, DatabaseMetaData metadata, String schemaName, Connection cx) throws SQLException
SQLDialectThis base implementation does nothing, subclasses should override as need be.
postCreateFeatureType in class SQLDialectfeatureType - The build feature type.metadata - The database metadata.schemaName - The name of the database scheam containing the table containing the columncx - The database connection.SQLExceptionpublic void postDropTable(String schemaName, SimpleFeatureType featureType, Connection cx) throws SQLException
SQLDialectThis base implementation does nothing, subclasses should override as need be.
postDropTable in class SQLDialectschemaName - The database schema containing the table.featureType - The featureType/table being dropped.cx - The database connection.SQLExceptionpublic boolean lookupGeneratedValuesPostInsert()
SQLDialectWhen 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:
lookupGeneratedValuesPostInsert in class SQLDialectpublic Object getLastAutoGeneratedValue(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
SQLDialectThis 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.
getLastAutoGeneratedValue in class SQLDialectschemaName - The schema name, this might be null.tableName - The name of the table.columnName - The column.cx - The database connection.null.SQLExceptionpublic boolean isLimitOffsetSupported()
SQLDialectisLimitOffsetSupported in class SQLDialectpublic void applyLimitOffset(StringBuffer sql, int limit, int offset)
SQLDialectapplyLimitOffset in class SQLDialectpublic FilterToSQL createFilterToSQL()
BasicSQLDialectSublcasses can override this method to return a subclass of FilterToSQL if need
be.
createFilterToSQL in class BasicSQLDialectCopyright © 1996–2018 Geotools. All rights reserved.