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/terralib4/Transactor.h
22 
23  \brief DataSourceTransactor implementation for TerraLib 4.x API.
24 */
25 
26 #ifndef __TERRALIB_TERRALIB4_INTERNAL_DATASOURCETRANSACTOR_H
27 #define __TERRALIB_TERRALIB4_INTERNAL_DATASOURCETRANSACTOR_H
28 
29 // TerraLib
30 #include "../dataaccess/datasource/DataSourceTransactor.h"
31 #include "Config.h"
32 #include "DataSource.h"
33 
34 // STL
35 #include <memory>
36 #include <map>
37 #include <string>
38 
39 class TeView;
40 class TeAbstractTheme;
41 class TeLayer;
42 
43 namespace te
44 {
45  namespace dt { class Property; }
46  namespace gm { class Envelope; class Geometry; }
47 }
48 
49 namespace terralib4
50 {
51  class BatchExecutor;
52  class DataSet;
53  class Connection;
54  class ObjectIdSet;
55  class PreparedQuery;
56  class Query;
57  struct ThemeInfo;
58 
60  {
61  public:
62 
63  Transactor(DataSource* ds, TeDatabase* db);
64 
65  ~Transactor();
66 
67  te::da::DataSource* getDataSource() const;
68 
69  void begin();
70 
71  void commit();
72 
73  void rollBack();
74 
75  bool isInTransaction() const;
76 
77  std::auto_ptr<te::da::DataSet> getDataSet(const std::string& name,
79  bool connected = false,
80  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
81 
82  std::auto_ptr<te::da::DataSet> getDataSet(const std::string& name,
83  const std::string& propertyName,
84  const te::gm::Envelope* e,
87  bool connected = false,
88  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
89 
90  std::auto_ptr<te::da::DataSet> getDataSet(const std::string& name,
91  const std::string& propertyName,
92  const te::gm::Geometry* g,
95  bool connected = false,
96  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
97 
98  std::auto_ptr<te::da::DataSet> getDataSet(const std::string& name,
99  const ObjectIdSet* oids,
101  bool connected = false,
102  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
103 
104  std::auto_ptr<te::da::DataSet> query(const te::da::Select& q,
106  bool connected = false,
107  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
108 
109  std::auto_ptr<te::da::DataSet> query(const std::string& query,
111  bool connected = false,
112  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
113 
114  void execute(const te::da::Query& command);
115 
116  void execute(const std::string& command);
117 
118  std::auto_ptr<te::da::PreparedQuery> getPrepared(const std::string& qName = std::string(""));
119 
120  std::auto_ptr<te::da::BatchExecutor> getBatchExecutor();
121 
122  void cancel();
123 
124  boost::int64_t getLastGeneratedId();
125 
126  std::string escape(const std::string& value);
127 
128  bool isDataSetNameValid(const std::string& datasetName);
129 
130  bool isPropertyNameValid(const std::string& propertyName);
131 
132  std::vector<std::string> getDataSetNames();
133 
134  std::size_t getNumberOfDataSets();
135 
136  std::auto_ptr<te::da::DataSetType> getDataSetType(const std::string& name);
137 
138  boost::ptr_vector<te::dt::Property> getProperties(const std::string& datasetName);
139 
140  std::auto_ptr<te::dt::Property> getProperty(const std::string& datasetName, const std::string& name);
141 
142  std::auto_ptr<te::dt::Property> getProperty(const std::string& datasetName, std::size_t propertyPos);
143 
144  std::vector<std::string> getPropertyNames(const std::string& datasetName);
145 
146  std::size_t getNumberOfProperties(const std::string& datasetName);
147 
148  bool propertyExists(const std::string& datasetName, const std::string& name);
149 
150  void addProperty(const std::string& datasetName, te::dt::Property* p);
151 
152  void dropProperty(const std::string& datasetName, const std::string& name);
153 
154  void renameProperty(const std::string& datasetName,
155  const std::string& propertyName,
156  const std::string& newPropertyName);
157 
158  std::auto_ptr<te::da::PrimaryKey> getPrimaryKey(const std::string& datasetName);
159 
160  bool primaryKeyExists(const std::string& datasetName, const std::string& name);
161 
162  void addPrimaryKey(const std::string& datasetName, te::da::PrimaryKey* pk);
163 
164  void dropPrimaryKey(const std::string& datasetName);
165 
166  std::auto_ptr<te::da::ForeignKey> getForeignKey(const std::string& datasetName, const std::string& name);
167 
168  std::vector<std::string> getForeignKeyNames(const std::string& datasetName);
169 
170  bool foreignKeyExists(const std::string& datasetName, const std::string& name);
171 
172  void addForeignKey(const std::string& datasetName, te::da::ForeignKey* fk);
173 
174  void dropForeignKey(const std::string& datasetName, const std::string& fkName);
175 
176  std::auto_ptr<te::da::UniqueKey> getUniqueKey(const std::string& datasetName, const std::string& name);
177 
178  std::vector<std::string> getUniqueKeyNames(const std::string& datasetName);
179 
180  bool uniqueKeyExists(const std::string& datasetName, const std::string& name);
181 
182  void addUniqueKey(const std::string& datasetName, te::da::UniqueKey* uk);
183 
184  void dropUniqueKey(const std::string& datasetName, const std::string& name);
185 
186  std::auto_ptr<te::da::CheckConstraint> getCheckConstraint(const std::string& datasetName, const std::string& name);
187 
188  std::vector<std::string> getCheckConstraintNames(const std::string& datasetName);
189 
190  bool checkConstraintExists(const std::string& datasetName, const std::string& name);
191 
192  void addCheckConstraint(const std::string& datasetName, te::da::CheckConstraint* cc);
193 
194  void dropCheckConstraint(const std::string& datasetName, const std::string& name);
195 
196  std::auto_ptr<te::da::Index> getIndex(const std::string& datasetName, const std::string& name);
197 
198  std::vector<std::string> getIndexNames(const std::string& datasetName);
199 
200  bool indexExists(const std::string& datasetName, const std::string& name);
201 
202  void addIndex(const std::string& datasetName, te::da::Index* idx,
203  const std::map<std::string, std::string>& options);
204 
205  void dropIndex(const std::string& datasetName, const std::string& idxName);
206 
207  std::auto_ptr<te::da::Sequence> getSequence(const std::string& name);
208 
209  std::vector<std::string> getSequenceNames();
210 
211  bool sequenceExists(const std::string& name);
212 
213  void addSequence(te::da::Sequence* sequence);
214 
215  void dropSequence(const std::string& name);
216 
217  std::auto_ptr<te::gm::Envelope> getExtent(const std::string& datasetName,
218  const std::string& propertyName);
219 
220  std::auto_ptr<te::gm::Envelope> getExtent(const std::string& datasetName,
221  std::size_t propertyPos);
222 
223  std::size_t getNumberOfItems(const std::string& datasetName);
224 
225  bool hasDataSets();
226 
227  bool dataSetExists(const std::string& name);
228 
229  void createDataSet(te::da::DataSetType* dt, const std::map<std::string, std::string>& options);
230 
231  void cloneDataSet(const std::string& name,
232  const std::string& cloneName,
233  const std::map<std::string, std::string>& options);
234 
235  void dropDataSet(const std::string& name);
236 
237  void renameDataSet(const std::string& name, 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 
244  void remove(const std::string& datasetName, const te::da::ObjectIdSet* oids = 0);
245 
246  void update(const std::string& datasetName,
247  te::da::DataSet* dataset,
248  const std::vector<std::size_t>& properties,
249  const te::da::ObjectIdSet* oids,
250  const std::map<std::string, std::string>& options,
251  std::size_t limit = 0);
252 
253  void optimize(const std::map<std::string, std::string>& opInfo);
254 
255  te::common::CharEncoding getEncoding();
256 
257  std::vector<std::string> getTL4Layers();
258 
259  std::vector<std::string> getTL4Tables();
260 
261  std::vector<std::string> getTL4Rasters();
262 
263  std::vector<std::pair<std::string, std::string> > getTL4RasterFiles();
264 
265  std::vector<::terralib4::ThemeInfo> getTL4Themes();
266 
267  TeTheme* getTL4Theme(const ::terralib4::ThemeInfo& theme);
268 
269  int getLayerSRID(const std::string & layerName);
270 
271  private:
272 
274  TeDatabase* m_db;
276 
277  std::map<int, TeLayer*>& m_layerMap;
278  std::map<int, TeView*>& m_viewMap;
279  std::map<int, TeAbstractTheme*>& m_themeMap;
280 
281  };
282 
283 } // end namespace terralib4
284 
285 #endif // __TERRALIB_TERRALIB4_INTERNAL_DATASOURCETRANSACTOR_H
286 
287 
CharEncoding
Supported charsets (character encoding).
std::map< int, TeLayer * > & m_layerMap
Definition: Transactor.h:277
std::map< int, TeView * > & m_viewMap
Definition: Transactor.h:278
A class that models the description of a dataset.
Definition: DataSetType.h:72
Implements the DataSource class for the TerraLib 4.x Data Access Driver.
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:118
Configuration flags for the TerraLib 4 driver.
It models a property definition.
Definition: Property.h:59
Definition: Band.h:34
DataSource * m_ds
Definition: Transactor.h:273
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
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
URI C++ Library.
TeDatabase * m_db
Definition: Transactor.h:274
It models a foreign key constraint for a DataSetType.
Definition: ForeignKey.h:50
It describes a unique key (uk) constraint.
Definition: UniqueKey.h:53
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:73
A Select models a query to be used when retrieving data from a DataSource.
Definition: Select.h:65
A dataset is the unit of information manipulated by the data access module of TerraLib.
Definition: DataSet.h:112
#define TETERRALIB4EXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:123
It describes a primary key (pk) constraint.
Definition: PrimaryKey.h:52
std::map< int, TeAbstractTheme * > & m_themeMap
Definition: Transactor.h:279
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:54