public class PostGISPSDialect extends PreparedStatementSQLDialect
BASE_DBMS_CAPABILITIES, dataStore, LOGGER| Constructor and Description |
|---|
PostGISPSDialect(JDBCDataStore store,
PostGISDialect delegate) |
| 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.
|
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)
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)
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 |
encodeGeometryColumn(GeometryDescriptor gatt,
String prefix,
int srid,
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.
|
String |
encodeNextSequenceValue(String schemaName,
String sequenceName)
Encodes how to get the next sequence value from the DB.
|
void |
encodePrimaryKey(String column,
StringBuffer sql)
Encodes the primary key definition in a CREATE TABLE statement.
|
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 |
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.
|
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 |
handleUserDefinedType(ResultSet columnMetaData,
ColumnMetadata metadata,
Connection cx)
Handles the mapping for a user defined type.
|
boolean |
includeTable(String schemaName,
String tableName,
Connection cx)
Determines if the specified table should be included in those published
by the datastore.
|
boolean |
isAggregatedSortSupported(String function)
Returns true if this dialect supports sorting together
with the given aggregation function.
|
boolean |
isEncodeBBOXFilterAsEnvelope() |
boolean |
isLimitOffsetSupported()
Returns true if this dialect can encode both Query.getStartIndex()
and Query.getMaxFeatures() into native SQL.
|
boolean |
isLooseBBOXEnabled() |
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
|
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 |
registerSqlTypeToSqlTypeNameOverrides(Map<Integer,String> overrides)
Registers any overrides that should occur when mapping an integer sql type
value to an underlying sql type name.
|
void |
setEncodeBBOXFilterAsEnvelope(boolean encodeBBOXFilterAsEnvelope) |
void |
setGeometryValue(Geometry g,
int dimension,
int srid,
Class binding,
PreparedStatement ps,
int column)
Sets the geometry value into the prepared statement.
|
void |
setLooseBBOXEnabled(boolean looseBBOXEnabled) |
onDelete, onInsert, onSelect, onUpdate, prepareFunctionArgument, prepareGeometryValue, setValueaddSupportedHints, createCRS, createIndex, dropIndex, encodeColumnAlias, encodeColumnName, encodeColumnName, encodeColumnType, encodeCreateTable, encodeGeometryColumn, encodeGeometryColumnGeneralized, encodeGeometryColumnGeneralized, encodeGeometryColumnSimplified, encodeGeometryColumnSimplified, encodeJoin, encodePostColumnCreateTable, encodePostCreateTable, encodePostSelect, encodeSchemaName, encodeTableAlias, encodeTableName, getDefaultVarcharSize, getDesiredTablesType, getIndexes, getLastAutoGeneratedValue, getNameEscape, getOptimizedBounds, getPrimaryKey, handleSelectHints, initializeConnection, isAutoCommitQuery, isGroupBySupported, ne, postCreateAttribute, postCreateFeatureType, registerAggregateFunctions, registerSqlTypeToClassMappings, splitFilter, supportsSchemaForIndexpublic PostGISPSDialect(JDBCDataStore store, PostGISDialect delegate)
public boolean isAggregatedSortSupported(String function)
SQLDialectisAggregatedSortSupported in class SQLDialectpublic 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 Envelope decodeGeometryEnvelope(ResultSet rs, int column, Connection cx) throws SQLException, IOException
SQLDialect
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.
decodeGeometryEnvelope in class SQLDialectrs - A result setcolumn - Index into the result set which points at the spatial extent
value.SQLExceptionIOExceptionpublic Geometry decodeGeometryValue(GeometryDescriptor descriptor, ResultSet rs, int column, GeometryFactory factory, Connection cx) throws IOException, SQLException
SQLDialect
See #decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory)
for a more in depth description.
decodeGeometryValue in class SQLDialectIOExceptionSQLException#decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory)}.public Geometry decodeGeometryValue(GeometryDescriptor descriptor, ResultSet rs, String column, GeometryFactory factory, Connection cx) 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 encodeGeometryColumn(GeometryDescriptor gatt, String prefix, int srid, StringBuffer sql)
SQLDialect
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, 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.
encodeGeometryColumn in class SQLDialectpublic void encodeGeometryColumn(GeometryDescriptor gatt, String prefix, int srid, Hints hints, StringBuffer sql)
SQLDialect
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, 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 void encodeGeometryEnvelope(String tableName, String geometryColumn, StringBuffer sql)
SQLDialect
This method must also be sure to properly encode the name of the column
with the SQLDialect.encodeColumnName(String, StringBuffer) function.
encodeGeometryEnvelope in class SQLDialectpublic 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 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 String getGeometryTypeName(Integer type)
SQLDialect
The constant, type, is registered in SQLDialect.registerSqlTypeNameToClassMappings(Map).
This default implementation returns null, subclasses should
override.
getGeometryTypeName in class SQLDialectpublic 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 boolean lookupGeneratedValuesPostInsert()
SQLDialect
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:
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 Object getLastAutoGeneratedValue(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
SQLDialect
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.
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 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)
SQLDialect
Implementations should handle the case where schemaName is null.
encodeNextSequenceValue 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 boolean isLooseBBOXEnabled()
public 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 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 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 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 registerSqlTypeToSqlTypeNameOverrides(Map<Integer,String> overrides)
SQLDialectThe default implementation of this method does nothing. Subclasses should override in cases where:
Types)
registerSqlTypeToSqlTypeNameOverrides in class SQLDialectpublic void handleUserDefinedType(ResultSet columnMetaData, ColumnMetadata metadata, Connection cx) throws SQLException
SQLDialect
This method is called after SQLDialect.getMapping(ResultSet, Connection) but before the rest
of the type mapping heuristics are applied.
Implementing this method is optional. It is used to allow for handling user defined types or "DOMAINS". Dialects that implement this method should set the appropriate information on the metadata object to allow the column to be mapped via teh regular type mapping heuristics.
handleUserDefinedType in class SQLDialectcolumnMetaData - The column metdata.metadata - The column metadata object that collections mapping information.cx - The database connection, not to be closed.SQLExceptionpublic void setLooseBBOXEnabled(boolean looseBBOXEnabled)
public boolean isEncodeBBOXFilterAsEnvelope()
public void setEncodeBBOXFilterAsEnvelope(boolean encodeBBOXFilterAsEnvelope)
public 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 PreparedFilterToSQL createPreparedFilterToSQL()
createPreparedFilterToSQL in class PreparedStatementSQLDialectpublic boolean isLimitOffsetSupported()
SQLDialectisLimitOffsetSupported in class SQLDialectpublic void applyLimitOffset(StringBuffer sql, int limit, int offset)
SQLDialectapplyLimitOffset in class SQLDialectpublic 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.SQLExceptionCopyright © 1996–2017 Geotools. All rights reserved.