org.geotools.data.db2
Class DB2SQLDialect

java.lang.Object
  extended by org.geotools.jdbc.SQLDialect
      extended by org.geotools.data.db2.DB2SQLDialect

public class DB2SQLDialect
extends SQLDialect


Field Summary
 
Fields inherited from class org.geotools.jdbc.SQLDialect
BASE_DBMS_CAPABILITIES, dataStore, LOGGER
 
Constructor Summary
DB2SQLDialect(JDBCDataStore dataStore, DB2DialectInfo info)
           
 
Method Summary
protected  void addSupportedHints(java.util.Set<Hints.Key> hints)
          Add hints to the JDBC Feature Source.
 void applyLimitOffset(java.lang.StringBuffer sql, int limit, int offset)
          Alters the query provided so that limit and offset are natively dealt with.
 org.opengis.referencing.crs.CoordinateReferenceSystem createCRS(int srid, java.sql.Connection cx)
          Turns the specified srid into a CoordinateReferenceSystem, or returns null if not possible.
 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 name, 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 encodeGeometryColumn(org.opengis.feature.type.GeometryDescriptor gatt, java.lang.StringBuffer sql)
           
 void encodeGeometryColumnGeneralized(org.opengis.feature.type.GeometryDescriptor gatt, int srid, java.lang.StringBuffer sql, java.lang.Double distance)
          Encodes a generalized geometry using a DB provided SQL function if available If not supported, subclasses should not implement Only called if is supported Example:
 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 encodePrimaryKey(java.lang.String column, java.lang.StringBuffer sql)
          Encodes the primary key definition in a CREATE TABLE statement.
 DB2DialectInfo getDb2DialectInfo()
           
 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 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.
 void postCreateTable(java.lang.String schemaName, org.opengis.feature.simple.SimpleFeatureType featureType, java.sql.Connection cx)
          Callback to execute any additional sql statements post a create table statement.
 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 registerSqlTypeToClassMappings(java.util.Map<java.lang.Integer,java.lang.Class<?>> mappings)
          Registers the sql type to java type mappings that the dialect uses when reading and writing objects to and from the database.
 
Methods inherited from class org.geotools.jdbc.SQLDialect
encodeColumnAlias, encodeColumnName, encodeColumnType, encodeGeometryColumnSimplified, encodePostColumnCreateTable, encodePostCreateTable, encodeSchemaName, encodeTableAlias, encodeTableName, getLastAutoGeneratedValue, getMapping, getNameEscape, getNextAutoGeneratedValue, initializeConnection, lookupGeneratedValuesPostInsert, ne, postCreateAttribute, postCreateFeatureType, registerAggregateFunctions, registerSqlTypeToSqlTypeNameOverrides
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DB2SQLDialect

public DB2SQLDialect(JDBCDataStore dataStore,
                     DB2DialectInfo info)
Method Detail

getDb2DialectInfo

public DB2DialectInfo getDb2DialectInfo()

createCRS

public org.opengis.referencing.crs.CoordinateReferenceSystem createCRS(int srid,
                                                                       java.sql.Connection cx)
                                                                throws java.sql.SQLException
Description copied from class: SQLDialect
Turns the specified srid into a CoordinateReferenceSystem, 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

Overrides:
createCRS in class SQLDialect
Returns:
Throws:
java.sql.SQLException

encodePrimaryKey

public void encodePrimaryKey(java.lang.String column,
                             java.lang.StringBuffer sql)
Description copied from class: SQLDialect
Encodes the primary key definition in a CREATE TABLE statement.

Subclasses should override this method if need be, the default implementation does the following:

   
   encodeColumnName( column, sql );
   sql.append( " int PRIMARY KEY" );
   
 

Overrides:
encodePrimaryKey in class SQLDialect

getGeometryTypeName

public java.lang.String getGeometryTypeName(java.lang.Integer type)
Description copied from class: SQLDialect
Returns the name of a geometric type based on its integer constant.

The constant, type, is registered in SQLDialect.registerSqlTypeNameToClassMappings(Map).

