|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectSQLDialect
MySQLDialect
public class MySQLDialect
Delegate for MySQLDialectBasic
and MySQLDialectPrepared
which implements the common part of the api.
modules/plugin/jdbc-mysql (gt-jdbc-mysql.jar)
Field Summary | |
---|---|
protected Integer |
GEOMETRY
|
protected Integer |
LINESTRING
|
protected Integer |
MULTILINESTRING
|
protected Integer |
MULTIPOINT
|
protected Integer |
MULTIPOLYGON
|
protected Integer |
POINT
mysql spatial types |
protected Integer |
POLYGON
|
protected String |
storageEngine
the storage engine to use when creating tables, one of MyISAM, InnoDB |
Fields inherited from class SQLDialect |
---|
BASE_DBMS_CAPABILITIES, dataStore, LOGGER |
Constructor Summary | |
---|---|
MySQLDialect(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 name,
GeometryFactory factory,
Connection cx)
Decodes a geometry value from the result of a query. |
void |
encodeGeometryColumn(GeometryDescriptor gatt,
int srid,
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 |
encodePostColumnCreateTable(AttributeDescriptor att,
StringBuffer sql)
Encodes anything post a column in a CREATE TABLE statement. |
void |
encodePostCreateTable(String tableName,
StringBuffer sql)
Encodes anything post 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. |
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. |
String |
getNameEscape()
Returns the string used to escape names. |
String |
getStorageEngine()
|
boolean |
isLimitOffsetSupported()
Returns true if this dialect can encode both Query.getStartIndex() and Query.getMaxFeatures() into native SQL. |
boolean |
lookupGeneratedValuesPostInsert()
Controls whether keys are looked up post or pre insert. |
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 |
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. |
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 |
setStorageEngine(String storageEngine)
|
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Integer POINT
protected Integer LINESTRING
protected Integer POLYGON
protected Integer MULTIPOINT
protected Integer MULTILINESTRING
protected Integer MULTIPOLYGON
protected Integer GEOMETRY
protected String storageEngine
Constructor Detail |
---|
public MySQLDialect(JDBCDataStore dataStore)
Method Detail |
---|
public void setStorageEngine(String storageEngine)
public String getStorageEngine()
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 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 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 encodeGeometryColumn(GeometryDescriptor gatt, int srid, 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(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 Geometry decodeGeometryValue(GeometryDescriptor descriptor, ResultSet rs, String name, 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 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 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 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 encodePostCreateTable(String tableName, StringBuffer sql)
SQLDialect
This is appended to a CREATE TABLE statement after the column definitions. This default implementation does nothing, subclasses should override as need be.
encodePostCreateTable
in class SQLDialect
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, 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 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 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 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 |