|
||||||||||
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.PreparedStatementSQLDialect
org.geotools.data.oracle.OracleDialect
public class OracleDialect
Abstract dialect implementation for Oracle. Subclasses differ on the way used to parse and encode the JTS geoemtries into Oracle MDSYS.SDO_GEOMETRY structures.
Field Summary | |
---|---|
static java.util.Map<java.lang.Class,java.lang.String> |
CLASSES_TO_GEOM
A map from JTS Geometry type to Oracle geometry type. |
static java.lang.String |
GEODETIC
Marks a geometry column as geodetic |
Fields inherited from class org.geotools.jdbc.SQLDialect |
---|
BASE_DBMS_CAPABILITIES, dataStore, LOGGER |
Constructor Summary | |
---|---|
OracleDialect(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. |
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. |
FilterToSQL |
createFilterToSQL()
|
PreparedFilterToSQL |
createPreparedFilterToSQL()
|
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 |
encodeColumnName(java.lang.String raw,
java.lang.StringBuffer sql)
Encodes the name of a column in an SQL 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 |
encodeTableAlias(java.lang.String raw,
java.lang.StringBuffer sql)
Encodes the alias of a table in an sql query. |
void |
encodeTableName(java.lang.String raw,
java.lang.StringBuffer sql)
Encodes the name of a table 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.Class<?> |
getMapping(java.sql.ResultSet columnMetaData,
java.sql.Connection cx)
Determines the class mapping for a particular column of a table. |
java.lang.String |
getNameEscape()
Returns the string used to escape names. |
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. |
protected boolean |
isGeodeticSrid(java.lang.Integer srid,
java.sql.Connection cx)
Checks if the specified srid is geodetic or not |
boolean |
isLimitOffsetSupported()
Returns true if this dialect can encode both Query.getStartIndex() and Query.getMaxFeatures() into native SQL. |
boolean |
isLooseBBOXEnabled()
|
void |
postCreateAttribute(org.opengis.feature.type.AttributeDescriptor att,
java.sql.ResultSet columnMetadata,
java.lang.String tableName,
java.lang.String schemaName,
java.sql.Connection cx)
Callback which executes after an attribute descriptor has been built from a table column. |
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 |
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 |
setGeometryValue(com.vividsolutions.jts.geom.Geometry g,
int srid,
java.lang.Class binding,
java.sql.PreparedStatement ps,
int column)
Sets the geometry value into the prepared statement. |
void |
setLooseBBOXEnabled(boolean looseBBOXEnabled)
|
Methods inherited from class org.geotools.jdbc.PreparedStatementSQLDialect |
---|
prepareFunctionArgument, prepareGeometryValue, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String GEODETIC
public static final java.util.Map<java.lang.Class,java.lang.String> CLASSES_TO_GEOM
Constructor Detail |
---|
public OracleDialect(JDBCDataStore dataStore)
Method Detail |
---|
public boolean isLooseBBOXEnabled()
public void setLooseBBOXEnabled(boolean looseBBOXEnabled)
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 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 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 java.lang.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 encodeColumnName(java.lang.String raw, java.lang.StringBuffer sql)
SQLDialect
This method wraps raw in the character provided by
SQLDialect.getNameEscape()
. Subclasses usually dont override this method
and instead override SQLDialect.getNameEscape()
.
encodeColumnName
in class SQLDialect
public void encodeTableName(java.lang.String raw, java.lang.StringBuffer sql)
SQLDialect
This method wraps raw in the character provided by
SQLDialect.getNameEscape()
. Subclasses usually dont override this method
and instead override SQLDialect.getNameEscape()
.
encodeTableName
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 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 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 setGeometryValue(com.vividsolutions.jts.geom.Geometry g, int srid, java.lang.Class binding, java.sql.PreparedStatement ps, int column) throws java.sql.SQLException
PreparedStatementSQLDialect
setGeometryValue
in class PreparedStatementSQLDialect
g
- The geometrysrid
- the geometry native srid (should be forced into the encoded geometry)binding
- the geometry typeps
- the prepared statementcolumn
- the column index where the geometry is to be set
java.sql.SQLException
public FilterToSQL createFilterToSQL()
public PreparedFilterToSQL createPreparedFilterToSQL()
createPreparedFilterToSQL
in class PreparedStatementSQLDialect
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 org.opengis.referencing.crs.CoordinateReferenceSystem createCRS(int srid, java.sql.Connection cx) throws java.sql.SQLException
SQLDialect
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
createCRS
in class SQLDialect
java.sql.SQLException
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 void postCreateTable(java.lang.String schemaName, org.opengis.feature.simple.SimpleFeatureType featureType, java.sql.Connection cx) throws java.sql.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.
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
protected boolean isGeodeticSrid(java.lang.Integer srid, java.sql.Connection cx)
java.sql.SQLException
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 encodeTableAlias(java.lang.String raw, java.lang.StringBuffer sql)
SQLDialect
This default implementation uses the syntax:
as "alias". Subclasses should override to provide a different syntax.
encodeTableAlias
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 void postCreateAttribute(org.opengis.feature.type.AttributeDescriptor att, java.sql.ResultSet columnMetadata, java.lang.String tableName, java.lang.String schemaName, java.sql.Connection cx) throws java.sql.SQLException
SQLDialect
The result set columnMetadata should not be modified in any way (including scrolling) , it should only be read from.
This base implementation does nothing, subclasses should override as need be.
postCreateAttribute
in class SQLDialect
att
- The built attribute descriptor.columnMetadata
- The database metadata about the column.tableName
- The name of the table containing the columnschemaName
- The name of the database scheam containing the table containing the columncx
- The database connection.
java.sql.SQLException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |