public class PostGISDialect extends BasicSQLDialect
Modifier and Type | Field and Description |
---|---|
static String |
BIGDATE_UDT |
BASE_DBMS_CAPABILITIES, dataStore, forceLongitudeFirst, LOGGER, UNWRAPPER_NOT_FOUND, uwMap
Constructor and Description |
---|
PostGISDialect(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.
|
boolean |
canGroupOnGeometry()
Returns true if this database can "group by" on a Geometry column.
|
boolean |
canSimplifyPoints()
Returns if points can be returned in simplified form (e.g reduced precision, like TWKB
encoding)
|
CoordinateReferenceSystem |
createCRS(int srid,
Connection cx)
Using PostGIS table spatial_ref_sys to determine authority name and code of srid
|
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 |
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.
|
void |
encodeGeometryValue(Geometry value,
int dimension,
int srid,
StringBuffer sql)
Encodes a geometry value in an sql 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.
|
void |
encodeValue(Object value,
Class type,
StringBuffer sql)
Encodes a value in an sql statement.
|
int |
getDefaultVarcharSize()
Determines the default length that a varchar field should be when creating datastore tables
from feature types.
|
String[] |
getDesiredTablesType() |
protected Integer |
getDimensionFromFirstGeo(String schemaName,
String tableName,
String columnName,
Connection cx) |
protected String |
getEstimatedExtentFunction()
Returns "ST_EstimatedExtent" if PostGIS version is >= 2.1.0, otherwise "ST_Estimated_Extent"
|
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 |
getNextSequenceValue(String schemaName,
String sequenceName,
Connection cx)
Obtains the next value of a sequence, incrementing the sequence to the next state in the
process.
|
List<ReferencedEnvelope> |
getOptimizedBounds(String schema,
SimpleFeatureType featureType,
Connection cx)
Returns the bounds of all geometry columns in the layer using any approach that proves to be
faster than the plain bounds aggregation (e.g., better than the "plain select extent(geom)
from table" on PostGIS), or null if none exists or the fast method has not been enabled
(e.g., if the fast method is just an estimate of the bounds you probably want the user to
enable it manually)
|
Version |
getPostgreSQLVersion(Connection conn)
Returns the PostgreSQL version
|
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.
|
Version |
getVersion(Connection conn)
Returns the PostGIS version
|
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.
|
void |
initializeConnection(Connection cx)
Initializes a newly created database connection.
|
boolean |
isAggregatedSortSupported(String function)
Returns true if this dialect supports sorting together with the given aggregation function.
|
boolean |
isEncodeBBOXFilterAsEnvelope() |
boolean |
isEscapeBackslash() |
boolean |
isEstimatedExtentsEnabled() |
boolean |
isFunctionEncodingEnabled() |
boolean |
isLimitOffsetSupported()
Returns true if this dialect can encode both Query.getStartIndex() and
Query.getMaxFeatures() into native SQL.
|
boolean |
isLooseBBOXEnabled() |
boolean |
isSimplifyEnabled() |
protected boolean |
isStraightSegmentsGeometry(GeometryDescriptor gatt) |
boolean |
isTopologyPreserved() |
boolean |
lookupGeneratedValuesPostInsert()
Controls whether keys are looked up post or pre insert.
|
void |
postCreateTable(String schemaName,
SimpleFeatureType featureType,
Connection cx)
Creates GEOMETRY_COLUMN registrations and spatial indexes for all geometry columns
|
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 |
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 |
setEstimatedExtentsEnabled(boolean estimatedExtentsEnabled) |
void |
setFunctionEncodingEnabled(boolean functionEncodingEnabled) |
void |
setLooseBBOXEnabled(boolean looseBBOXEnabled) |
void |
setSimplifyEnabled(boolean simplifyEnabled)
Enables/disables usage of ST_Simplify geometry wrapping when the Query contains a geometry
simplification hint
|
void |
setTopologyPreserved(boolean topologyPreserved)
Enables/disables usage of ST_SimplifyPreserveTopology, instead of ST_Simplify when
simplification has to be applied.
|
Filter[] |
splitFilter(Filter filter,
SimpleFeatureType schema)
Splits the filter into two parts, an encodable one, and a non encodable one.
|
onDelete, onInsert, onSelect, onUpdate
applyHintsOnVirtualTables, convertValue, createIndex, dropIndex, encodeColumnAlias, encodeColumnName, encodeColumnType, encodeCreateTable, encodeGeometryColumnGeneralized, encodeJoin, encodePostColumnCreateTable, encodePostCreateTable, encodePostSelect, encodeSchemaName, encodeTableAlias, encodeTableName, escapeName, getAggregateConverter, getIndexes, getLastAutoGeneratedValue, getMapping, getNameEscape, getNextAutoGeneratedValue, getPkColumnValue, getPrimaryKey, getRestrictions, getResultTypes, getSQLType, handleSelectHints, isArray, isAutoCommitQuery, isGroupBySupported, ne, postCreateAttribute, postCreateFeatureType, preDropTable, registerAggregateFunctions, registerSqlTypeToClassMappings, supportsSchemaForIndex, unwrapConnection
public static final String BIGDATE_UDT
public PostGISDialect(JDBCDataStore dataStore)
public boolean isAggregatedSortSupported(String function)
SQLDialect
isAggregatedSortSupported
in class SQLDialect
public boolean isLooseBBOXEnabled()
public void setLooseBBOXEnabled(boolean looseBBOXEnabled)
public boolean isEncodeBBOXFilterAsEnvelope()
public void setEncodeBBOXFilterAsEnvelope(boolean encodeBBOXFilterAsEnvelope)
public boolean isEstimatedExtentsEnabled()
public void setEstimatedExtentsEnabled(boolean estimatedExtentsEnabled)
public boolean isFunctionEncodingEnabled()
public void setFunctionEncodingEnabled(boolean functionEncodingEnabled)
public boolean isSimplifyEnabled()
public boolean isEscapeBackslash()
public boolean canSimplifyPoints()
SQLDialect
canSimplifyPoints
in class SQLDialect
public void setSimplifyEnabled(boolean simplifyEnabled)
public boolean isTopologyPreserved()
public void setTopologyPreserved(boolean topologyPreserved)
topologyPreserved
- public void initializeConnection(Connection cx) throws SQLException
SQLDialect
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.
initializeConnection
in class SQLDialect
cx
- The new database connection.SQLException
public 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 SQLDialect
schemaName
- The schema of the table, might be null
..tableName
- The name of the table.cx
- Database connection.SQLException
public Geometry decodeGeometryValue(GeometryDescriptor descriptor, ResultSet rs, String column, GeometryFactory factory, Connection cx, Hints hints) throws IOException, SQLException
SQLDialect
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:
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 SQLDialect
IOException
SQLException
public Geometry decodeGeometryValue(GeometryDescriptor descriptor, ResultSet rs, int column, GeometryFactory factory, Connection cx, Hints hints) throws IOException, SQLException
SQLDialect
See #decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory)
for a more in depth description.
decodeGeometryValue
in class SQLDialect
IOException
SQLException
#decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory)}.
public 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( ")" );
encodeGeometryColumn
in class SQLDialect
public void encodeGeometryColumnSimplified(GeometryDescriptor gatt, String prefix, int srid, StringBuffer sql, Double distance)
encodeGeometryColumnSimplified
in class SQLDialect
protected boolean isStraightSegmentsGeometry(GeometryDescriptor gatt)
public 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 #encodeColumnName(String, StringBuffer)
function.
encodeGeometryEnvelope
in class SQLDialect
public List<ReferencedEnvelope> getOptimizedBounds(String schema, SimpleFeatureType featureType, Connection cx) throws SQLException, IOException
SQLDialect
getOptimizedBounds
in class SQLDialect
schema
- The database schema, if any, or nullfeatureType
- The feature type containing the geometry columns whose bounds need to
computed. Mind, it may be retyped and thus contain less geometry columns than the tableSQLException
IOException
public 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 SQLDialect
rs
- A result setcolumn
- Index into the result set which points at the spatial extent value.cx
- The database connection.SQLException
IOException
public 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 SQLDialect
columnMetaData
- The column metadatacx
- The connection used to retrieve the metadatanull
.SQLException
public 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 the regular type mapping heuristics.
handleUserDefinedType
in class SQLDialect
columnMetaData
- The column metdata.metadata
- The column metadata object that collections mapping information.cx
- The database connection, not to be closed.SQLException
public CoordinateReferenceSystem createCRS(int srid, Connection cx) throws SQLException
createCRS
in class SQLDialect
SQLException
public Integer getGeometrySRID(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
SQLDialect
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
.
getGeometrySRID
in class SQLDialect
schemaName
- The database schema, could be null
.tableName
- The table, never null
.columnName
- The column name, never null
cx
- The database connection.SQLException
public int getGeometryDimension(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
SQLDialect
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 dimension cannot be determined, this method should return 2
getGeometryDimension
in class SQLDialect
schemaName
- The database schema, could be null
.tableName
- The table, never null
.columnName
- The column name, never null
cx
- The database connection.SQLException
protected Integer getDimensionFromFirstGeo(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
SQLException
public String getSequenceForColumn(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
SQLDialect
This 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 SQLDialect
schemaName
- The schema name, this might be null
.tableName
- The table name.columnName
- The column name.cx
- The database connection.SQLException
public Object getNextSequenceValue(String schemaName, String sequenceName, Connection cx) throws SQLException
SQLDialect
Implementations 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 SQLDialect
schemaName
- The schema name, this might be null
.sequenceName
- The name of the sequence.cx
- The database connection.null
.SQLException
public String encodeNextSequenceValue(String schemaName, String sequenceName)
SQLDialect
Implementations should handle the case where schemaName is null
.
encodeNextSequenceValue
in class SQLDialect
public 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 SQLDialect
public 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 SQLDialect
schemaName
- The schema name, this might be null
.tableName
- The name of the table.columnName
- The column.cx
- The database connection.null
.SQLException
public void registerClassToSqlMappings(Map<Class<?>,Integer> mappings)
SQLDialect
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:
registerClassToSqlMappings
in class SQLDialect
public void registerSqlTypeNameToClassMappings(Map<String,Class<?>> mappings)
SQLDialect
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:
registerSqlTypeNameToClassMappings
in class SQLDialect
public void registerSqlTypeToSqlTypeNameOverrides(Map<Integer,String> overrides)
SQLDialect
The default implementation of this method does nothing. Subclasses should override in cases where:
Types
)
registerSqlTypeToSqlTypeNameOverrides
in class SQLDialect
public 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 SQLDialect
public void encodePrimaryKey(String column, StringBuffer sql)
SQLDialect
Subclasses should override this method if need be, the default implementation does the following:
encodeColumnName( column, sql );
sql.append( " int PRIMARY KEY" );
encodePrimaryKey
in class SQLDialect
public void postCreateTable(String schemaName, SimpleFeatureType featureType, Connection cx) throws SQLException
postCreateTable
in class SQLDialect
schemaName
- The name of the schema, may be null
.featureType
- The feature type that has just been created on the database.cx
- Database connection.SQLException
public void postDropTable(String schemaName, SimpleFeatureType featureType, Connection cx) throws SQLException
SQLDialect
This base implementation does nothing, subclasses should override as need be.
postDropTable
in class SQLDialect
schemaName
- The database schema containing the table.featureType
- The featureType/table being dropped.cx
- The database connection.SQLException
public void encodeGeometryValue(Geometry value, int dimension, int srid, StringBuffer sql) throws IOException
BasicSQLDialect
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.
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 BasicSQLDialect
IOException
public FilterToSQL createFilterToSQL()
BasicSQLDialect
Sublcasses can override this method to return a subclass of FilterToSQL
if need
be.
createFilterToSQL
in class BasicSQLDialect
public boolean isLimitOffsetSupported()
SQLDialect
isLimitOffsetSupported
in class SQLDialect
public void applyLimitOffset(StringBuffer sql, int limit, int offset)
SQLDialect
applyLimitOffset
in class SQLDialect
public void encodeValue(Object value, Class type, StringBuffer sql)
BasicSQLDialect
Subclasses may wish to override or extend this method to handle specific types. This default implementation does the following:
Object.toString()
representation.
CharSequence
), it is wrapped in
single quotes (').
encodeValue
in class BasicSQLDialect
public int getDefaultVarcharSize()
SQLDialect
Some 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 SQLDialect
public Version getVersion(Connection conn) throws SQLException
SQLException
public Version getPostgreSQLVersion(Connection conn) throws SQLException
SQLException
protected void addSupportedHints(Set<Hints.Key> hints)
SQLDialect
possible hints (but not limited to)
addSupportedHints
in class SQLDialect
protected String getEstimatedExtentFunction()
public Filter[] splitFilter(Filter filter, SimpleFeatureType schema)
SQLDialect
splitFilter
in class SQLDialect
public String[] getDesiredTablesType()
getDesiredTablesType
in class SQLDialect
DatabaseMetaData
public boolean canGroupOnGeometry()
SQLDialect
canGroupOnGeometry
in class SQLDialect
Copyright © 1996–2023 Geotools. All rights reserved.