Transactor.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/ws/ogc/wms/dataaccess/Transactor.h
22 
23  \brief Implementation of the transactor for the WS OGC WMS
24 
25  \author Emerson Moraes
26 */
27 
28 #ifndef __TERRALIB_WS_OGC_WMS_DATAACCESS_TRANSACTOR_H
29 #define __TERRALIB_WS_OGC_WMS_DATAACCESS_TRANSACTOR_H
30 
31 // STL
32 #include <map>
33 #include <memory>
34 #include <string>
35 
36 // TerraLib
37 #include "../../../../dataaccess/datasource/DataSourceTransactor.h"
38 #include "../client/WMSClient.h"
39 #include "Config.h"
40 #include "../client/DataTypes.h"
41 
42 namespace te
43 {
44  namespace ws
45  {
46  namespace ogc
47  {
48  namespace wms
49  {
50  namespace da
51  {
52 
53  class DataSource;
54 
55  /*!
56  \class Transactor
57 
58  \brief Implementation of the transactor for the WMS driver.
59  */
61  {
62  public:
63 
64  Transactor(const std::shared_ptr<te::ws::ogc::WMSClient> wms);
65 
66  ~Transactor();
67 
68  te::da::DataSource* getDataSource() const;
69 
70  void begin();
71 
72  void commit();
73 
74  void rollBack();
75 
76  bool isInTransaction() const;
77 
78  std::unique_ptr<te::da::DataSet> getDataSet(const std::string& name,
80  bool connected = false,
81  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
82 
83  std::unique_ptr<te::da::DataSet> getDataSet(const std::string& name,
84  const std::string& propertyName,
85  const te::gm::Envelope* e,
88  bool connected = false,
89  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
90 
91  std::unique_ptr<te::da::DataSet> getDataSet(const std::string& name,
92  const std::string& propertyName,
93  const te::gm::Geometry* g,
96  bool connected = false,
97  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
98 
99  std::unique_ptr<te::da::DataSet> getDataSet(const std::string& name,
100  const te::da::ObjectIdSet* oids,
102  bool connected = false,
103  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
104 
105  std::unique_ptr<te::da::DataSet> query(const te::da::Select& q,
107  bool connected = false,
108  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
109 
110  std::unique_ptr<te::da::DataSet> query(const std::string& query,
112  bool connected = false,
113  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
114 
115  void execute(const te::da::Query& command);
116 
117  void execute(const std::string& command);
118 
119  std::unique_ptr<te::da::PreparedQuery> getPrepared(const std::string& qName = std::string(""));
120 
121  std::unique_ptr<te::da::BatchExecutor> getBatchExecutor();
122 
123  void cancel();
124 
125  boost::int64_t getLastGeneratedId();
126 
127  std::string escape(const std::string& value);
128 
129  bool isDataSetNameValid(const std::string& datasetName);
130 
131  bool isPropertyNameValid(const std::string& propertyName);
132 
133  std::vector<std::string> getDataSetNames();
134 
135  std::size_t getNumberOfDataSets();
136 
137  std::unique_ptr<te::da::DataSetType> getDataSetType(const std::string& name);
138 
139  boost::ptr_vector<te::dt::Property> getProperties(const std::string& datasetName);
140 
141  std::unique_ptr<te::dt::Property> getProperty(const std::string& datasetName, const std::string& name);
142 
143  std::unique_ptr<te::dt::Property> getProperty(const std::string& datasetName, std::size_t propertyPos);
144 
145  std::vector<std::string> getPropertyNames(const std::string& datasetName);
146 
147  std::size_t getNumberOfProperties(const std::string& datasetName);
148 
149  bool propertyExists(const std::string& datasetName, const std::string& name);
150 
151  void addProperty(const std::string& datasetName , te::dt::Property* p);
152 
153  void dropProperty(const std::string& datasetName, const std::string& name);
154 
155  void renameProperty(const std::string& datasetName , const std::string& propertyName, const std::string& newPropertyName);
156 
157  std::unique_ptr<te::da::PrimaryKey> getPrimaryKey(const std::string& datasetName);
158 
159  bool primaryKeyExists(const std::string& datasetName, const std::string& name);
160 
161  void addPrimaryKey(const std::string& datasetName, te::da::PrimaryKey* pk);
162 
163  void dropPrimaryKey(const std::string& datasetName);
164 
165  std::unique_ptr<te::da::ForeignKey> getForeignKey(const std::string& datasetName, const std::string& name);
166 
167  std::vector<std::string> getForeignKeyNames(const std::string& datasetName);
168 
169  bool foreignKeyExists(const std::string& datasetName , const std::string& name);
170 
171  void addForeignKey(const std::string& datasetName, te::da::ForeignKey* fk);
172 
173  void dropForeignKey(const std::string& datasetName , const std::string& fkName);
174 
175  std::unique_ptr<te::da::UniqueKey> getUniqueKey(const std::string& datasetName, const std::string& name);
176 
177  std::vector<std::string> getUniqueKeyNames(const std::string& datasetName);
178 
179  bool uniqueKeyExists(const std::string& datasetName, const std::string& name);
180 
181  void addUniqueKey(const std::string& datasetName, te::da::UniqueKey* uk);
182 
183  void dropUniqueKey(const std::string& datasetName, const std::string& name);
184 
185  std::unique_ptr<te::da::CheckConstraint> getCheckConstraint(const std::string& datasetName, const std::string& name);
186 
187  std::vector<std::string> getCheckConstraintNames(const std::string& datasetName);
188 
189  bool checkConstraintExists(const std::string& datasetName, const std::string& name);
190 
191  void addCheckConstraint(const std::string& datasetName, te::da::CheckConstraint* cc);
192 
193  void dropCheckConstraint(const std::string& datasetName, const std::string& name);
194 
195  std::unique_ptr<te::da::Index> getIndex(const std::string& datasetName, const std::string& name);
196 
197  std::vector<std::string> getIndexNames(const std::string& datasetName);
198 
199  bool indexExists(const std::string& datasetName, const std::string& name);
200 
201  void addIndex(const std::string& datasetName, te::da::Index* idx, const std::map<std::string, std::string>& options);
202 
203  void dropIndex(const std::string& datasetName, const std::string& idxName);
204 
205  std::unique_ptr<te::da::Sequence> getSequence(const std::string& name);
206 
207  std::vector<std::string> getSequenceNames();
208 
209  bool sequenceExists(const std::string& name);
210 
211  void addSequence(te::da::Sequence* sequence);
212 
213  void dropSequence(const std::string& name);
214 
215  std::unique_ptr<te::gm::Envelope> getExtent(const std::string& datasetName,
216  const std::string& propertyName);
217 
218  std::unique_ptr<te::gm::Envelope> getExtent(const std::string& datasetName,
219  std::size_t propertyPos);
220 
221  std::size_t getNumberOfItems(const std::string& datasetName);
222 
223  bool hasDataSets();
224 
225  bool dataSetExists(const std::string& name);
226 
227  void createDataSet(te::da::DataSetType* dt,
228  const std::map<std::string, std::string>& options);
229 
230  void cloneDataSet(const std::string& name,
231  const std::string& cloneName,
232  const std::map<std::string, std::string>& options);
233 
234  void dropDataSet(const std::string& name);
235 
236  void renameDataSet(const std::string& name,
237  const std::string& newName);
238 
239  void add(const std::string& datasetName,
240  te::da::DataSet* d,
241  const std::map<std::string, std::string>& options,
242  std::size_t limit = 0,
243  bool enableProgress = true);
244 
245  void remove(const std::string& datasetName, const te::da::ObjectIdSet* oids = 0);
246 
247  void update(const std::string& datasetName,
248  te::da::DataSet* dataset,
249  const std::vector<std::size_t>& properties,
250  const te::da::ObjectIdSet* oids,
251  const std::map<std::string, std::string>& options,
252  std::size_t limit = 0);
253 
254  void optimize(const std::map<std::string, std::string>& opInfo);
255 
256  std::vector<std::string> getLayerNames();
257 
258  te::ws::ogc::wms::Layer getLayerByName(const std::string& layerName);
259 
260  protected:
261 
262  void createLayerMap(const te::ws::ogc::wms::Layer& rootLayer);
263 
264  private:
265 
266  std::shared_ptr<te::ws::ogc::WMSClient> m_wms;
267 
268  std::map<std::string, te::ws::ogc::wms::Layer> m_layerMap;
269  };
270 
271  } // end namespace da
272  } // end namespace wms
273  } // end namespace ogc
274  } // end namespace ws
275 } // end namespace te
276 
277 #endif // __TERRALIB_WS_OGC_WMS_DATAACCESS_TRANSACTOR_H
A class that models the description of a dataset.
Definition: DataSetType.h:72
SpatialRelation
Spatial relations between geometric objects.
Definition: Enums.h:127
It describes a sequence (a number generator).
Definition: Sequence.h:56
A class that describes a check constraint.
An abstract class for data providers like a DBMS, Web Services or a regular file. ...
Definition: DataSource.h:119
std::shared_ptr< te::ws::ogc::WMSClient > m_wms
Definition: Transactor.h:266
It models a property definition.
Definition: Property.h:59
AccessPolicy
Supported data access policies (can be used as bitfield).
Definition: Enums.h:40
TraverseType
A dataset can be traversed in two ways:
Definition: Enums.h:53
Configuration flags for the Terrralib WS OGC WMS DATA ACCESS module.
An Envelope defines a 2D rectangular region.
Definition: Envelope.h:51
This class represents a set of unique ids created in the same context. i.e. from the same data set...
Definition: ObjectIdSet.h:55
TerraLib.
The Layer WMS 1.3.0 struct.
Definition: DataTypes.h:212
It models a foreign key constraint for a DataSetType.
Definition: ForeignKey.h:48
It describes a unique key (uk) constraint.
Definition: UniqueKey.h:49
std::map< std::string, te::ws::ogc::wms::Layer > m_layerMap
Definition: Transactor.h:268
A DataSourceTransactor can be viewed as a connection to the data source for reading/writing things in...
Geometry is the root class of the geometries hierarchy, it follows OGC and ISO standards.
Definition: Geometry.h:77
A Select models a query to be used when retrieving data from a DataSource.
Definition: Select.h:65
#define TEOGCWMSDATAACCESSEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:71
A dataset is the unit of information manipulated by the data access module of TerraLib.
Definition: DataSet.h:113
It describes a primary key (pk) constraint.
Definition: PrimaryKey.h:48
Implementation of the transactor for the WMS driver.
Definition: Transactor.h:60
A Query is independent from the data source language/dialect.
Definition: Query.h:46
It describes an index associated to a DataSetType.
Definition: Index.h:52