This default implementation returns null, subclasses should override.

Overrides:
getGeometryTypeName in class SQLDialect

getGeometrySRID

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
Description copied from class: SQLDialect
Returns the spatial reference system identifier (srid) for a particular geometry column.

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.

Overrides:
getGeometrySRID in class SQLDialect
Parameters:
schemaName - The database schema, could be null.
tableName - The table, never null.
columnName - The column name, never null
cx - The database connection.
Throws:
java.sql.SQLException

encodeGeometryColumn

public void encodeGeometryColumn(org.opengis.feature.type.GeometryDescriptor gatt,
                                 int srid,
                                 java.lang.StringBuffer sql)
Description copied from class: SQLDialect
Encodes the name of a geometry column in a SELECT statement.

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.

Overrides:
encodeGeometryColumn in class SQLDialect

encodeGeometryColumn

public void encodeGeometryColumn(org.opengis.feature.type.GeometryDescriptor gatt,
                                 java.lang.StringBuffer sql)

encodeGeometryEnvelope

public void encodeGeometryEnvelope(java.lang.String tableName,
                                   java.lang.String geometryColumn,
                                   java.lang.StringBuffer sql)
Description copied from class: SQLDialect
Encodes the spatial extent function of a geometry column in a SELECT statement.

This method must also be sure to properly encode the name of the column with the SQLDialect.encodeColumnName(String, StringBuffer) function.

Specified by:
encodeGeometryEnvelope in class SQLDialect

decodeGeometryEnvelope

public com.vividsolutions.jts.geom.Envelope decodeGeometryEnvelope(java.sql.ResultSet rs,
                                                                   int column,
                                                                   java.sql.Connection cx)
                                                            throws java.sql.SQLException,
                                                                   java.io.IOException
Description copied from class: SQLDialect
Decodes the result of a spatial extent function in a SELECT statement.

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.

Specified by:
decodeGeometryEnvelope in class SQLDialect
Parameters:
rs - A result set
column - Index into the result set which points at the spatial extent value.
Throws:
java.sql.SQLException
java.io.IOException

decodeGeometryValue

public com.vividsolutions.jts.geom.Geometry decodeGeometryValue(org.opengis.feature.type.GeometryDescriptor descriptor,
                                                                java.sql.ResultSet rs,
                                                                java.lang.String name,
                                                                com.vividsolutions.jts.geom.GeometryFactory factory,
                                                                java.sql.Connection cx)
                                                         throws java.io.IOException,
                                                                java.sql.SQLException
Description copied from class: SQLDialect
Decodes a geometry value from the result of a query.

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:

   String wkt = rs.getString( column );
   if ( wkt == null ) {
     return null;
   }
   return new WKTReader(factory).read( wkt );
   
Note that implementations must handle null values.

The factory parameter should be used to instantiate any geometry objects.

Specified by:
decodeGeometryValue in class SQLDialect
Throws:
java.io.IOException
java.sql.SQLException

decodeGeometryValue

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
Description copied from class: SQLDialect
Decodes a geometry value from the result of a query specifying the column as an index.

See #decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory) for a more in depth description.

Overrides:
decodeGeometryValue in class SQLDialect
Throws:
java.io.IOException
java.sql.SQLException
See Also:
#decodeGeometryValue(GeometryDescriptor, ResultSet, String, GeometryFactory)}.

registerClassToSqlMappings

public void registerClassToSqlMappings(java.util.Map<java.lang.Class<?>,java.lang.Integer> mappings)
Description copied from class: SQLDialect
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. This implementation provides the following mappings:

Overrides:
registerClassToSqlMappings in class SQLDialect

registerSqlTypeToClassMappings

public void registerSqlTypeToClassMappings(java.util.Map<java.lang.Integer,java.lang.Class<?>> mappings)
Description copied from class: SQLDialect
Registers the sql type to java type mappings that the dialect 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. This implementation provides the following mappings:

Overrides:
registerSqlTypeToClassMappings in class SQLDialect

registerSqlTypeNameToClassMappings

