public class HanaDialect extends PreparedStatementSQLDialect
BASE_DBMS_CAPABILITIES, dataStore, LOGGER| Constructor and Description |
|---|
HanaDialect(JDBCDataStore dataStore) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addSupportedHints(Set<Hints.Key> hints)
Add hints to the JDBC Feature Source.
|
void |
applyLimitOffset(StringBuffer sql,
int limit,
int offset)
Alters the query provided so that limit and offset are natively dealt with.
|
CoordinateReferenceSystem |
createCRS(int srid,
Connection cx)
Turns the specified srid into a
CoordinateReferenceSystem, or returns null
if not possible. |
PreparedFilterToSQL |
createPreparedFilterToSQL() |
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 |
encodeCreateTable(StringBuffer sql)
Encodes the CREATE TABLE statement.
|
void |
encodeGeometryColumn(GeometryDescriptor gatt,
String prefix,
int srid,
Hints hints,
StringBuffer sql)
Encodes the name of a geometry column in a SELECT statement.
|
void |
encodeGeometryColumnSimplified(GeometryDescriptor gatt,
String prefix,
int srid,
StringBuffer sql,
Double distance) |
void |
encodeGeometryEnvelope(String tableName,
String geometryColumn,
StringBuffer sql)
Encodes the spatial extent function of a geometry column in a SELECT statement.
|
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.
|
int |
getDefaultVarcharSize()
Determines the default length that a varchar field should be when creating datastore tables
from feature types.
|
String[] |
getDesiredTablesType() |
int |
getGeometryDimension(String schemaName,
String tableName,
String columnName,
Connection cx)
Returns the dimension of the coordinates in the geometry.
|
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 |
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.
|
void |
handleSelectHints(StringBuffer sql,
SimpleFeatureType featureType,
Query query)
Used to apply search hints on the fully generated SQL (complete of select, from, where, sort,
limit/offset)
|
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 |
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 |
preDropTable(String schemaName,
SimpleFeatureType featureType,
Connection cx)
Callback which executes before a table is about to be dropped.
|
void |
prepareGeometryValue(Class<? extends Geometry> gClass,
int dimension,
int srid,
Class binding,
StringBuffer sql)
Prepares the geometry value for a prepared 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. *
Subclasses should extend (not override) this method to provide additional mappings, or to
override mappings provided by this implementation.
|
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 |
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 |
setFunctionEncodingEnabled(boolean enabled) |
void |
setGeometryValue(Geometry g,
int dimension,
int srid,
Class binding,
PreparedStatement ps,
int column)
Sets the geometry value into the prepared statement.
|
void |
setValue(Object value,
Class binding,
PreparedStatement ps,
int column,
Connection cx)
Sets a value in a prepared statement, for "basic types" (non-geometry).
|
protected boolean |
supportsSchemaForIndex()
Return
true if the database supports individual schemas for indices. |
convert, convertArrayElement, convertToArray, getArrayComponentTypeName, onDelete, onInsert, onSelect, onUpdate, prepareFunctionArgument, prepareGeometryValue, setArrayValuecanSimplifyPoints, createIndex, dropIndex, encodeColumnAlias, encodeColumnName, encodeColumnType, encodeGeometryColumnGeneralized, encodeJoin, encodePostCreateTable, encodePostSelect, encodeSchemaName, encodeTableAlias, encodeTableName, escapeName, getIndexes, getLastAutoGeneratedValue, getLastAutoGeneratedValue, getMapping, getNameEscape, getOptimizedBounds, getPkColumnValue, getPrimaryKey, handleUserDefinedType, isAggregatedSortSupported, isAutoCommitQuery, isGroupBySupported, ne, postCreateAttribute, postCreateFeatureType, registerAggregateFunctions, registerSqlTypeToSqlTypeNameOverrides, splitFilterpublic HanaDialect(JDBCDataStore dataStore)
public void setFunctionEncodingEnabled(boolean enabled)
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 void registerSqlTypeNameToClassMappings(Map<String,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:
registerSqlTypeNameToClassMappings in class SQLDialectpublic 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 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 int getGeometryDimension(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 dimension cannot be determined, this method should return 2
getGeometryDimension in class SQLDialectschemaName - The database schema, could be null.tableName - The table, never null.columnName - The column name, never nullcx - The database connection.SQLExceptionpublic CoordinateReferenceSystem createCRS(int srid, Connection cx) throws SQLException
SQLDialectCoordinateReferenceSystem, 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
createCRS in class SQLDialectSQLExceptionpublic 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 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( ")" );
encodeGeometryColumn in class SQLDialectpublic void encodeGeometryColumnSimplified(GeometryDescriptor gatt, String prefix, int srid, StringBuffer sql, Double distance)
encodeGeometryColumnSimplified in class SQLDialectpublic 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 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 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 void encodeCreateTable(StringBuffer sql)
SQLDialectDefault implementation adds "CREATE TABLE" to the sql buffer. Subclasses may choose to override to handle db specific syntax.
encodeCreateTable in class SQLDialectpublic 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 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 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 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 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 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 boolean isLimitOffsetSupported()
SQLDialectisLimitOffsetSupported in class SQLDialectpublic void applyLimitOffset(StringBuffer sql, int limit, int offset)
SQLDialectapplyLimitOffset in class SQLDialectprotected void addSupportedHints(Set<Hints.Key> hints)
SQLDialectpossible hints (but not limited to)
addSupportedHints in class SQLDialectpublic int getDefaultVarcharSize()
SQLDialectSome dialects allow no length to be specified for varchar fields (PostGIS for example) however others require a maximum length to be set.
Subclasses can override this method and either return -1 to specify that no length is required, or otherwise return an appropriate default length for varchars of that dialect.
getDefaultVarcharSize 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 handleSelectHints(StringBuffer sql, SimpleFeatureType featureType, Query query)
SQLDialecthandleSelectHints in class SQLDialectpublic String[] getDesiredTablesType()
getDesiredTablesType in class SQLDialectDatabaseMetaDatapublic void prepareGeometryValue(Class<? extends Geometry> gClass, int dimension, int srid, Class binding, StringBuffer sql)
PreparedStatementSQLDialectThis method should be overridden if the implementation needs to wrap the geometry placeholder in the function. The default implementationg just appends the default placeholder: '?'.
prepareGeometryValue in class PreparedStatementSQLDialectgClass - The geometry class.dimension - The dimensions (2,3,4) of the coordinates, or -1 if unknownsrid - The spatial reference system of the geometry, or -1 if unknownbinding - The class of the geometry.sql - The prepared sql statement buffer.public void setGeometryValue(Geometry g,
int dimension,
int srid,
Class binding,
PreparedStatement ps,
int column)
throws SQLException
PreparedStatementSQLDialectsetGeometryValue in class PreparedStatementSQLDialectg - The geometrysrid - the geometry native srid (should be forced into the encoded geometry)binding - the geometry typeps - the prepared statementcolumn - the column index where the geometry is to be setSQLExceptionpublic void setValue(Object value, Class binding, PreparedStatement ps, int column, Connection cx) throws SQLException
PreparedStatementSQLDialectSubclasses should override this method if they need to do something custom or they wish to support non-standard types.
setValue in class PreparedStatementSQLDialectvalue - the value.binding - The class of the value.ps - The prepared statement.column - The column the value maps to.cx - The database connection.SQLExceptionpublic PreparedFilterToSQL createPreparedFilterToSQL()
createPreparedFilterToSQL in class PreparedStatementSQLDialectCopyright © 1996–2020 Geotools. All rights reserved.