/*
* GeoTools - The Open Source Java GIS Toolkit
* http://geotools.org
*
* (C) 2002-2008, Open Source Geospatial Foundation (OSGeo)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotools.data.sqlserver;
import java.io.IOException;
import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.Date;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.sql.Time;
import java.sql.Types;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.logging.Level;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.geotools.data.Query;
import org.geotools.data.jdbc.FilterToSQL;
import org.geotools.data.sqlserver.reader.SqlServerBinaryReader;
import org.geotools.factory.Hints;
import org.geotools.geometry.jts.ReferencedEnvelope;
import org.geotools.jdbc.BasicSQLDialect;
import org.geotools.jdbc.JDBCDataStore;
import org.geotools.referencing.CRS;
import org.opengis.feature.simple.SimpleFeatureType;
import org.opengis.feature.type.AttributeDescriptor;
import org.opengis.feature.type.GeometryDescriptor;
import org.opengis.filter.Filter;
import org.opengis.referencing.crs.CoordinateReferenceSystem;
import org.opengis.referencing.cs.CoordinateSystem;
import org.opengis.referencing.cs.CoordinateSystemAxis;
import com.vividsolutions.jts.geom.Envelope;
import com.vividsolutions.jts.geom.Geometry;
import com.vividsolutions.jts.geom.GeometryCollection;
import com.vividsolutions.jts.geom.GeometryFactory;
import com.vividsolutions.jts.geom.LineString;
import com.vividsolutions.jts.geom.MultiLineString;
import com.vividsolutions.jts.geom.MultiPoint;
import com.vividsolutions.jts.geom.MultiPolygon;
import com.vividsolutions.jts.geom.Point;
import com.vividsolutions.jts.geom.Polygon;
import com.vividsolutions.jts.io.ParseException;
import com.vividsolutions.jts.io.WKBReader;
import com.vividsolutions.jts.io.WKTReader;
import com.vividsolutions.jts.io.WKTWriter;
/**
* Dialect implementation for Microsoft SQL Server.
*
* @author Justin Deoliveira, OpenGEO
*
* @source $URL$
*/
public class SQLServerDialect extends BasicSQLDialect {
private static final int DEFAULT_AXIS_MAX = 10000000;
private static final int DEFAULT_AXIS_MIN = -10000000;
static final String SPATIAL_INDEX_KEY = "SpatialIndex";
/**
* Pattern used to match the first FROM element in a SQL query, without matching
* also attributes containing FROM inside the name. We require to locate
*/
static final Pattern FROM_PATTERN = Pattern.compile("(\\s+)(FROM)(\\s)+", Pattern.DOTALL);
static final Pattern POSITIVE_NUMBER = Pattern.compile("[1-9][0-9]*");
/**
* The direct geometry metadata table
* @param dataStore
*/
private String geometryMetadataTable;
private Boolean useOffsetLimit = false;
private Boolean useNativeSerialization = false;
private Boolean forceSpatialIndexes = false;
private String tableHints;
final static Map<String, Class> TYPE_TO_CLASS_MAP = new HashMap<String, Class>() {
{
put("GEOMETRY", Geometry.class);
put("GEOGRAPHY", Geometry.class);
put("POINT", Point.class);
put("POINTM", Point.class);
put("LINESTRING", LineString.class);
put("LINESTRINGM", LineString.class);
put("POLYGON", Polygon.class);
put("POLYGONM", Polygon.class);
put("MULTIPOINT", MultiPoint.class);
put("MULTIPOINTM", MultiPoint.class);
put("MULTILINESTRING", MultiLineString.class);
put("MULTILINESTRINGM", MultiLineString.class);
put("MULTIPOLYGON", MultiPolygon.class);
put("MULTIPOLYGONM", MultiPolygon.class);
put("GEOMETRYCOLLECTION", GeometryCollection.class);
put("GEOMETRYCOLLECTIONM", GeometryCollection.class);
}
};
final static Map<Class, String> CLASS_TO_TYPE_MAP = new HashMap<Class, String>() {
{
put(Geometry.class, "GEOMETRY");
put(Point.class, "POINT");
put(LineString.class, "LINESTRING");
put(Polygon.class, "POLYGON");
put(MultiPoint.class, "MULTIPOINT");
put(MultiLineString.class, "MULTILINESTRING");
put(MultiPolygon.class, "MULTIPOLYGON");
put(GeometryCollection.class, "GEOMETRYCOLLECTION");
}
};
public SQLServerDialect(JDBCDataStore dataStore) {
super(dataStore);
}
@Override
public boolean includeTable(String schemaName, String tableName,
Connection cx) throws SQLException {
return !("INFORMATION_SCHEMA".equals( schemaName ) || "sys".equals( schemaName ) );
}
@Override
public String getGeometryTypeName(Integer type) {
return "geometry";
}
@Override
public void registerClassToSqlMappings(Map<Class<?>, Integer> mappings) {
super.registerClassToSqlMappings(mappings);
//override since sql server maps all date times to timestamp
mappings.put( Date.class, Types.TIMESTAMP );
mappings.put( Time.class, Types.TIMESTAMP );
}
@Override
public void registerSqlTypeNameToClassMappings(
Map<String, Class<?>> mappings) {
super.registerSqlTypeNameToClassMappings(mappings);
mappings.put( "geometry", Geometry.class );
mappings.put( "uniqueidentifier", UUID.class );
}
@Override
public void registerSqlTypeToSqlTypeNameOverrides(
Map<Integer, String> overrides) {
super.registerSqlTypeToSqlTypeNameOverrides(overrides);
//force varchar, if not it will default to nvarchar which won't support length restrictions
overrides.put( Types.VARCHAR, "varchar");
}
@Override
public void postCreateTable(String schemaName, SimpleFeatureType featureType, Connection cx)
throws SQLException, IOException {
String tableName = featureType.getName().getLocalPart();
Statement st = null;
try {
st = cx.createStatement();
// register all geometry columns in the database
for (AttributeDescriptor att : featureType.getAttributeDescriptors()) {
if (att instanceof GeometryDescriptor) {
GeometryDescriptor gd = (GeometryDescriptor) att;
if (geometryMetadataTable != null) {
// lookup or reverse engineer the srid
int srid = -1;
if (gd.getUserData().get(JDBCDataStore.JDBC_NATIVE_SRID) != null) {
srid = (Integer) gd.getUserData().get(JDBCDataStore.JDBC_NATIVE_SRID);
} else if (gd.getCoordinateReferenceSystem() != null) {
try {
Integer result = CRS.lookupEpsgCode(
gd.getCoordinateReferenceSystem(), true);
if (result != null)
srid = result;
} catch (Exception e) {
LOGGER.log(Level.FINE, "Error looking up the "
+ "epsg code for metadata " + "insertion, assuming -1", e);
}
}
// assume 2 dimensions, but ease future customisation
int dimensions = 2;
// grab the geometry type
String geomType = CLASS_TO_TYPE_MAP.get(gd.getType().getBinding());
if (geomType == null)
geomType = "GEOMETRY";
StringBuilder sqlBuilder = new StringBuilder();
// register the geometry type, first remove and eventual
// leftover, then write out the real one
sqlBuilder.append("DELETE FROM ").append(geometryMetadataTable)
.append(" WHERE f_table_schema = '").append(schemaName).append("'")
.append(" AND f_table_name = '").append(tableName).append("'")
.append(" AND f_geometry_column = '").append(gd.getLocalName())
.append("'");
LOGGER.fine(sqlBuilder.toString());
st.execute(sqlBuilder.toString());
sqlBuilder = new StringBuilder();
sqlBuilder.append("INSERT INTO ").append(geometryMetadataTable)
.append(" VALUES ('").append(schemaName).append("','")
.append(tableName).append("',").append("'")
.append(gd.getLocalName()).append("',").append(dimensions)
.append(",").append(srid).append(",").append("'").append(geomType)
.append("')");
LOGGER.fine(sqlBuilder.toString());
st.execute(sqlBuilder.toString());
}
//get the crs, and derive a bounds
//TODO: stop being lame and properly figure out the dimension and bounds, see
// oracle dialect for the proper way to do it
String bbox = null;
if (gd.getCoordinateReferenceSystem() != null) {
CoordinateReferenceSystem crs = gd.getCoordinateReferenceSystem();
CoordinateSystem cs = crs.getCoordinateSystem();
if (cs.getDimension() == 2) {
CoordinateSystemAxis a0 = cs.getAxis(0);
CoordinateSystemAxis a1 = cs.getAxis(1);
bbox = "(";
bbox += (Double.isInfinite(a0.getMinimumValue()) ?
DEFAULT_AXIS_MIN : a0.getMinimumValue()) + ", ";
bbox += (Double.isInfinite(a1.getMinimumValue()) ?
DEFAULT_AXIS_MIN : a1.getMinimumValue()) + ", ";
bbox += (Double.isInfinite(a0.getMaximumValue()) ?
DEFAULT_AXIS_MAX : a0.getMaximumValue()) + ", ";
bbox += Double.isInfinite(a1.getMaximumValue()) ?
DEFAULT_AXIS_MAX : a1.getMaximumValue();
bbox += ")";
}
}
if (bbox == null) {
//no crs or could not figure out bounds
continue;
}
StringBuffer sql = new StringBuffer("CREATE SPATIAL INDEX ");
encodeTableName(featureType.getTypeName()+"_"+gd.getLocalName()+"_index", sql);
sql.append( " ON ");
encodeTableName(featureType.getTypeName(), sql);
sql.append("(");
encodeColumnName(null, gd.getLocalName(), sql);
sql.append(")");
sql.append( " WITH ( BOUNDING_BOX = ").append(bbox).append(")");
LOGGER.fine(sql.toString());
st.execute(sql.toString());
}
}
if (!cx.getAutoCommit()) {
cx.commit();
}
} finally {
dataStore.closeSafe(st);
}
}
@Override
public Class<?> getMapping(ResultSet columnMetaData, Connection cx)
throws SQLException {
String typeName = columnMetaData.getString("TYPE_NAME");
String gType = null;
if ("geometry".equalsIgnoreCase(typeName) && geometryMetadataTable != null) {
gType = lookupGeometryType(columnMetaData, cx, geometryMetadataTable, "f_geometry_column");
} else {
return null;
}
// decode the type into
if(gType == null) {
// it's either a generic geography or geometry not registered in the medatata tables
return Geometry.class;
} else {
Class geometryClass = TYPE_TO_CLASS_MAP.get(gType.toUpperCase());
if (geometryClass == null) {
geometryClass = Geometry.class;
}
return geometryClass;
}
}
private String lookupGeometryType(ResultSet columnMetaData, Connection cx, String gTableName,
String gColumnName) throws SQLException {
// grab the information we need to proceed
String tableName = columnMetaData.getString("TABLE_NAME");
String columnName = columnMetaData.getString("COLUMN_NAME");
// first attempt, try with the geometry metadata
Statement statement = null;
ResultSet result = null;
try {
String schema = dataStore.getDatabaseSchema();
String sqlStatement = "SELECT TYPE FROM " + gTableName + " WHERE " //
+ (schema == null ? "" : "F_TABLE_SCHEMA = '" + dataStore.getDatabaseSchema() + "' AND ")
+ "F_TABLE_NAME = '" + tableName + "' " //
+ "AND " + gColumnName + " = '" + columnName + "'";
LOGGER.log(Level.FINE, "Geometry type check; {0} ", sqlStatement);
statement = cx.createStatement();
result = statement.executeQuery(sqlStatement);
if (result.next()) {
return result.getString(1);
}
}
catch(SQLException e){
return null;
}
finally {
dataStore.closeSafe(result);
dataStore.closeSafe(statement);
}
return null;
}
public Integer getGeometrySRIDfromMetadataTable(String schemaName, String tableName,
String columnName, Connection cx) throws SQLException {
if(geometryMetadataTable == null) {
return null;
}
Statement statement = null;
ResultSet result = null;
try {
String schema = dataStore.getDatabaseSchema();
String sql = "SELECT SRID FROM " + geometryMetadataTable + " WHERE " //
+ (schema == null ? "" : "F_TABLE_SCHEMA = '" + dataStore.getDatabaseSchema() + "' AND ")
+ "F_TABLE_NAME = '" + tableName + "' ";//
LOGGER.log(Level.FINE, "Geometry type check; {0} ", sql);
statement = cx.createStatement();
result = statement.executeQuery(sql);
if (result.next()) {
return result.getInt(1);
}
} finally {
dataStore.closeSafe(result);
dataStore.closeSafe(statement);
}
return null;
}
@Override
public Integer getGeometrySRID(String schemaName, String tableName,
String columnName, Connection cx) throws SQLException {
// try retrieve the srid from geometryMetadataTable
Integer srid = getGeometrySRIDfromMetadataTable(schemaName, tableName, columnName, cx);
if (srid != null) {
return srid;
}
// try retrieve srid from the feature table
StringBuffer sql = new StringBuffer("SELECT TOP 1 ");
encodeColumnName(null, columnName, sql);
sql.append( ".STSrid");
sql.append( " FROM ");
encodeTableName(schemaName, tableName, sql, true);
sql.append( " WHERE ");
encodeColumnName(null, columnName, sql );
sql.append( " IS NOT NULL");
dataStore.getLogger().fine( sql.toString() );
Statement st = cx.createStatement();
try {
ResultSet rs = st.executeQuery( sql.toString() );
try {
if ( rs.next() ) {
return rs.getInt( 1 );
}
// no srid found, return the default sql server srid
return 0;
}
finally {
dataStore.closeSafe( rs );
}
}
finally {
dataStore.closeSafe( st );
}
}
public Integer getGeometryDimensionFromMetadataTable(String schemaName, String tableName,
String columnName, Connection cx) throws SQLException {
if(geometryMetadataTable == null) {
return null;
}
Statement statement = null;
ResultSet result = null;
try {
String schema = dataStore.getDatabaseSchema();
String sql = "SELECT COORD_DIMENSION FROM " + geometryMetadataTable + " WHERE " //
+ (schema == null ? "" : "F_TABLE_SCHEMA = '" + dataStore.getDatabaseSchema() + "' AND ")
+ "F_TABLE_NAME = '" + tableName + "' ";//
LOGGER.log(Level.FINE, "Geometry dimension check; {0} ", sql);
statement = cx.createStatement();
result = statement.executeQuery(sql);
if (result.next()) {
return result.getInt(1);
}
} finally {
dataStore.closeSafe(result);
dataStore.closeSafe(statement);
}
return null;
}
@Override
public int getGeometryDimension(String schemaName, String tableName, String columnName,
Connection cx) throws SQLException {
// try retrieve the dimension from geometryMetadataTable
Integer dimension = getGeometryDimensionFromMetadataTable(schemaName, tableName, columnName, cx);
if (dimension != null) {
return dimension;
}
// try retrieve dimension from the feature table
StringBuffer sql = new StringBuffer("SELECT TOP 1 ");
encodeColumnName(null, columnName, sql);
sql.append( ".STPointN(1).Z");
sql.append( " FROM ");
encodeTableName(schemaName, tableName, sql, true);
sql.append( " WHERE ");
encodeColumnName(null, columnName, sql );
sql.append( " IS NOT NULL");
dataStore.getLogger().fine( sql.toString() );
Statement st = cx.createStatement();
try {
ResultSet rs = st.executeQuery( sql.toString() );
try {
if ( rs.next() ) {
Object z = rs.getObject( 1 );
return z == null ? 2 : 3;
}
// no dimension found, return the default
return 2;
}
finally {
dataStore.closeSafe( rs );
}
}
finally {
dataStore.closeSafe( st );
}
}
@Override
public void encodeGeometryColumn(GeometryDescriptor gatt, String prefix,
int srid, Hints hints, StringBuffer sql) {
encodeColumnName( prefix, gatt.getLocalName(), sql );
if (!useNativeSerialization) {
sql.append( ".STAsBinary()");
}
}
@Override
public void encodeGeometryValue(Geometry value, int dimension, int srid, StringBuffer sql)
throws IOException {
if ( value == null ) {
sql.append( "NULL");
return;
}
GeometryDimensionFinder finder = new GeometryDimensionFinder();
value.apply(finder);
WKTWriter writer = new WKTWriter(finder.hasZ() ? 3 : 2);
String wkt = writer.write(value);
sql.append( "geometry::STGeomFromText('").append( wkt ).append( "',").append( srid ).append(")");
}
@Override
public Geometry decodeGeometryValue(GeometryDescriptor descriptor,
ResultSet rs, String column, GeometryFactory factory, Connection cx)
throws IOException, SQLException {
byte[] bytes = rs.getBytes(column);
if(bytes == null) {
return null;
}
if (useNativeSerialization) {
try {
return new SqlServerBinaryReader(factory).read(bytes);
} catch ( IOException e ) {
throw (IOException) new IOException().initCause( e );
}
} else {
try {
return new WKBReader(factory).read(bytes);
} catch ( ParseException e ) {
throw (IOException) new IOException().initCause( e );
}
}
}
Geometry decodeGeometry( String s, GeometryFactory factory ) throws IOException {
if ( s == null ) {
return null;
}
if ( factory == null ) {
factory = new GeometryFactory();
}
String[] split = s.split( ":" );
String srid = split[0];
Geometry g = null;
try {
g = new WKTReader(factory).read( split[1] );
}
catch ( ParseException e ) {
throw (IOException) new IOException().initCause( e );
}
if (srid != null && POSITIVE_NUMBER.matcher(srid).matches()) {
CoordinateReferenceSystem crs;
try {
crs = CRS.decode("EPSG:" + srid);
} catch (Exception e) {
throw (IOException) new IOException().initCause(e);
}
g.setUserData(crs);
}
return g;
}
@Override
public void encodeGeometryEnvelope(String tableName, String geometryColumn,
StringBuffer sql) {
sql.append( "CAST(");
encodeColumnName( null, geometryColumn, sql );
sql.append( ".STSrid as VARCHAR)");
sql.append( " + ':' + " );
encodeColumnName( null, geometryColumn, sql );
sql.append( ".STEnvelope().ToString()");
}
@Override
public Envelope decodeGeometryEnvelope(ResultSet rs, int column,
Connection cx) throws SQLException, IOException {
String s = rs.getString( column );
Geometry g = decodeGeometry( s, null );
if ( g == null ) {
return null;
}
return new ReferencedEnvelope( g.getEnvelopeInternal(), (CoordinateReferenceSystem) g.getUserData() );
}
@Override
public Object getNextAutoGeneratedValue(String schemaName,
String tableName, String columnName, Connection cx)
throws SQLException {
StringBuffer sql = new StringBuffer("SELECT");
sql.append( " IDENT_CURRENT('");
encodeTableName(schemaName, tableName, sql, false);
sql.append("')");
sql.append( " + ");
sql.append( " IDENT_INCR('");
encodeTableName(schemaName, tableName, sql, false);
sql.append("')");
dataStore.getLogger().fine( sql.toString() );
Statement st = cx.createStatement();
try {
ResultSet rs = st.executeQuery( sql.toString() );
try {
rs.next();
return rs.getInt( 1 );
}
finally {
dataStore.closeSafe( rs );
}
}
finally {
dataStore.closeSafe( st );
}
}
@Override
public FilterToSQL createFilterToSQL() {
return new SQLServerFilterToSQL();
}
protected void encodeTableName(String schemaName, String tableName, StringBuffer sql, boolean escape) {
if (schemaName != null) {
if (escape) {
encodeSchemaName(schemaName, sql);
}
else {
sql.append(schemaName);
}
sql.append(".");
}
if (escape) {
encodeTableName(tableName, sql);
}
else {
sql.append(tableName);
}
}
@Override
public boolean isLimitOffsetSupported() {
return useOffsetLimit;
}
@Override
public void applyLimitOffset(StringBuffer sql, int limit, int offset) {
if(offset == 0) {
int idx = getAfterSelectInsertPoint(sql.toString());
sql.insert(idx, " top " + limit);
} else {
// if we have a nested query (used in sql views) we might have a inner order by,
// check for the last closed )
int lastClosed = sql.lastIndexOf(")");
int orderByIndex = sql.lastIndexOf("ORDER BY");
CharSequence orderBy;
if(orderByIndex > 0 && orderByIndex > lastClosed) {
// we'll move the order by into the ROW_NUMBER call
orderBy = sql.subSequence(orderByIndex, sql.length());
sql.delete(orderByIndex, orderByIndex + orderBy.length());
} else {
// ROW_NUMBER requires an order by clause, we need to feed it something
orderBy = "ORDER BY CURRENT_TIMESTAMP";
}
// now insert the order by inside the select
Matcher fromMatcher = FROM_PATTERN.matcher(sql);
fromMatcher.find();
int fromStart = fromMatcher.start(2);
sql.insert(fromStart - 1, ", ROW_NUMBER() OVER (" + orderBy + ") AS _GT_ROW_NUMBER ");
// and wrap inside a block that selects the portion we want
sql.insert(0, "SELECT * FROM (");
sql.append(") AS _GT_PAGING_SUBQUERY WHERE ");
if(offset > 0) {
sql.append("_GT_ROW_NUMBER > " + offset);
}
if(limit >= 0 && limit < Integer.MAX_VALUE) {
int max = limit;
if(offset > 0) {
max += offset;
sql.append(" AND ");
}
sql.append("_GT_ROW_NUMBER <= " + max);
}
}
}
int getAfterSelectInsertPoint(String sql) {
final int selectIndex = sql.toLowerCase().indexOf( "select" );
final int selectDistinctIndex = sql.toLowerCase().indexOf( "select distinct" );
return selectIndex + (selectDistinctIndex == selectIndex ? 15 : 6);
}
@Override
public void encodeValue(Object value, Class type, StringBuffer sql) {
if(byte[].class.equals(type)) {
byte[] b = (byte[]) value;
//encode as hex string
sql.append("0x");
for (int i=0; i < b.length; i++) {
sql.append(Integer.toString( ( b[i] & 0xff ) + 0x100, 16).substring( 1 ));
}
} else {
super.encodeValue(value, type, sql);
}
}
/**
* The geometry metadata table in use, if any
* @return
*/
public String getGeometryMetadataTable() {
return geometryMetadataTable;
}
/**
* Sets the geometry metadata table
* @param geometryMetadataTable
*/
public void setGeometryMetadataTable(String geometryMetadataTable) {
this.geometryMetadataTable = geometryMetadataTable;
}
/**
* Sets whether to use offset limit or not
* @param useOffsetLimit
*/
public void setUseOffSetLimit(Boolean useOffsetLimit) {
this.useOffsetLimit = useOffsetLimit;
}
/**
* Sets whether to use native SQL Server binary serialization or WKB serialization
* @param useNativeSerialization
*/
public void setUseNativeSerialization(Boolean useNativeSerialization) {
this.useNativeSerialization = useNativeSerialization;
}
/**
* Sets whether to force the usage of spatial indexes by including a WITH INDEX hint
* @param useNativeSerialization
*/
public void setForceSpatialIndexes(boolean forceSpatialIndexes) {
this.forceSpatialIndexes = forceSpatialIndexes;
}
/**
* Sets a comma separated list of table hints that will be added to every select query
*
* @param tableHints
*/
public void setTableHints(String tableHints) {
if (tableHints == null) {
this.tableHints = null;
} else {
tableHints = tableHints.trim();
if (tableHints.isEmpty()) {
this.tableHints = null;
} else {
this.tableHints = tableHints;
}
}
}
/**
* Drop the index. Subclasses can override to handle extra syntax or db specific situations
*
* @param cx
* @param schema
* @param databaseSchema
* @param indexName
* @throws SQLException
*/
public void dropIndex(Connection cx, SimpleFeatureType schema, String databaseSchema,
String indexName) throws SQLException {
StringBuffer sql = new StringBuffer();
String escape = getNameEscape();
sql.append("DROP INDEX ");
sql.append(escape).append(indexName).append(escape);
sql.append(" ON ");
if (databaseSchema != null) {
encodeSchemaName(databaseSchema, sql);
sql.append(".");
}
sql.append(escape).append(schema.getTypeName()).append(escape);
Statement st = null;
try {
st = cx.createStatement();
st.execute(sql.toString());
if(!cx.getAutoCommit()) {
cx.commit();
}
} finally {
dataStore.closeSafe(cx);
}
}
@Override
public void postCreateFeatureType(SimpleFeatureType featureType, DatabaseMetaData md,
String databaseSchema, Connection cx) throws SQLException {
// collect the spatial indexes (index metadata does not work properly for spatial indexes)
String sql = "SELECT \n" +
" index_name = ind.name,\n" +
" column_name = col.name\n" +
"FROM \n" +
" sys.indexes ind \n" +
"INNER JOIN \n" +
" sys.index_columns ic ON ind.object_id = ic.object_id and ind.index_id = ic.index_id \n" +
"INNER JOIN \n" +
" sys.columns col ON ic.object_id = col.object_id and ic.column_id = col.column_id \n" +
"INNER JOIN \n" +
" sys.tables t ON ind.object_id = t.object_id \n" +
"WHERE \n" +
" ind.type_desc = 'SPATIAL'\n" +
" and t.name = '" + featureType.getTypeName() + "'";
ResultSet indexInfo = null;
Statement st = null;
Map<String, Set<String>> indexes = new HashMap<String, Set<String>>();
try {
st = cx.createStatement();
indexInfo = st.executeQuery(sql);
while (indexInfo.next()) {
String indexName = indexInfo.getString("index_name");
String columnName = indexInfo.getString("column_name");
Set<String> indexColumns = indexes.get(indexName);
if (indexColumns == null) {
indexColumns = new HashSet<String>();
indexes.put(indexName, indexColumns);
}
indexColumns.add(columnName);
}
} finally {
dataStore.closeSafe(st);
dataStore.closeSafe(indexInfo);
}
// search for single column spatial indexes and attach them to the descriptors
for (Map.Entry<String, Set<String>> entry : indexes.entrySet()) {
Set<String> columns = entry.getValue();
if(columns.size() == 1) {
String column = columns.iterator().next();
AttributeDescriptor descriptor = featureType.getDescriptor(column);
if(descriptor instanceof GeometryDescriptor) {
descriptor.getUserData().put(SPATIAL_INDEX_KEY, entry.getKey());
}
}
}
}
@Override
public void handleSelectHints(StringBuffer sql, SimpleFeatureType featureType, Query query) {
// optional feature, apply only if requested
if (!forceSpatialIndexes && tableHints == null) {
return;
}
// apply the index hints
String fromStatement;
String typeName = featureType.getTypeName();
String schema = dataStore.getDatabaseSchema();
if (schema == null) {
fromStatement = "FROM \"" + typeName + "\"";
} else {
fromStatement = "FROM \"" + schema + "\".\""
+ typeName + "\"";
}
int idx = sql.indexOf(fromStatement);
if(idx > 0) {
int base = idx + fromStatement.length();
StringBuilder sb = new StringBuilder(" WITH(");
// check the spatial index hints
Set<String> indexes = getSpatialIndexes(featureType, query);
if (!indexes.isEmpty()) {
sb.append("INDEX(");
for (String indexName : indexes) {
sb.append("\"").append(indexName).append("\"").append(",");
}
sb.setLength(sb.length() - 1);
sb.append(")");
} else if(tableHints == null) {
// no spatial indexes, and we don't have anything else to add either
return;
}
// do we need a comma between spatial index hints and other table hints?
if (!indexes.isEmpty() && tableHints != null) {
sb.append(", ");
}
// other table hints
if (tableHints != null) {
sb.append(tableHints);
}
sb.append(")");
// finally insert the table hints
String tableHint = sb.toString();
sql.insert(base, tableHint);
}
}
private Set<String> getSpatialIndexes(SimpleFeatureType featureType, Query query) {
if (!forceSpatialIndexes) {
return Collections.emptySet();
}
// check we have a filter
Filter filter = query.getFilter();
if(filter == Filter.INCLUDE) {
return Collections.emptySet();
}
// that is has spatial attributes
SpatialIndexAttributeExtractor attributesExtractor = new SpatialIndexAttributeExtractor();
filter.accept(attributesExtractor, null);
Map<String, Integer> attributes = attributesExtractor.getSpatialProperties();
if(attributes.isEmpty() || attributes.size() > 1) {
return Collections.emptySet();
}
// and that those attributes have a spatial index
Set<String> indexes = new HashSet<String>();
for (Map.Entry<String, Integer> attribute : attributes.entrySet()) {
// we can only apply one index on one condition
if(attribute.getValue() > 1) {
continue;
}
AttributeDescriptor descriptor = featureType.getDescriptor(attribute.getKey());
if(descriptor instanceof GeometryDescriptor) {
String indexName = (String) descriptor.getUserData().get(SPATIAL_INDEX_KEY);
if(indexName != null) {
indexes.add(indexName);
}
}
}
return indexes;
}
}