001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/tags/2.1/src/org/deegree/io/datastore/sql/generic/GenericSQLWhereBuilder.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2006 by:
006 EXSE, Department of Geography, University of Bonn
007 http://www.giub.uni-bonn.de/deegree/
008 lat/lon GmbH
009 http://www.lat-lon.de
010
011 This library is free software; you can redistribute it and/or
012 modify it under the terms of the GNU Lesser General Public
013 License as published by the Free Software Foundation; either
014 version 2.1 of the License, or (at your option) any later version.
015
016 This library is distributed in the hope that it will be useful,
017 but WITHOUT ANY WARRANTY; without even the implied warranty of
018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 Lesser General Public License for more details.
020
021 You should have received a copy of the GNU Lesser General Public
022 License along with this library; if not, write to the Free Software
023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024
025 Contact:
026
027 Andreas Poth
028 lat/lon GmbH
029 Aennchenstraße 19
030 53177 Bonn
031 Germany
032 E-Mail: poth@lat-lon.de
033
034 Prof. Dr. Klaus Greve
035 Department of Geography
036 University of Bonn
037 Meckenheimer Allee 166
038 53115 Bonn
039 Germany
040 E-Mail: greve@giub.uni-bonn.de
041
042 ---------------------------------------------------------------------------*/
043 package org.deegree.io.datastore.sql.generic;
044
045 import java.sql.Types;
046 import java.util.List;
047
048 import org.deegree.i18n.Messages;
049 import org.deegree.io.JDBCConnection;
050 import org.deegree.io.datastore.DatastoreException;
051 import org.deegree.io.datastore.schema.MappedFeatureType;
052 import org.deegree.io.datastore.schema.content.MappingField;
053 import org.deegree.io.datastore.sql.StatementBuffer;
054 import org.deegree.io.datastore.sql.TableAliasGenerator;
055 import org.deegree.io.datastore.sql.VirtualContentProvider;
056 import org.deegree.io.datastore.sql.wherebuilder.WhereBuilder;
057 import org.deegree.io.quadtree.DBQuadtree;
058 import org.deegree.io.quadtree.DBQuadtreeManager;
059 import org.deegree.io.quadtree.IndexException;
060 import org.deegree.io.quadtree.Quadtree;
061 import org.deegree.model.filterencoding.Filter;
062 import org.deegree.model.filterencoding.OperationDefines;
063 import org.deegree.model.filterencoding.SpatialOperation;
064 import org.deegree.model.spatialschema.Envelope;
065 import org.deegree.ogcbase.SortProperty;
066
067 /**
068 * {@link WhereBuilder} implementation for the {@link GenericSQLDatastore}.
069 * <p>
070 * Uses the {@link Quadtree} to speed up BBOX queries.
071 *
072 * @see org.deegree.io.quadtree
073 *
074 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
075 * @author last edited by: $Author: mschneider $
076 *
077 * @version $Revision: 6685 $, $Date: 2007-04-24 20:35:53 +0200 (Di, 24 Apr 2007) $
078 */
079 class GenericSQLWhereBuilder extends WhereBuilder {
080
081 private final static String SQL_TRUE = "1=1";
082
083 private final static String SQL_FALSE = "1!=1";
084
085 private JDBCConnection jdbc;
086
087 /**
088 * Creates a new instance of <code>GenericSQLWhereBuilder</code> from the given parameters.
089 *
090 * @param rootFts
091 * selected feature types, more than one type means that the types are joined
092 * @param aliases
093 * aliases for the feature types, may be null (must have same length as rootFts
094 * otherwise)
095 * @param filter
096 * filter that restricts the matched features
097 * @param sortProperties
098 * sort criteria for the result, may be null or empty
099 * @param aliasGenerator
100 * used to generate unique table aliases
101 * @param vcProvider
102 * @param jdbc
103 * @throws DatastoreException
104 */
105 public GenericSQLWhereBuilder( MappedFeatureType[] rootFts, String[] aliases, Filter filter,
106 SortProperty[] sortProperties, TableAliasGenerator aliasGenerator,
107 VirtualContentProvider vcProvider, JDBCConnection jdbc ) throws DatastoreException {
108 super( rootFts, aliases, filter, sortProperties, aliasGenerator, vcProvider );
109 this.jdbc = jdbc;
110 }
111
112 /**
113 * Generates an SQL-fragment for the given object.
114 *
115 * TODO: Implement BBOX faster using explicit B0X-constructor
116 *
117 * @throws DatastoreException
118 */
119 @Override
120 protected void appendSpatialOperationAsSQL( StatementBuffer query, SpatialOperation operation )
121 throws DatastoreException {
122
123 switch ( operation.getOperatorId() ) {
124 case OperationDefines.BBOX: {
125 appendBBOXOperationAsSQL( query, operation );
126 break;
127 }
128 case OperationDefines.DISJOINT:
129 case OperationDefines.CROSSES:
130 case OperationDefines.EQUALS:
131 case OperationDefines.WITHIN:
132 case OperationDefines.OVERLAPS:
133 case OperationDefines.TOUCHES:
134 case OperationDefines.CONTAINS:
135 case OperationDefines.INTERSECTS:
136 case OperationDefines.DWITHIN:
137 case OperationDefines.BEYOND: {
138 query.append( SQL_TRUE );
139 break;
140 }
141 default: {
142 String msg = Messages.getMessage( "DATASTORE_UNKNOWN_SPATIAL_OPERATOR",
143 OperationDefines.getNameById( operation.getOperatorId() ) );
144 throw new DatastoreException( msg );
145 }
146 }
147 }
148
149 /**
150 * Appends a constraint (FEATURE_ID IN (...)) to the given {@link StatementBuffer} which is
151 * generated by using the associated {@link DBQuadtree} index.
152 *
153 * @param query
154 * @param operation
155 * @throws DatastoreException
156 */
157 private void appendBBOXOperationAsSQL( StatementBuffer query, SpatialOperation operation )
158 throws DatastoreException {
159
160 Envelope env = operation.getGeometry().getEnvelope();
161
162 try {
163 DBQuadtreeManager qtm = new DBQuadtreeManager( jdbc, this.rootFts[0].getTable(), "geometry", null );
164 Envelope qtEnv = qtm.getQuadtree().getRootBoundingBox();
165 if ( qtEnv.intersects( env ) ) {
166 // check if features within this bbox are available
167 // if not -> return an empty list
168 List ids = qtm.getQuadtree().query( env );
169 if ( ids.size() > 0 ) {
170 int dataType = Types.VARCHAR;
171 if ( ids.get( 0 ) instanceof Integer ) {
172 dataType = Types.INTEGER;
173 }
174
175 MappingField[] idFields = this.rootFts[0].getGMLId().getIdFields();
176 if ( idFields.length > 1 ) {
177 String msg = "GenericSQLDatastore cannot handle composite feature ids.";
178 throw new DatastoreException( msg );
179 }
180
181 query.append( getRootTableAlias(0) + '.' + idFields[0].getField() + " IN (" );
182 for ( int i = 0; i < ids.size() - 1; i++ ) {
183 query.append( "?," );
184 if ( dataType == Types.VARCHAR ) {
185 query.addArgument( ( "" + ids.get( i ) ).trim(), Types.VARCHAR );
186 } else {
187 query.addArgument( ids.get( i ), Types.INTEGER );
188 }
189 }
190 if ( dataType == Types.VARCHAR ) {
191 query.addArgument( ( "" + ids.get( ids.size() - 1 ) ).trim(), Types.VARCHAR );
192 } else {
193 query.addArgument( ids.get( ids.size() - 1 ), Types.INTEGER );
194 }
195 query.append( "?)" );
196 } else {
197 query.append( SQL_FALSE );
198 }
199 } else {
200 query.append( SQL_FALSE );
201 }
202 } catch ( IndexException e ) {
203 LOG.logError( e.getMessage(), e );
204 throw new DatastoreException( "Could not initialize Quadtree: " + e.getMessage(), e );
205 }
206 }
207 }