GDAL
ogreditablelayer.h
1 /******************************************************************************
2  * $Id$
3  *
4  * Project: OpenGIS Simple Features Reference Implementation
5  * Purpose: Defines OGREditableLayer class
6  * Author: Even Rouault <even.rouault at spatialys.com>
7  *
8  ******************************************************************************
9  * Copyright (c) 2015, Even Rouault <even.rouault at spatialys.com>
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a
12  * copy of this software and associated documentation files (the "Software"),
13  * to deal in the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  * and/or sell copies of the Software, and to permit persons to whom the
16  * Software is furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included
19  * in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  ****************************************************************************/
29 
30 #ifndef OGREDITABLELAYER_H_INCLUDED
31 #define OGREDITABLELAYER_H_INCLUDED
32 
34 #include "ogrlayerdecorator.h"
35 #include <set>
36 #include <map>
37 
38 class CPL_DLL IOGREditableLayerSynchronizer
39 {
40  public:
41  virtual ~IOGREditableLayerSynchronizer();
42 
43  virtual OGRErr EditableSyncToDisk(OGRLayer *poEditableLayer,
44  OGRLayer **ppoDecoratedLayer) = 0;
45 };
46 
47 class CPL_DLL OGREditableLayer : public OGRLayerDecorator
48 {
49  CPL_DISALLOW_COPY_ASSIGN(OGREditableLayer)
50 
51  protected:
52  IOGREditableLayerSynchronizer *m_poSynchronizer;
53  bool m_bTakeOwnershipSynchronizer;
54  OGRFeatureDefn *m_poEditableFeatureDefn;
55  GIntBig m_nNextFID;
56  std::set<GIntBig> m_oSetCreated{};
57  std::set<GIntBig> m_oSetEdited{};
58  std::set<GIntBig> m_oSetDeleted{};
59  std::set<GIntBig>::iterator m_oIter{};
60  std::set<CPLString> m_oSetDeletedFields{};
61  OGRLayer *m_poMemLayer;
62  bool m_bStructureModified;
63  bool m_bSupportsCreateGeomField;
64  bool m_bSupportsCurveGeometries;
65  std::map<CPLString, int> m_oMapEditableFDefnFieldNameToIdx{};
66 
67  OGRFeature *Translate(OGRFeatureDefn *poTargetDefn,
68  OGRFeature *poSrcFeature, bool bCanStealSrcFeature,
69  bool bHideDeletedFields);
70  void DetectNextFID();
71  int GetSrcGeomFieldIndex(int iGeomField);
72 
73  public:
74  OGREditableLayer(OGRLayer *poDecoratedLayer,
75  bool bTakeOwnershipDecoratedLayer,
76  IOGREditableLayerSynchronizer *poSynchronizer,
77  bool bTakeOwnershipSynchronizer);
78  virtual ~OGREditableLayer();
79 
80  void SetNextFID(GIntBig nNextFID);
81  void SetSupportsCreateGeomField(bool SupportsCreateGeomField);
82  void SetSupportsCurveGeometries(bool bSupportsCurveGeometries);
83 
84  virtual OGRGeometry *GetSpatialFilter() override;
85  virtual void SetSpatialFilter(OGRGeometry *) override;
86  virtual void SetSpatialFilterRect(double dfMinX, double dfMinY,
87  double dfMaxX, double dfMaxY) override;
88  virtual void SetSpatialFilter(int iGeomField, OGRGeometry *) override;
89  virtual void SetSpatialFilterRect(int iGeomField, double dfMinX,
90  double dfMinY, double dfMaxX,
91  double dfMaxY) override;
92 
93  virtual OGRErr SetAttributeFilter(const char *) override;
94  virtual bool GetArrowStream(struct ArrowArrayStream *out_stream,
95  CSLConstList papszOptions = nullptr) override;
96 
97  virtual void ResetReading() override;
98  virtual OGRFeature *GetNextFeature() override;
99  virtual OGRErr SetNextByIndex(GIntBig nIndex) override;
100  virtual OGRFeature *GetFeature(GIntBig nFID) override;
101  virtual OGRErr ISetFeature(OGRFeature *poFeature) override;
102  virtual OGRErr ICreateFeature(OGRFeature *poFeature) override;
103  virtual OGRErr IUpsertFeature(OGRFeature *poFeature) override;
104  OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,
105  const int *panUpdatedFieldsIdx,
106  int nUpdatedGeomFieldsCount,
107  const int *panUpdatedGeomFieldsIdx,
108  bool bUpdateStyleString) override;
109  virtual OGRErr DeleteFeature(GIntBig nFID) override;
110 
111  virtual OGRwkbGeometryType GetGeomType() override;
112  virtual OGRFeatureDefn *GetLayerDefn() override;
113 
114  virtual OGRSpatialReference *GetSpatialRef() override;
115 
116  virtual GIntBig GetFeatureCount(int bForce = TRUE) override;
117  virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent,
118  int bForce = TRUE) override;
119  virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override;
120 
121  virtual int TestCapability(const char *) override;
122 
123  virtual OGRErr CreateField(const OGRFieldDefn *poField,
124  int bApproxOK = TRUE) override;
125  virtual OGRErr DeleteField(int iField) override;
126  virtual OGRErr ReorderFields(int *panMap) override;
127  virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,
128  int nFlags) override;
129  virtual OGRErr
130  AlterGeomFieldDefn(int iGeomField,
131  const OGRGeomFieldDefn *poNewGeomFieldDefn,
132  int nFlags) override;
133 
134  virtual OGRErr CreateGeomField(const OGRGeomFieldDefn *poField,
135  int bApproxOK = TRUE) override;
136 
137  virtual OGRErr SyncToDisk() override;
138 
139  virtual OGRErr StartTransaction() override;
140  virtual OGRErr CommitTransaction() override;
141  virtual OGRErr RollbackTransaction() override;
142 
143  virtual const char *GetGeometryColumn() override;
144 };
145 
147 
148 #endif // OGREDITABLELAYER_H_INCLUDED
Simple container for a bounding region (rectangle)
Definition: ogr_core.h:61
Definition of a feature class or feature layer.
Definition: ogr_feature.h:517
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:893
Definition of an attribute of an OGRFeatureDefn.
Definition: ogr_feature.h:111
Definition of a geometry field of an OGRFeatureDefn.
Definition: ogr_feature.h:346
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:377
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:74
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:169
#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
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1183
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:215
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:416
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:387