GDAL

ogrlayerdecorator.h
1 /******************************************************************************
2 * $Id$
3 *
4 * Project: OpenGIS Simple Features Reference Implementation
5 * Purpose: Defines OGRLayerDecorator class
6 * Author: Even Rouault, even dot rouault at spatialys.com
7 *
8 ******************************************************************************
9 * Copyright (c) 2012-2013, Even Rouault <even dot 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 OGRLAYERDECORATOR_H_INCLUDED
31 #define OGRLAYERDECORATOR_H_INCLUDED
32
33 #ifndef DOXYGEN_SKIP
34
35 #include "ogrsf_frmts.h"
36
37 class CPL_DLL OGRLayerDecorator : public OGRLayer
38 {
39 CPL_DISALLOW_COPY_ASSIGN(OGRLayerDecorator)
40
41 protected:
42 OGRLayer *m_poDecoratedLayer;
43 int m_bHasOwnership;
44
45 public:
46 OGRLayerDecorator(OGRLayer *poDecoratedLayer, int bTakeOwnership);
47 virtual ~OGRLayerDecorator();
48
49 virtual OGRGeometry *GetSpatialFilter() override;
50 virtual void SetSpatialFilter(OGRGeometry *) override;
51 virtual void SetSpatialFilterRect(double dfMinX, double dfMinY,
52 double dfMaxX, double dfMaxY) override;
53 virtual void SetSpatialFilter(int iGeomField, OGRGeometry *) override;
54 virtual void SetSpatialFilterRect(int iGeomField, double dfMinX,
55 double dfMinY, double dfMaxX,
56 double dfMaxY) override;
57
58 virtual OGRErr SetAttributeFilter(const char *) override;
59
60 virtual void ResetReading() override;
61 virtual OGRFeature *GetNextFeature() override;
62 virtual OGRErr SetNextByIndex(GIntBig nIndex) override;
63 virtual OGRFeature *GetFeature(GIntBig nFID) override;
64 virtual OGRErr ISetFeature(OGRFeature *poFeature) override;
65 virtual OGRErr ICreateFeature(OGRFeature *poFeature) override;
66 virtual OGRErr IUpsertFeature(OGRFeature *poFeature) override;
67 virtual OGRErr DeleteFeature(GIntBig nFID) override;
68 OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,
69 const int *panUpdatedFieldsIdx,
70 int nUpdatedGeomFieldsCount,
71 const int *panUpdatedGeomFieldsIdx,
72 bool bUpdateStyleString) override;
73
74 virtual GDALDataset *GetDataset() override;
75 virtual bool GetArrowStream(struct ArrowArrayStream *out_stream,
76 CSLConstList papszOptions = nullptr) override;
77
78 virtual const char *GetName() override;
79 virtual OGRwkbGeometryType GetGeomType() override;
80 virtual OGRFeatureDefn *GetLayerDefn() override;
81
82 virtual OGRSpatialReference *GetSpatialRef() override;
83
84 virtual GIntBig GetFeatureCount(int bForce = TRUE) override;
85 virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent,
86 int bForce = TRUE) override;
87 virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override;
88
89 virtual int TestCapability(const char *) override;
90
91 virtual OGRErr CreateField(OGRFieldDefn *poField,
92 int bApproxOK = TRUE) override;
93 virtual OGRErr DeleteField(int iField) override;
94 virtual OGRErr ReorderFields(int *panMap) override;
95 virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,
96 int nFlags) override;
97 virtual OGRErr
98 AlterGeomFieldDefn(int iGeomField,
99 const OGRGeomFieldDefn *poNewGeomFieldDefn,
100 int nFlags) override;
101
102 virtual OGRErr CreateGeomField(OGRGeomFieldDefn *poField,
103 int bApproxOK = TRUE) override;
104
105 virtual OGRErr SyncToDisk() override;
106
107 virtual OGRStyleTable *GetStyleTable() override;
108 virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable) override;
109
110 virtual void SetStyleTable(OGRStyleTable *poStyleTable) override;
111
112 virtual OGRErr StartTransaction() override;
113 virtual OGRErr CommitTransaction() override;
114 virtual OGRErr RollbackTransaction() override;
115
116 virtual const char *GetFIDColumn() override;
117 virtual const char *GetGeometryColumn() override;
118
119 virtual OGRErr SetIgnoredFields(const char **papszFields) override;
120
121 virtual char **GetMetadata(const char *pszDomain = "") override;
122 virtual CPLErr SetMetadata(char **papszMetadata,
123 const char *pszDomain = "") override;
124 virtual const char *GetMetadataItem(const char *pszName,
125 const char *pszDomain = "") override;
126 virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue,
127 const char *pszDomain = "") override;
128 virtual OGRErr Rename(const char *pszNewName) override;
129
130 OGRLayer *GetBaseLayer() const
131 {
132 return m_poDecoratedLayer;
133 }
134 };
135
136 #endif /* #ifndef DOXYGEN_SKIP */
137
138 #endif // OGRLAYERDECORATOR_H_INCLUDED
OGRLayer::GetName
virtual const char * GetName()
Return the layer name.
Definition: ogrlayer.cpp:1917
OGRLayer::CreateField
virtual OGRErr CreateField(OGRFieldDefn *poField, int bApproxOK=TRUE)
Create a new field on a layer.
Definition: ogrlayer.cpp:814
OGRLayer::ReorderFields
virtual OGRErr ReorderFields(int *panMap)
Reorder all the fields of a layer.
Definition: ogrlayer.cpp:881
OGRLayer::ICreateFeature
virtual OGRErr ICreateFeature(OGRFeature *poFeature)
Create and write a new feature within a layer.
Definition: ogrlayer.cpp:649
OGRLayer::DeleteField
virtual OGRErr DeleteField(int iField)
Delete an existing field on a layer.
Definition: ogrlayer.cpp:849
OGRLayer::ResetReading
virtual void ResetReading()=0
Reset feature reading to start on the first feature.
OGRLayer::IUpdateFeature
virtual OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount, const int *panUpdatedFieldsIdx, int nUpdatedGeomFieldsCount, const int *panUpdatedGeomFieldsIdx, bool bUpdateStyleString)
Update (part of) an existing feature.
Definition: ogrlayer.cpp:757
OGRLayer::DeleteFeature
virtual OGRErr DeleteFeature(GIntBig nFID)
Delete feature from layer.
Definition: ogrlayer.cpp:1738
OGRStyleTable
This class represents a style table.
Definition: ogr_featurestyle.h:84
OGRLayer::GetSpatialRef
virtual OGRSpatialReference * GetSpatialRef()
Fetch the spatial reference system for this layer.
Definition: ogrlayer.cpp:1225
OGRSpatialReference
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:166
OGRLayer::GetFeatureCount
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition: ogrlayer.cpp:178
OGRLayer::SetStyleTable
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set layer style table.
Definition: ogrlayer.cpp:1865
GDALMajorObject::SetMetadataItem
virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="")
Set single metadata item.
Definition: gdalmajorobject.cpp:385
OGRGeometry
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:334
OGRLayer::GetFIDColumn
virtual const char * GetFIDColumn()
This method returns the name of the underlying database column being used as the FID column,...
Definition: ogrlayer.cpp:1788
OGRLayer
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:72
OGRLayer::GetGeometryColumn
virtual const char * GetGeometryColumn()
This method returns the name of the underlying database column being used as the geometry column,...
Definition: ogrlayer.cpp:1815
OGRLayer::GetSpatialFilter
virtual OGRGeometry * GetSpatialFilter()
This method returns the current spatial filter for this layer.
Definition: ogrlayer.cpp:1274
OGRLayer::GetExtent
virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce=TRUE)
Fetch the extent of this layer.
Definition: ogrlayer.cpp:216
OGRLayer::ISetFeature
virtual OGRErr ISetFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature.
Definition: ogrlayer.cpp:609
OGRLayer::SetSpatialFilter
virtual void SetSpatialFilter(OGRGeometry *)
Set a new spatial filter.
Definition: ogrlayer.cpp:1302
OGRLayer::Rename
virtual OGRErr Rename(const char *pszNewName)
Rename layer.
Definition: ogrlayer.cpp:2070
GDALMajorObject::GetMetadataItem
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:341
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:347
OGRLayer::IUpsertFeature
virtual OGRErr IUpsertFeature(OGRFeature *poFeature)
Rewrite/replace an existing feature or create a new feature within a layer.
Definition: ogrlayer.cpp:689
OGRLayer::RollbackTransaction
virtual OGRErr RollbackTransaction()
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition: ogrlayer.cpp:1150
GDALMajorObject::GetMetadata
virtual char ** GetMetadata(const char *pszDomain="")
Fetch metadata.
Definition: gdalmajorobject.cpp:247
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1195
OGRLayer::CreateGeomField
virtual OGRErr CreateGeomField(OGRGeomFieldDefn *poField, int bApproxOK=TRUE)
Create a new geometry field on a layer.
Definition: ogrlayer.cpp:1060
OGRLayer::AlterGeomFieldDefn
virtual OGRErr AlterGeomFieldDefn(int iGeomField, const OGRGeomFieldDefn *poNewGeomFieldDefn, int nFlagsIn)
Alter the definition of an existing geometry field on a layer.
Definition: ogrlayer.cpp:1025
ogrsf_frmts.h
OGRLayer::GetStyleTable
virtual OGRStyleTable * GetStyleTable()
Returns layer style table.
Definition: ogrlayer.cpp:1845
OGRFieldDefn
Definition of an attribute of an OGRFeatureDefn.
Definition: ogr_feature.h:103
GDALMajorObject::SetMetadata
virtual CPLErr SetMetadata(char **papszMetadata, const char *pszDomain="")
Set metadata.
Definition: gdalmajorobject.cpp:290
OGRLayer::SetSpatialFilterRect
virtual void SetSpatialFilterRect(double dfMinX, double dfMinY, double dfMaxX, double dfMaxY)
Set a new rectangular spatial filter.
Definition: ogrlayer.cpp:1373
OGRGeomFieldDefn
Definition of a geometry field of an OGRFeatureDefn.
Definition: ogr_feature.h:275
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:235
OGRLayer::StartTransaction
virtual OGRErr StartTransaction()
For datasources which support transactions, StartTransaction creates a transaction.
Definition: ogrlayer.cpp:1096
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:406
OGRFeature
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:669
OGRLayer::CommitTransaction
virtual OGRErr CommitTransaction()
For datasources which support transactions, CommitTransaction commits a transaction.
Definition: ogrlayer.cpp:1123
OGRLayer::GetDataset
virtual GDALDataset * GetDataset()
Return the dataset associated with this layer.
Definition: ogrlayer.cpp:6721
CPLErr
CPLErr
Error category.
Definition: cpl_error.h:52
OGRLayer::SetNextByIndex
virtual OGRErr SetNextByIndex(GIntBig nIndex)
Move read cursor to the nIndex'th feature in the current resultset.
Definition: ogrlayer.cpp:506
OGRLayer::SetIgnoredFields
virtual OGRErr SetIgnoredFields(const char **papszFields)
Set which fields can be omitted when retrieving features from the layer.
Definition: ogrlayer.cpp:1981
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:374
OGRLayer::GetGeomType
virtual OGRwkbGeometryType GetGeomType()
Return the layer geometry type.
Definition: ogrlayer.cpp:1944
OGRLayer::SetAttributeFilter
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition: ogrlayer.cpp:345
OGRLayer::SetStyleTableDirectly
virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable)
Set layer style table.
Definition: ogrlayer.cpp:1854
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::AlterFieldDefn
virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn, int nFlagsIn)
Alter the definition of an existing field on a layer.
Definition: ogrlayer.cpp:988
OGRLayer::GetArrowStream
virtual bool GetArrowStream(struct ArrowArrayStream *out_stream, CSLConstList papszOptions=nullptr)
Get a Arrow C stream.
Definition: ogrlayer.cpp:6867
OGRLayer::SyncToDisk
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition: ogrlayer.cpp:1711
OGRLayer::GetFeature
virtual OGRFeature * GetFeature(GIntBig nFID)
Fetch a feature by its identifier.
Definition: ogrlayer.cpp:452
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:1051