public class H2Dialect extends SQLDialect
H2DialectBasic and H2DialectPrepared which implements the common
parts of the dialect api.| Modifier and Type | Field and Description |
|---|---|
static String |
H2_SPATIAL_INDEX |
BASE_DBMS_CAPABILITIES, dataStore, LOGGER| Constructor and Description |
|---|
H2Dialect(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.
|
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,
Hints hints)
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.
|
void |
encodeGeometryValue(Geometry value,
int srid,
StringBuffer sql) |
String |
encodeNextSequenceValue(String schemaName,
String sequenceName)
Encodes how to get the next sequence value from the DB.
|
void |
encodePostColumnCreateTable(AttributeDescriptor att,
StringBuffer sql)
Encodes anything post a column in a CREATE TABLE statement.
|
void |
encodePrimaryKey(String column,
StringBuffer sql)
Encodes the primary key definition in a CREATE TABLE statement.
|
Integer |
getGeometrySRID(String schemaName,
String tableName,
String columnName,
Connection cx)
Returns the spatial reference system identifier (srid) for a particular geometry column.
|
Class<?> |
getMapping(ResultSet columnMetaData,
Connection cx)
Determines the class mapping for a particular column of a table.
|
String |
getNameEscape()
Returns the string used to escape names.
|
Object |
getNextAutoGeneratedValue(String schemaName,
String tableName,
String columnName,
Connection cx)
Obtains the next value of an auto generated column.
|
Object |
getNextSequenceValue(String schemaName,
String sequenceName,
Connection cx)
Obtains the next value of a sequence, incrementing the sequence to the next state in the
process.
|
String |
getSequenceForColumn(String schemaName,
String tableName,
String columnName,
Connection cx)
Determines the name of the sequence (if any) which is used to increment generate values for a
table column.
|
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.
|
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 |
preDropTable(String schemaName,
SimpleFeatureType featureType,
Connection cx)
Callback which executes before a table is about to be 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 |
registerSqlTypeToClassMappings(Map<Integer,Class<?>> mappings)
Registers the sql type to java type mappings that the dialect uses when reading and writing
objects to and from the database.
|
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.
|
protected boolean |
supportsSchemaForIndex()
Return
true if the database supports individual schemas for indices. |
addSupportedHints, canSimplifyPoints, convertValue, createCRS, createIndex, decodeGeometryValue, dropIndex, encodeColumnAlias, encodeColumnName, encodeColumnType, encodeCreateTable, encodeGeometryColumn, encodeGeometryColumnGeneralized, encodeGeometryColumnSimplified, encodeJoin, encodePostCreateTable, encodePostSelect, encodeSchemaName, encodeTableAlias, encodeTableName, escapeName, getAggregateConverter, getDefaultVarcharSize, getDesiredTablesType, getGeometryDimension, getGeometryTypeName, getIndexes, getLastAutoGeneratedValue, getLastAutoGeneratedValue, getOptimizedBounds, getPkColumnValue, getPrimaryKey, getRestrictions, getResultTypes, getSQLType, handleSelectHints, handleUserDefinedType, isAggregatedSortSupported, isArray, isAutoCommitQuery, isGroupBySupported, lookupGeneratedValuesPostInsert, ne, postCreateAttribute, postDropTable, registerAggregateFunctions, registerSqlTypeNameToClassMappings, splitFilterpublic static String H2_SPATIAL_INDEX
public H2Dialect(JDBCDataStore dataStore)
public String getNameEscape()
SQLDialectThis value is used to escape any name in a query. This includes columns, tables, schemas,
indexes, etc... If no escape is necessary this method should return the empty string, and
never return null.
This default implementation returns a single double quote ("), subclasses must override to provide a different espcape.
getNameEscape in class SQLDialectpublic 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 metadatacx - The connection used to retrieve the metadatanull.SQLExceptionpublic void encodePostColumnCreateTable(AttributeDescriptor att, StringBuffer sql)
SQLDialectThis is appended after the column name and type. Subclasses may choose to override this method, the default implementation does nothing.
encodePostColumnCreateTable in class SQLDialectatt - The attribute corresponding to the column.public void registerSqlTypeToClassMappings(Map<Integer,Class<?>> 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:
registerSqlTypeToClassMappings in class SQLDialectpublic 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 postCreateTable(String schemaName, SimpleFeatureType featureType, Connection cx) throws SQLException
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.SQLExceptionpublic 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 preDropTable(String schemaName, SimpleFeatureType featureType, Connection cx) throws SQLException
SQLDialectThis base implementation does nothing, subclasses should override as need be.
preDropTable in class SQLDialectschemaName - The database schema containing the table.featureType - The featureType/table being dropped.cx - The database connection.SQLExceptionpublic 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 encodeGeometryEnvelope(String tableName, String geometryColumn, StringBuffer sql)
SQLDialectThis method must also be sure to properly encode the name of the column with the #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.cx - The database connection.SQLExceptionIOExceptionpublic void encodeGeometryValue(Geometry value,
int srid,
StringBuffer sql)
throws IOException
IOExceptionpublic 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 encodePrimaryKey(String column, StringBuffer sql)
SQLDialectSubclasses should override this method if need be, the default implementation does the following:
encodeColumnName( column, sql );
sql.append( " int PRIMARY KEY" );
encodePrimaryKey in class SQLDialectpublic String getSequenceForColumn(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
SQLDialectThis method should return null if no such sequence exists.
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.
getSequenceForColumn in class SQLDialectschemaName - The schema name, this might be null.tableName - The table name.columnName - The column name.cx - The database connection.SQLExceptionpublic Object getNextSequenceValue(String schemaName, String sequenceName, Connection cx) throws SQLException
SQLDialectImplementations should determine the next value of a column for which values are 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.
getNextSequenceValue in class SQLDialectschemaName - The schema name, this might be null.sequenceName - The name of the sequence.cx - The database connection.null.SQLExceptionpublic String encodeNextSequenceValue(String schemaName, String sequenceName)
SQLDialectImplementations should handle the case where schemaName is null.
encodeNextSequenceValue in class SQLDialectpublic Object getNextAutoGeneratedValue(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
SQLDialectImplementations should determine the next value of a column for which values are 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.
getNextAutoGeneratedValue 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 SQLDialectprotected boolean supportsSchemaForIndex()
SQLDialecttrue if the database supports individual schemas for indices.
The SQL encoding would be CREATE INDEX SCHEMANAME.INDEXNAME ON ....
The default is false and the encoding is CREATE INDEX INDEXNAME ON ....
supportsSchemaForIndex 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 SQLDialectCopyright © 1996–2021 Geotools. All rights reserved.