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/ogr2/Transactor.h
22 
23  \brief A DataSourceTransactor can be viewed as a connection to the data source for reading/writing things into it.
24 */
25 
26 #ifndef __TERRALIB_OGR_INTERNAL_TRANSACTOR_H
27 #define __TERRALIB_OGR_INTERNAL_TRANSACTOR_H
28 
29 #include "Config.h"
30 
31 #include "../dataaccess/datasource/DataSourceTransactor.h"
32 
33 #include <memory.h>
34 
35 namespace te
36 {
37  namespace da { class DataSetType;}
38 
39  namespace ogr
40  {
41  class DataSource;
42 
44  {
45  public:
46 
48 
49  ~Transactor();
50 
51  te::da::DataSource* getDataSource() const;
52 
53  void begin() override;
54 
55  void commit() override;
56 
57  void rollBack() override;
58 
59  bool isInTransaction() const override;
60 
61  std::unique_ptr<te::da::DataSet> getDataSet(const std::string& name,
63  bool connected = false,
64  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
65 
66  std::unique_ptr<te::da::DataSet> getDataSet(const std::string& name,
67  const std::string& propertyName,
68  const te::gm::Envelope* e,
71  bool connected = false,
72  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
73 
74  std::unique_ptr<te::da::DataSet> getDataSet(const std::string& name,
75  const std::string& propertyName,
76  const te::gm::Geometry* g,
79  bool connected = false,
80  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
81 
82  std::unique_ptr<te::da::DataSet> query(const te::da::Select& q,
84  bool connected = false,
85  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
86 
87  std::unique_ptr<te::da::DataSet> query(const std::string& query,
89  bool connected = false,
90  const te::common::AccessPolicy accessPolicy = te::common::RAccess);
91 
92  void execute(const te::da::Query& command);
93 
94  void execute(const std::string& command);
95 
96  std::unique_ptr<te::da::PreparedQuery> getPrepared(const std::string& qName = std::string(""));
97 
98  std::unique_ptr<te::da::BatchExecutor> getBatchExecutor();
99 
100  void cancel();
101 
102  boost::int64_t getLastGeneratedId();
103 
104  std::string escape(const std::string& value);
105 
106  std::vector<std::string> getDataSetNames();
107 
108  std::size_t getNumberOfDataSets();
109 
110  std::unique_ptr<te::da::DataSetType> getDataSetType(const std::string& name);
111 
112  std::unique_ptr<te::da::DataSetTypeCapabilities> getCapabilities(const std::string& name);
113 
114  boost::ptr_vector<te::dt::Property> getProperties(const std::string& datasetName);
115 
116  std::unique_ptr<te::dt::Property> getProperty(const std::string& datasetName, const std::string& name);
117 
118  std::unique_ptr<te::dt::Property> getProperty(const std::string& datasetName, std::size_t propertyPos);
119 
120  std::vector<std::string> getPropertyNames(const std::string& datasetName);
121 
122  std::size_t getNumberOfProperties(const std::string& datasetName);
123 
124  bool propertyExists(const std::string& datasetName, const std::string& name);
125 
126  void addProperty(const std::string& datasetName, te::dt::Property* p);
127 
128  void dropProperty(const std::string& datasetName, const std::string& name);
129 
130  void renameProperty(const std::string& datasetName,
131  const std::string& propertyName,
132  const std::string& newPropertyName);
133 
134  void changePropertyDefinition(const std::string& datasetName, const std::string& propName, te::dt::Property* newProp);
135 
136  std::unique_ptr<te::da::PrimaryKey> getPrimaryKey(const std::string& datasetName);
137 
138  bool primaryKeyExists(const std::string& datasetName, const std::string& name);
139 
140  void addPrimaryKey(const std::string& datasetName, te::da::PrimaryKey* pk);
141 
142  void dropPrimaryKey(const std::string& datasetName);
143 
144  std::unique_ptr<te::da::ForeignKey> getForeignKey(const std::string& datasetName, const std::string& name);
145 
146  std::vector<std::string> getForeignKeyNames(const std::string& datasetName);
147 
148  bool foreignKeyExists(const std::string& datasetName, const std::string& name);
149 
150  void addForeignKey(const std::string& datasetName, te::da::ForeignKey* fk);
151 
152  void dropForeignKey(const std::string& datasetName, const std::string& fkName);
153 
154  std::unique_ptr<te::da::UniqueKey> getUniqueKey(const std::string& datasetName, const std::string& name);
155 
156  std::vector<std::string> getUniqueKeyNames(const std::string& datasetName);
157 
158  bool uniqueKeyExists(const std::string& datasetName, const std::string& name);
159 
160  void addUniqueKey(const std::string& datasetName, te::da::UniqueKey* uk);
161 
162  void dropUniqueKey(const std::string& datasetName, const std::string& name);
163 
164  std::unique_ptr<te::da::CheckConstraint> getCheckConstraint(const std::string& datasetName, const std::string& name);
165 
166  std::vector<std::string> getCheckConstraintNames(const std::string& datasetName);
167 
168  bool checkConstraintExists(const std::string& datasetName, const std::string& name);
169 
170  void addCheckConstraint(const std::string& datasetName, te::da::CheckConstraint* cc);
171 
172  void dropCheckConstraint(const std::string& datasetName, const std::string& name);
173 
174  std::unique_ptr<te::da::Index> getIndex(const std::string& datasetName, const std::string& name);
175 
176  std::vector<std::string> getIndexNames(const std::string& datasetName);
177 
178  bool indexExists(const std::string& datasetName, const std::string& name);
179 
180  void addIndex(const std::string& datasetName, te::da::Index* idx,
181  const std::map<std::string, std::string>& options);
182 
183  void dropIndex(const std::string& datasetName, const std::string& idxName);
184 
185  std::unique_ptr<te::da::Sequence> getSequence(const std::string& name);
186 
187  std::vector<std::string> getSequenceNames();
188 
189  bool sequenceExists(const std::string& name);
190 
191  void addSequence(te::da::Sequence* sequence);
192 
193  void dropSequence(const std::string& name);
194 
195  std::unique_ptr<te::gm::Envelope> getExtent(const std::string& datasetName,
196  const std::string& propertyName);
197 
198  std::unique_ptr<te::gm::Envelope> getExtent(const std::string& datasetName,
199  std::size_t propertyPos);
200 
201  std::size_t getNumberOfItems(const std::string& datasetName);
202 
203  bool hasDataSets();
204 
205  bool dataSetExists(const std::string& name);
206 
207  void createDataSet(te::da::DataSetType* dt, const std::map<std::string, std::string>& options);
208 
209  void cloneDataSet(const std::string& name,
210  const std::string& cloneName,
211  const std::map<std::string, std::string>& options);
212 
213  void dropDataSet(const std::string& name);
214 
215  void renameDataSet(const std::string& name, const std::string& newName);
216 
217  void add(const std::string& datasetName,
218  te::da::DataSet* d,
219  const std::map<std::string, std::string>& options,
220  std::size_t limit = 0,
221  bool enableProgress = true);
222 
223  void remove(const std::string& datasetName, const te::da::ObjectIdSet* oids = 0);
224 
225  void update(const std::string& datasetName,
226  te::da::DataSet* dataset,
227  const std::vector<std::size_t>& properties,
228  const te::da::ObjectIdSet* oids,
229  const std::map<std::string, std::string>& options,
230  std::size_t limit = 0);
231 
232  virtual void update(const std::string& datasetName,
233  te::da::DataSet* dataset,
234  const std::vector< std::set<int> >& properties,
235  const std::vector<size_t>& ids);
236 
237 
238  void optimize(const std::map<std::string, std::string>& opInfo);
239 
240  protected:
241 
243  long int m_fid;
244  std::size_t m_transactionCount;
245  };
246  }
247 }
248 
249 #endif //__TERRALIB_OGR_INTERNAL_TRANSACTOR_H
This file contains include headers for the memory data source of TerraLib.
A class that models the description of a dataset.
Definition: DataSetType.h:72
DataSource * m_ogrDs
Definition: Transactor.h:242
#define TEOGREXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:79
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
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
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.
It models a foreign key constraint for a DataSetType.
Definition: ForeignKey.h:48
It describes a unique key (uk) constraint.
Definition: UniqueKey.h:49
A DataSourceTransactor can be viewed as a connection to the data source for reading/writing things in...
The OGR data source provider.
Definition: DataSource.h:49
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
Configuration flags for the OGR Driver Implementation of TerraLib.
A dataset is the unit of information manipulated by the data access module of TerraLib.
Definition: DataSet.h:113
std::size_t m_transactionCount
Definition: Transactor.h:244
It describes a primary key (pk) constraint.
Definition: PrimaryKey.h:48
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