|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectSQLDialect
BasicSQLDialect
SQLServerDialect
public class SQLServerDialect
Dialect implementation for Microsoft SQL Server.
Field Summary |
---|
Fields inherited from class SQLDialect |
---|
BASE_DBMS_CAPABILITIES, dataStore, LOGGER |
Constructor Summary | |
---|---|
SQLServerDialect(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. |
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,
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 |
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. |
protected void |
encodeTableName(String schemaName,
String tableName,
StringBuffer sql,
boolean escape)
|
void |
encodeValue(Object value,
Class type,
StringBuffer sql)
Encodes a value in an sql statement. |
int |
getGeometryDimension(String schemaName,
String tableName,
String columnName,
Connection cx)
Returns the dimension of the coordinates in the geometry. |
Integer |
getGeometryDimensionFromMetadataTable(String schemaName,
String tableName,
String columnName,
Connection cx)
|
String |
getGeometryMetadataTable()
The geometry metadata table in use, if any |
Integer |
getGeometrySRID(String schemaName,
String tableName,
String columnName,
Connection cx)
Returns the spatial reference system identifier (srid) for a particular geometry column. |
Integer |
getGeometrySRIDfromMetadataTable(String schemaName,
String tableName,
String columnName,
Connection cx)
|
String |
getGeometryTypeName(Integer type)
Returns the name of a geometric type based on its integer constant. |
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. |
boolean |
includeTable(String schemaName,
String tableName,
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(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 |
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 |
setGeometryMetadataTable(String geometryMetadataTable)
Sets the geometry metadata table |
void |
setUseNativeSerialization(Boolean useNativeSerialization)
Sets whether to use native SQL Server binary serialization or WKB serialization |
void |
setUseOffSetLimit(Boolean useOffsetLimit)
Sets whether to use offset limit or not |
Methods inherited from class BasicSQLDialect |
---|
onDelete, onInsert, onSelect, onUpdate |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SQLServerDialect(JDBCDataStore dataStore)
Method Detail |
---|
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 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 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 void postCreateTable(String schemaName, SimpleFeatureType featureType, Connection cx) throws SQLException, IOException
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
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 metadata
null
.
SQLException
public Integer getGeometrySRIDfromMetadataTable(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
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 Integer getGeometryDimensionFromMetadataTable(String schemaName, String tableName, String columnName, Connection cx) throws SQLException
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
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( ")" );
This default implementation calls the deprecated
SQLDialect.encodeGeometryColumn(GeometryDescriptor, String, int, StringBuffer)
version of
this method for backward compatibility reasons.
encodeGeometryColumn
in class SQLDialect
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 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 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 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 FilterToSQL createFilterToSQL()
BasicSQLDialect
Sublcasses can override this method to return a subclass of FilterToSQL
if need be.
createFilterToSQL
in class BasicSQLDialect
protected void encodeTableName(String schemaName, String tableName, StringBuffer sql, boolean escape)
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 String getGeometryMetadataTable()
public void setGeometryMetadataTable(String geometryMetadataTable)
geometryMetadataTable
- public void setUseOffSetLimit(Boolean useOffsetLimit)
useOffsetLimit
- public void setUseNativeSerialization(Boolean useNativeSerialization)
useNativeSerialization
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |