|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectSQLDialect
H2Dialect
public class H2Dialect
Delegate for H2DialectBasic
and H2DialectPrepared
which implements
the common parts of the dialect api.
modules/plugin/jdbc-h2 (gt-jdbc-h2.jar)
Field Summary | |
---|---|
static String |
H2_SPATIAL_INDEX
|
Fields inherited from class SQLDialect |
---|
BASE_DBMS_CAPABILITIES, dataStore, LOGGER |
Constructor Summary | |
---|---|
H2Dialect(JDBCDataStore dataStore)
|
Method Summary | |
---|---|
void |
applyLimitOffset(StringBuffer sql,
int limit,
int offset)
Alters the query provided so that limit and offset are natively dealt with. |
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,
String column,
GeometryFactory factory,
Connection cx)
Decodes a geometry value from the result of a query. |
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 srid,
StringBuffer sql)
|
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. |
Integer |
getGeometrySRID(String schemaName,
String tableName,
String columnName,
Connection cx)
Returns the spatial reference system identifier (srid) for a particular geometry column. |
Class<?> |
getMapping(ResultSet columnMetaData,
Connection cx)
Determines the class mapping for a particular column of a table. |
String |
getNameEscape()
Returns the string used to escape names. |
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. |
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. |
void |
postCreateFeatureType(SimpleFeatureType featureType,
DatabaseMetaData metadata,
String schemaName,
Connection cx)
Callback which executes after a feature type has been built from a database table. |
void |
postCreateTable(String schemaName,
SimpleFeatureType featureType,
Connection cx)
Callback to execute any additional sql statements post a create table 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 |
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. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static String H2_SPATIAL_INDEX
Constructor Detail |
---|
public H2Dialect(JDBCDataStore dataStore)
Method Detail |
---|
public String getNameEscape()
SQLDialect
This value is used to escape any name in a query. This includes columns,
tables, schemas, indexes, etc... If no escape is necessary this method
should return the empty string, and never return null
.
This default implementation returns a single double quote ("), subclasses must override to provide a different espcape.
getNameEscape
in class SQLDialect
public void registerSqlTypeToClassMappings(Map<Integer,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:
registerSqlTypeToClassMappings
in class SQLDialect
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 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 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 metadata
null
.
SQLException
public void encodePostColumnCreateTable(AttributeDescriptor att, StringBuffer sql)
SQLDialect
This is appended after the column name and type. Subclasses may choose to override this method, the default implementation does nothing.
encodePostColumnCreateTable
in class SQLDialect
att
- The attribute corresponding to the column.public void postCreateTable(String schemaName, SimpleFeatureType featureType, Connection cx) throws SQLException
SQLDialect
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.
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 postCreateFeatureType(SimpleFeatureType featureType, DatabaseMetaData metadata, String schemaName, Connection cx) throws SQLException
SQLDialect
This base implementation does nothing, subclasses should override as need be.
postCreateFeatureType
in class SQLDialect
featureType
- The build feature type.metadata
- The database metadata.schemaName
- The name of the database scheam containing the table containing the columncx
- The database connection.
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 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 SQLDialect
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.
SQLException
IOException
public void encodeGeometryValue(Geometry value, int srid, StringBuffer sql) throws IOException
IOException
public Geometry decodeGeometryValue(GeometryDescriptor descriptor, ResultSet rs, String column, GeometryFactory factory, Connection cx) 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 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 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 Object getNextAutoGeneratedValue(String schemaName, String tableName, String columnName, 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
.
getNextAutoGeneratedValue
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 boolean isLimitOffsetSupported()
SQLDialect
isLimitOffsetSupported
in class SQLDialect
public void applyLimitOffset(StringBuffer sql, int limit, int offset)
SQLDialect
applyLimitOffset
in class SQLDialect
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |