|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.geotools.jdbc.SQLDialect
org.geotools.jdbc.BasicSQLDialect
org.geotools.data.postgis.PostGISDialect
public class PostGISDialect
Field Summary |
---|
Fields inherited from class org.geotools.jdbc.SQLDialect |
---|
BASE_DBMS_CAPABILITIES, dataStore, LOGGER |
Constructor Summary | |
---|---|
PostGISDialect(JDBCDataStore dataStore)
|
Method Summary | |
---|---|
void |
applyLimitOffset(java.lang.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. |
com.vividsolutions.jts.geom.Envelope |
decodeGeometryEnvelope(java.sql.ResultSet rs,
int column,
java.sql.Connection cx)
Decodes the result of a spatial extent function in a SELECT statement. |
com.vividsolutions.jts.geom.Geometry |
decodeGeometryValue(org.opengis.feature.type.GeometryDescriptor descriptor,
java.sql.ResultSet rs,
int column,
com.vividsolutions.jts.geom.GeometryFactory factory,
java.sql.Connection cx)
Decodes a geometry value from the result of a query specifying the column as an index. |
com.vividsolutions.jts.geom.Geometry |
decodeGeometryValue(org.opengis.feature.type.GeometryDescriptor descriptor,
java.sql.ResultSet rs,
java.lang.String column,
com.vividsolutions.jts.geom.GeometryFactory factory,
java.sql.Connection cx)
Decodes a geometry value from the result of a query. |
void |
encodeGeometryColumn(org.opengis.feature.type.GeometryDescriptor gatt,
int srid,
java.lang.StringBuffer sql)
Encodes the name of a geometry column in a SELECT statement. |
void |
encodeGeometryEnvelope(java.lang.String tableName,
java.lang.String geometryColumn,
java.lang.StringBuffer sql)
Encodes the spatial extent function of a geometry column in a SELECT statement. |
void |
encodeGeometryValue(com.vividsolutions.jts.geom.Geometry value,
int srid,
java.lang.StringBuffer sql)
Encodes a geometry value in an sql statement. |
void |
encodePrimaryKey(java.lang.String column,
java.lang.StringBuffer sql)
Encodes the primary key definition in a CREATE TABLE statement. |
void |
encodeValue(java.lang.Object value,
java.lang.Class type,
java.lang.StringBuffer sql)
Encodes a value in an sql statement. |
java.lang.Integer |
getGeometrySRID(java.lang.String schemaName,
java.lang.String tableName,
java.lang.String columnName,
java.sql.Connection cx)
Returns the spatial reference system identifier (srid) for a particular geometry column. |
java.lang.String |
getGeometryTypeName(java.lang.Integer type)
Returns the name of a geometric type based on its integer constant. |
java.lang.Object |
getLastAutoGeneratedValue(java.lang.String schemaName,
java.lang.String tableName,
java.lang.String columnName,
java.sql.Connection cx)
Obtains the last value of an auto generated column. |
java.lang.Class<?> |
getMapping(java.sql.ResultSet columnMetaData,
java.sql.Connection cx)
Determines the class mapping for a particular column of a table. |
java.lang.Object |
getNextSequenceValue(java.lang.String schemaName,
java.lang.String sequenceName,
java.sql.Connection cx)
Obtains the next value of a sequence, incrementing the sequence to the next state in the process. |
java.lang.String |
getSequenceForColumn(java.lang.String schemaName,
java.lang.String tableName,
java.lang.String columnName,
java.sql.Connection cx)
Determines the name of the sequence (if any) which is used to increment generate values for a table column. |
boolean |
includeTable(java.lang.String schemaName,
java.lang.String tableName,
java.sql.Connection cx)
Determines if the specified table should be included in those published by the datastore. |
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(java.lang.String schemaName,
org.opengis.feature.simple.SimpleFeatureType featureType,
java.sql.Connection cx)
Creates GEOMETRY_COLUMN registrations and spatial indexes for all geometry columns |
void |
registerClassToSqlMappings(java.util.Map<java.lang.Class<?>,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.Integer,java.lang.String> overrides)
Registers any overrides that should occur when mapping an integer sql type value to an underlying sql type name. |
void |
setLooseBBOXEnabled(boolean looseBBOXEnabled)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PostGISDialect(JDBCDataStore dataStore)
Method Detail |
---|
public boolean isLooseBBOXEnabled()
public void setLooseBBOXEnabled(boolean looseBBOXEnabled)
public boolean includeTable(java.lang.String schemaName, java.lang.String tableName, java.sql.Connection cx) throws java.sql.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.
java.sql.SQLException
public com.vividsolutions.jts.geom.Geometry decodeGeometryValue(org.opengis.feature.type.GeometryDescriptor descriptor, java.sql.ResultSet rs, java.lang.String column, com.vividsolutions.jts.geom.GeometryFactory factory, java.sql.Connection cx) throws java.io.IOException, java.sql.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
java.io.IOException
java.sql.SQLException
public com.vividsolutions.jts.geom.Geometry decodeGeometryValue(org.opengis.feature.type.GeometryDescriptor descriptor, java.sql.ResultSet rs, int column, com.vividsolutions.jts.geom.GeometryFactory factory, java.sql.Connection cx) throws java.io.IOException, java.sql.SQLException
SQLDialect
See #decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory)
for a more in depth description.
decodeGeometryValue
in class SQLDialect
java.io.IOException
java.sql.SQLException
#decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory)}.
public void encodeGeometryColumn(org.opengis.feature.type.GeometryDescriptor gatt, int srid, java.lang.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, 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 SQLDialect
public void encodeGeometryEnvelope(java.lang.String tableName, java.lang.String geometryColumn, java.lang.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 SQLDialect
public com.vividsolutions.jts.geom.Envelope decodeGeometryEnvelope(java.sql.ResultSet rs, int column, java.sql.Connection cx) throws java.sql.SQLException, java.io.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.
java.sql.SQLException
java.io.IOException
public java.lang.Class<?> getMapping(java.sql.ResultSet columnMetaData, java.sql.Connection cx) throws java.sql.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 metadata
null
.
java.sql.SQLException
public java.lang.Integer getGeometrySRID(java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.sql.Connection cx) throws java.sql.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.
java.sql.SQLException
public java.lang.String getSequenceForColumn(java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.sql.Connection cx) throws java.sql.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.
java.sql.SQLException
public java.lang.Object getNextSequenceValue(java.lang.String schemaName, java.lang.String sequenceName, java.sql.Connection cx) throws java.sql.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
.
java.sql.SQLException
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 java.lang.Object getLastAutoGeneratedValue(java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.sql.Connection cx) throws java.sql.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
.
java.sql.SQLException
public void registerClassToSqlMappings(java.util.Map<java.lang.Class<?>,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.Integer,java.lang.String> overrides)
SQLDialect
The default implementation of this method does nothing. Subclasses should override in cases where:
Types
)
registerSqlTypeToSqlTypeNameOverrides
in class SQLDialect
public java.lang.String getGeometryTypeName(java.lang.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(java.lang.String column, java.lang.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(java.lang.String schemaName, org.opengis.feature.simple.SimpleFeatureType featureType, java.sql.Connection cx) throws java.sql.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.
java.sql.SQLException
public void encodeGeometryValue(com.vividsolutions.jts.geom.Geometry value, int srid, java.lang.StringBuffer sql) throws java.io.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.
encodeGeometryValue
in class BasicSQLDialect
java.io.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(java.lang.StringBuffer sql, int limit, int offset)
SQLDialect
applyLimitOffset
in class SQLDialect
public void encodeValue(java.lang.Object value, java.lang.Class type, java.lang.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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |