GDAL

ogr_gensql.h
1 /******************************************************************************
2 * $Id$
3 *
4 * Project: OpenGIS Simple Features Reference Implementation
5 * Purpose: Classes related to generic implementation of ExecuteSQL().
6 * Author: Frank Warmerdam, warmerdam@pobox.com
7 *
8 ******************************************************************************
9 * Copyright (c) 2002, Frank Warmerdam
10 * Copyright (c) 2010-2013, Even Rouault <even dot rouault at spatialys.com>
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 * DEALINGS IN THE SOFTWARE.
29 ****************************************************************************/
30
31 #ifndef OGR_GENSQL_H_INCLUDED
32 #define OGR_GENSQL_H_INCLUDED
33
34 #include "ogrsf_frmts.h"
35 #include "ogr_swq.h"
36 #include "cpl_hash_set.h"
37 #include "cpl_string.h"
38
39 #include <vector>
40
43 #define GEOM_FIELD_INDEX_TO_ALL_FIELD_INDEX(poFDefn, iGeom) \
44 ((poFDefn)->GetFieldCount() + SPECIAL_FIELD_COUNT + (iGeom))
45
46 #define IS_GEOM_FIELD_INDEX(poFDefn, idx) \
47 (((idx) >= (poFDefn)->GetFieldCount() + SPECIAL_FIELD_COUNT) && \
48 ((idx) < (poFDefn)->GetFieldCount() + SPECIAL_FIELD_COUNT + \
49 (poFDefn)->GetGeomFieldCount()))
50
51 #define ALL_FIELD_INDEX_TO_GEOM_FIELD_INDEX(poFDefn, idx) \
52 ((idx) - ((poFDefn)->GetFieldCount() + SPECIAL_FIELD_COUNT))
53
54 /************************************************************************/
55 /* OGRGenSQLResultsLayer */
56 /************************************************************************/
57
58 class OGRGenSQLResultsLayer final : public OGRLayer
59 {
60 private:
61 GDALDataset *poSrcDS;
62 OGRLayer *poSrcLayer;
63 void *pSelectInfo;
64
65 std::string m_osInitialWHERE{};
66 bool m_bForwardWhereToSourceLayer = true;
67 bool m_bEOF = false;
68
69 OGRLayer **papoTableLayers;
70
71 OGRFeatureDefn *poDefn;
72
73 int *panGeomFieldToSrcGeomField;
74
75 size_t nIndexSize;
76 GIntBig *panFIDIndex;
77 int bOrderByValid;
78
79 GIntBig nNextIndexFID;
80 OGRFeature *poSummaryFeature;
81
82 int iFIDFieldIndex;
83
84 int nExtraDSCount;
85 GDALDataset **papoExtraDS;
86
87 GIntBig nIteratedFeatures;
88 std::vector<CPLString> m_oDistinctList;
89
90 int PrepareSummary();
91
92 OGRFeature *TranslateFeature(OGRFeature *);
93 void CreateOrderByIndex();
94 void ReadIndexFields(OGRFeature *poSrcFeat, int nOrderItems,
95 OGRField *pasIndexFields);
96 void SortIndexSection(const OGRField *pasIndexFields, GIntBig *panMerged,
97 size_t nStart, size_t nEntries);
98 void FreeIndexFields(OGRField *pasIndexFields, size_t l_nIndexSize,
99 bool bFreeArray = true);
100 int Compare(const OGRField *pasFirst, const OGRField *pasSecond);
101
102 void ClearFilters();
103 void ApplyFiltersToSource();
104
105 void FindAndSetIgnoredFields();
106 void ExploreExprForIgnoredFields(swq_expr_node *expr, CPLHashSet *hSet);
107 void AddFieldDefnToSet(int iTable, int iColumn, CPLHashSet *hSet);
108
109 int ContainGeomSpecialField(swq_expr_node *expr);
110
111 void InvalidateOrderByIndex();
112
113 int MustEvaluateSpatialFilterOnGenSQL();
114
115 CPL_DISALLOW_COPY_ASSIGN(OGRGenSQLResultsLayer)
116
117 public:
118 OGRGenSQLResultsLayer(GDALDataset *poSrcDS, void *pSelectInfo,
119 OGRGeometry *poSpatFilter, const char *pszWHERE,
120 const char *pszDialect);
121 virtual ~OGRGenSQLResultsLayer();
122
123 virtual OGRGeometry *GetSpatialFilter() override;
124
125 virtual void ResetReading() override;
126 virtual OGRFeature *GetNextFeature() override;
127 virtual OGRErr SetNextByIndex(GIntBig nIndex) override;
128 virtual OGRFeature *GetFeature(GIntBig nFID) override;
129
130 virtual OGRFeatureDefn *GetLayerDefn() override;
131
132 virtual GIntBig GetFeatureCount(int bForce = TRUE) override;
133 virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override
134 {
135 return GetExtent(0, psExtent, bForce);
136 }
137 virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent,
138 int bForce = TRUE) override;
139
140 virtual int TestCapability(const char *) override;
141
142 virtual void SetSpatialFilter(OGRGeometry *poGeom) override
143 {
144 SetSpatialFilter(0, poGeom);
145 }
146 virtual void SetSpatialFilter(int iGeomField, OGRGeometry *) override;
147 virtual OGRErr SetAttributeFilter(const char *) override;
148 };
149
152 #endif /* ndef OGR_GENSQL_H_INCLUDED */
OGRLayer::ResetReading
virtual void ResetReading()=0
Reset feature reading to start on the first feature.
cpl_hash_set.h
OGRLayer::GetFeatureCount
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition: ogrlayer.cpp:177
OGRGeometry
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:334
OGRLayer
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:73
OGRLayer::GetSpatialFilter
virtual OGRGeometry * GetSpatialFilter()
This method returns the current spatial filter for this layer.
Definition: ogrlayer.cpp:1273
OGRLayer::GetExtent
virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce=TRUE)
Fetch the extent of this layer.
Definition: ogrlayer.cpp:215
OGRLayer::SetSpatialFilter
virtual void SetSpatialFilter(OGRGeometry *)
Set a new spatial filter.
Definition: ogrlayer.cpp:1301
OGRLayer::GetLayerDefn
virtual OGRFeatureDefn * GetLayerDefn()=0
Fetch the schema information for this layer.
GDALDataset
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:348
CPLHashSet
struct _CPLHashSet CPLHashSet
Opaque type for a hash set.
Definition: cpl_hash_set.h:52
OGRField
OGRFeature field attribute value union.
Definition: ogr_core.h:900
ogrsf_frmts.h
cpl_string.h
OGRErr
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:378
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:226
OGRFeature
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:680
OGRLayer::SetNextByIndex
virtual OGRErr SetNextByIndex(GIntBig nIndex)
Move read cursor to the nIndex'th feature in the current resultset.
Definition: ogrlayer.cpp:505
OGREnvelope
Simple container for a bounding region (rectangle)
Definition: ogr_core.h:57
OGRFeatureDefn
Definition of a feature class or feature layer.
Definition: ogr_feature.h:385
OGRLayer::SetAttributeFilter
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition: ogrlayer.cpp:344
OGRLayer::TestCapability
virtual int TestCapability(const char *)=0
Test if this layer supported the named capability.
OGRLayer::GetNextFeature
virtual OGRFeature * GetNextFeature()=0
Fetch the next available feature from this layer.
OGRLayer::GetFeature
virtual OGRFeature * GetFeature(GIntBig nFID)
Fetch a feature by its identifier.
Definition: ogrlayer.cpp:451
CPL_DISALLOW_COPY_ASSIGN
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:1042