public void registerSqlTypeNameToClassMappings(java.util.Map<java.lang.String,java.lang.Class<?>> mappings)
Description copied from class: SQLDialect
Registers the sql type name to java type mappings that the dialect 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. This implementation provides the following mappings:

Overrides:
registerSqlTypeNameToClassMappings in class SQLDialect

postCreateTable

public void postCreateTable(java.lang.String schemaName,
                            org.opengis.feature.simple.SimpleFeatureType featureType,
                            java.sql.Connection cx)
                     throws java.sql.SQLException
Description copied from class: SQLDialect
Callback to execute any additional sql statements post a create table statement.

This 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.

Overrides:
postCreateTable in class SQLDialect
Parameters:
schemaName - The name of the schema, may be null.
featureType - The feature type that has just been created on the database.
cx - Database connection.
Throws:
java.sql.SQLException

getSequenceForColumn

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
Description copied from class: SQLDialect
Determines the name of the sequence (if any) which is used to increment generate values for a table column.

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.

Overrides:
getSequenceForColumn in class SQLDialect
Parameters:
schemaName - The schema name, this might be null.
tableName - The table name.
columnName - The column name.
cx - The database connection.
Throws:
java.sql.SQLException

getNextSequenceValue

public java.lang.Object getNextSequenceValue(java.lang.String schemaName,
                                             java.lang.String sequenceName,
                                             java.sql.Connection cx)
                                      throws java.sql.SQLException
Description copied from class: SQLDialect
Obtains the next value of a sequence, incrementing the sequence to the next state in the process.

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.

Overrides:
getNextSequenceValue in class SQLDialect
Parameters:
schemaName - The schema name, this might be null.
sequenceName - The name of the sequence.
cx - The database connection.
Returns:
The next value of the sequence, or null.
Throws:
java.sql.SQLException

includeTable

public boolean includeTable(java.lang.String schemaName,
                            java.lang.String tableName,
                            java.sql.Connection cx)
                     throws java.sql.SQLException
Description copied from class: SQLDialect
Determines if the specified table should be included in those published by the datastore.

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.

Overrides:
includeTable in class SQLDialect
Parameters:
schemaName - The schema of the table, might be null..
tableName - The name of the table.
cx - Database connection.
Throws:
java.sql.SQLException

isLimitOffsetSupported

public boolean isLimitOffsetSupported()
Description copied from class: SQLDialect
Returns true if this dialect can encode both Query.getStartIndex() and Query.getMaxFeatures() into native SQL.

Overrides:
isLimitOffsetSupported in class SQLDialect
Returns:

applyLimitOffset

public void applyLimitOffset(java.lang.StringBuffer sql,
                             int limit,
                             int offset)
Description copied from class: SQLDialect
Alters the query provided so that limit and offset are natively dealt with. This might mean simply appending some extra directive to the query, or wrapping it into a bigger one.

Overrides:
applyLimitOffset in class SQLDialect

encodeGeometryColumnGeneralized

public void encodeGeometryColumnGeneralized(org.opengis.feature.type.GeometryDescriptor gatt,
                                            int srid,
                                            java.lang.StringBuffer sql,
                                            java.lang.Double distance)
Description copied from class: SQLDialect
Encodes a generalized geometry using a DB provided SQL function if available If not supported, subclasses should not implement Only called if is supported Example:

   
   sql.append( "asText(generalize(" );
   column( gatt.getLocalName(), sql );
   sql.append( "," );
   sql.append(distance);
   sql.append( "))" );
   
 

Overrides:
encodeGeometryColumnGeneralized in class SQLDialect

addSupportedHints

protected void addSupportedHints(java.util.Set<Hints.Key> hints)
Description copied from class: SQLDialect
Add hints to the JDBC Feature Source. A subclass can override possible hints (but not limited to) Hints.GEOMETRY_GENERALIZATION Hints.GEOMETRY_SIMPLIFICATION

Overrides:
addSupportedHints in class SQLDialect


Copyright © 1996-2010 Geotools. All Rights Reserved.