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
47 OGRLayerDecorator(OGRLayer* poDecoratedLayer,
48 int bTakeOwnership);
49 virtual ~OGRLayerDecorator();
50
51 virtual OGRGeometry *GetSpatialFilter() override;
52 virtual void SetSpatialFilter( OGRGeometry * ) override;
53 virtual void SetSpatialFilterRect( double dfMinX, double dfMinY,
54 double dfMaxX, double dfMaxY ) override;
55 virtual void SetSpatialFilter( int iGeomField, OGRGeometry * ) override;
56 virtual void SetSpatialFilterRect( int iGeomField, double dfMinX, double dfMinY,
57 double dfMaxX, double dfMaxY ) override;
58
59 virtual OGRErr SetAttributeFilter( const char * ) override;
60
61 virtual void ResetReading() override;
62 virtual OGRFeature *GetNextFeature() override;
63 virtual OGRErr SetNextByIndex( GIntBig nIndex ) override;
64 virtual OGRFeature *GetFeature( GIntBig nFID ) override;
65 virtual OGRErr ISetFeature( OGRFeature *poFeature ) override;
66 virtual OGRErr ICreateFeature( OGRFeature *poFeature ) override;
67 virtual OGRErr DeleteFeature( GIntBig nFID ) override;
68
69 virtual const char *GetName() override;
70 virtual OGRwkbGeometryType GetGeomType() override;
71 virtual OGRFeatureDefn *GetLayerDefn() override;
72
73 virtual OGRSpatialReference *GetSpatialRef() override;
74
75 virtual GIntBig GetFeatureCount( int bForce = TRUE ) override;
76 virtual OGRErr GetExtent(int iGeomField, OGREnvelope *psExtent, int bForce = TRUE) override;
77 virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce = TRUE) override;
78
79 virtual int TestCapability( const char * ) override;
80
81 virtual OGRErr CreateField( OGRFieldDefn *poField,
82 int bApproxOK = TRUE ) override;
83 virtual OGRErr DeleteField( int iField ) override;
84 virtual OGRErr ReorderFields( int* panMap ) override;
85 virtual OGRErr AlterFieldDefn( int iField, OGRFieldDefn* poNewFieldDefn, int nFlags ) override;
86
87 virtual OGRErr CreateGeomField( OGRGeomFieldDefn *poField,
88 int bApproxOK = TRUE ) override;
89
90 virtual OGRErr SyncToDisk() override;
91
92 virtual OGRStyleTable *GetStyleTable() override;
93 virtual void SetStyleTableDirectly( OGRStyleTable *poStyleTable ) override;
94
95 virtual void SetStyleTable(OGRStyleTable *poStyleTable) override;
96
97 virtual OGRErr StartTransaction() override;
98 virtual OGRErr CommitTransaction() override;
99 virtual OGRErr RollbackTransaction() override;
100
101 virtual const char *GetFIDColumn() override;
102 virtual const char *GetGeometryColumn() override;
103
104 virtual OGRErr SetIgnoredFields( const char **papszFields ) override;
105
106 virtual char **GetMetadata( const char * pszDomain = "" ) override;
107 virtual CPLErr SetMetadata( char ** papszMetadata,
108 const char * pszDomain = "" ) override;
109 virtual const char *GetMetadataItem( const char * pszName,
110 const char * pszDomain = "" ) override;
111 virtual CPLErr SetMetadataItem( const char * pszName,
112 const char * pszValue,
113 const char * pszDomain = "" ) override;
114 virtual OGRErr Rename(const char* pszNewName) override;
115
116 OGRLayer* GetBaseLayer() const { return m_poDecoratedLayer; }
117 };
118
119 #endif /* #ifndef DOXYGEN_SKIP */
120
121 #endif // OGRLAYERDECORATOR_H_INCLUDED
OGRLayer::GetName
virtual const char * GetName()
Return the layer name.
Definition: ogrlayer.cpp:1727
OGRLayer::CreateField
virtual OGRErr CreateField(OGRFieldDefn *poField, int bApproxOK=TRUE)
Create a new field on a layer.
Definition: ogrlayer.cpp:665
OGRLayer::ReorderFields
virtual OGRErr ReorderFields(int *panMap)
Reorder all the fields of a layer.
Definition: ogrlayer.cpp:733
OGRLayer::ICreateFeature
virtual OGRErr ICreateFeature(OGRFeature *poFeature)
Create and write a new feature within a layer.
Definition: ogrlayer.cpp:637
OGRLayer::DeleteField
virtual OGRErr DeleteField(int iField)
Delete an existing field on a layer.
Definition: ogrlayer.cpp:701
OGRLayer::ResetReading
virtual void ResetReading()=0
Reset feature reading to start on the first feature.
OGRLayer::DeleteFeature
virtual OGRErr DeleteFeature(GIntBig nFID)
Delete feature from layer.
Definition: ogrlayer.cpp:1546
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:1037
OGRSpatialReference
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:157
OGRLayer::GetFeatureCount
virtual GIntBig GetFeatureCount(int bForce=TRUE)
Fetch the feature count in this layer.
Definition: ogrlayer.cpp:173
OGRLayer::SetStyleTable
virtual void SetStyleTable(OGRStyleTable *poStyleTable)
Set layer style table.
Definition: ogrlayer.cpp:1673
GDALMajorObject::SetMetadataItem
virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="")
Set single metadata item.
Definition: gdalmajorobject.cpp:388
OGRGeometry
Abstract base class for all geometry classes.
Definition: ogr_geometry.h:326
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:1596
OGRLayer
This class represents a layer of simple features, with access methods.
Definition: ogrsf_frmts.h:70
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:1623
OGRLayer::GetSpatialFilter
virtual OGRGeometry * GetSpatialFilter()
This method returns the current spatial filter for this layer.
Definition: ogrlayer.cpp:1085
OGRLayer::GetExtent
virtual OGRErr GetExtent(OGREnvelope *psExtent, int bForce=TRUE)
Fetch the extent of this layer.
Definition: ogrlayer.cpp:211
OGRLayer::ISetFeature
virtual OGRErr ISetFeature(OGRFeature *poFeature)
Rewrite an existing feature.
Definition: ogrlayer.cpp:598
OGRLayer::SetSpatialFilter
virtual void SetSpatialFilter(OGRGeometry *)
Set a new spatial filter.
Definition: ogrlayer.cpp:1113
OGRLayer::Rename
virtual OGRErr Rename(const char *pszNewName)
Rename layer.
Definition: ogrlayer.cpp:1880
GDALMajorObject::GetMetadataItem
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:344
OGRLayer::GetLayerDefn
virtual OGRFeatureDefn * GetLayerDefn()=0
Fetch the schema information for this layer.
OGRLayer::RollbackTransaction
virtual OGRErr RollbackTransaction()
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition: ogrlayer.cpp:966
GDALMajorObject::GetMetadata
virtual char ** GetMetadata(const char *pszDomain="")
Fetch metadata.
Definition: gdalmajorobject.cpp:249
OGRLayer::CreateGeomField
virtual OGRErr CreateGeomField(OGRGeomFieldDefn *poField, int bApproxOK=TRUE)
Create a new geometry field on a layer.
Definition: ogrlayer.cpp:876
ogrsf_frmts.h
OGRLayer::GetStyleTable
virtual OGRStyleTable * GetStyleTable()
Returns layer style table.
Definition: ogrlayer.cpp:1653
OGRFieldDefn
Definition of an attribute of an OGRFeatureDefn.
Definition: ogr_feature.h:98
GDALMajorObject::SetMetadata
virtual CPLErr SetMetadata(char **papszMetadata, const char *pszDomain="")
Set metadata.
Definition: gdalmajorobject.cpp:292
OGRLayer::SetSpatialFilterRect
virtual void SetSpatialFilterRect(double dfMinX, double dfMinY, double dfMaxX, double dfMaxY)
Set a new rectangular spatial filter.
Definition: ogrlayer.cpp:1184
OGRGeomFieldDefn
Definition of a geometry field of an OGRFeatureDefn.
Definition: ogr_feature.h:201
OGRErr
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:341
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:230
OGRLayer::StartTransaction
virtual OGRErr StartTransaction()
For datasources which support transactions, StartTransaction creates a transaction.
Definition: ogrlayer.cpp:912
OGRwkbGeometryType
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:368
OGRFeature
A simple feature, including geometry and attributes.
Definition: ogr_feature.h:379
OGRLayer::CommitTransaction
virtual OGRErr CommitTransaction()
For datasources which support transactions, CommitTransaction commits a transaction.
Definition: ogrlayer.cpp:939
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:499
OGRLayer::SetIgnoredFields
virtual OGRErr SetIgnoredFields(const char **papszFields)
Set which fields can be omitted when retrieving features from the layer.
Definition: ogrlayer.cpp:1791
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:278
OGRLayer::GetGeomType
virtual OGRwkbGeometryType GetGeomType()
Return the layer geometry type.
Definition: ogrlayer.cpp:1754
OGRLayer::SetAttributeFilter
virtual OGRErr SetAttributeFilter(const char *)
Set a new attribute query.
Definition: ogrlayer.cpp:338
OGRLayer::SetStyleTableDirectly
virtual void SetStyleTableDirectly(OGRStyleTable *poStyleTable)
Set layer style table.
Definition: ogrlayer.cpp:1662
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:841
OGRLayer::SyncToDisk
virtual OGRErr SyncToDisk()
Flush pending changes to disk.
Definition: ogrlayer.cpp:1519
OGRLayer::GetFeature
virtual OGRFeature * GetFeature(GIntBig nFID)
Fetch a feature by its identifier.
Definition: ogrlayer.cpp:447
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:927