#include <Transactor.h>
Public Member Functions | |
void | add (const std::string &datasetName, te::da::DataSet *d, const std::map< std::string, std::string > &options, std::size_t limit=0) |
It adds data items to the dataset in the data source. More... | |
void | addCheckConstraint (const std::string &datasetName, te::da::CheckConstraint *cc) |
It adds a check constraint to the dataset. More... | |
void | addForeignKey (const std::string &datasetName, te::da::ForeignKey *fk) |
It adds a foreign key constraint to a dataset. More... | |
void | addIndex (const std::string &datasetName, te::da::Index *idx, const std::map< std::string, std::string > &options) |
It adds an index to the dataset. More... | |
void | addPrimaryKey (const std::string &datasetName, te::da::PrimaryKey *pk) |
It adds a primary key constraint to the dataset schema. More... | |
void | addProperty (const std::string &datasetName, te::dt::Property *p) |
It adds a new property to the dataset schema. More... | |
void | addSequence (te::da::Sequence *sequence) |
It creates a new sequence in the data source. More... | |
void | addUniqueKey (const std::string &datasetName, te::da::UniqueKey *uk) |
It adds a unique key constraint to the dataset. More... | |
void | begin () |
It starts a new transaction. More... | |
void | cancel () |
It requests that the data source stop the processing of the current command. More... | |
bool | checkConstraintExists (const std::string &datasetName, const std::string &name) |
It checks if a check-constraint with the given name exists in the data source. More... | |
void | cloneDataSet (const std::string &name, const std::string &cloneName, const std::map< std::string, std::string > &options) |
It clones the dataset in the data source. More... | |
void | commit () |
It commits the transaction. More... | |
void | createDataSet (te::da::DataSetType *dt, const std::map< std::string, std::string > &options) |
It creates the dataset schema definition in the target data source. More... | |
bool | dataSetExists (const std::string &name) |
It checks if a dataset with the given name exists in the data source. More... | |
void | dropCheckConstraint (const std::string &datasetName, const std::string &name) |
It removes the check constraint from the dataset. More... | |
void | dropDataSet (const std::string &name) |
It removes the dataset schema from the data source. More... | |
void | dropForeignKey (const std::string &datasetName, const std::string &fkName) |
It removes the foreign key constraint from the dataset schema. More... | |
void | dropIndex (const std::string &datasetName, const std::string &idxName) |
It removes the index from the dataset schema. More... | |
void | dropPrimaryKey (const std::string &datasetName) |
It removes the primary key constraint from the dataset schema. More... | |
void | dropProperty (const std::string &datasetName, const std::string &name) |
It removes a property from the given dataset. More... | |
void | dropSequence (const std::string &name) |
It removes the sequence from the data source. More... | |
void | dropUniqueKey (const std::string &datasetName, const std::string &name) |
It removes the unique key constraint from the dataset. More... | |
std::string | escape (const std::string &value) |
It escapes a string for using in commands and queries. More... | |
void | execute (const te::da::Query &command) |
It executes the specified command using a generic query representation. More... | |
void | execute (const std::string &command) |
It executes the specifed command in the data source native language. More... | |
bool | foreignKeyExists (const std::string &datasetName, const std::string &name) |
It checks if a foreign key with the given name exists in the data source. More... | |
std::auto_ptr < te::da::BatchExecutor > | getBatchExecutor () |
It creates a batch command executor. More... | |
std::auto_ptr < te::da::CheckConstraint > | getCheckConstraint (const std::string &datasetName, const std::string &name) |
It gets the check constraint of the dataset with the given name. More... | |
std::vector< std::string > | getCheckConstraintNames (const std::string &datasetName) |
It gets the check constraint names of the given dataset. More... | |
std::auto_ptr< te::da::DataSet > | getDataSet (const std::string &name, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess) |
It gets the dataset identified by the given name. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source. More... | |
std::auto_ptr< te::da::DataSet > | getDataSet (const std::string &name, const std::string &propertyName, const te::gm::Envelope *e, te::gm::SpatialRelation r, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess) |
It gets the dataset identified by the given name using a spatial filter over the specified property. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source. More... | |
std::auto_ptr< te::da::DataSet > | getDataSet (const std::string &name, const std::string &propertyName, const te::gm::Geometry *g, te::gm::SpatialRelation r, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess) |
It gets the dataset identified by the given name using a spatial filter over the given geometric property. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source. More... | |
std::auto_ptr< te::da::DataSet > | getDataSet (const std::string &name, const ObjectIdSet *oids, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess) |
std::vector< std::string > | getDataSetNames () |
It It gets the dataset names available in the data source. More... | |
std::auto_ptr < te::da::DataSetType > | getDataSetType (const std::string &name) |
It gets information about the given dataset. More... | |
te::da::DataSource * | getDataSource () const |
It returns the parent data source of the transactor. More... | |
std::auto_ptr< te::gm::Envelope > | getExtent (const std::string &datasetName, const std::string &propertyName) |
It retrieves the bounding rectangle of the spatial property for the given dataset. More... | |
std::auto_ptr< te::gm::Envelope > | getExtent (const std::string &datasetName, std::size_t propertyPos) |
It retrieves the bounding rectangle for the spatial property lying in the given position in the dataset. More... | |
std::auto_ptr< te::da::ForeignKey > | getForeignKey (const std::string &datasetName, const std::string &name) |
It retrieves the foreign key from the given dataset. More... | |
std::vector< std::string > | getForeignKeyNames (const std::string &datasetName) |
It gets the foreign key names of the given dataset. More... | |
std::auto_ptr< te::da::Index > | getIndex (const std::string &datasetName, const std::string &name) |
It gets the index with the given name from the dataset. More... | |
std::vector< std::string > | getIndexNames (const std::string &datasetName) |
It gets the index names of the given dataset. More... | |
boost::int64_t | getLastGeneratedId () |
It returns the last id generated by an insertion command. More... | |
std::size_t | getNumberOfDataSets () |
It retrieves the number of data sets available in the data source. More... | |
std::size_t | getNumberOfItems (const std::string &datasetName) |
It retrieves the number of items of the given dataset. More... | |
std::size_t | getNumberOfProperties (const std::string &datasetName) |
It gets the number of properties of the given dataset. More... | |
std::auto_ptr < te::da::PreparedQuery > | getPrepared (const std::string &qName=std::string("")) |
It creates a prepared query object that may be used for query commands (select, insert, update and delete) that are used repeatedly. More... | |
std::auto_ptr< te::da::PrimaryKey > | getPrimaryKey (const std::string &datasetName) |
It retrieves the primary key of the dataset. More... | |
boost::ptr_vector < te::dt::Property > | getProperties (const std::string &datasetName) |
It retrieves the properties of the dataset. More... | |
std::auto_ptr< te::dt::Property > | getProperty (const std::string &datasetName, const std::string &name) |
It retrieves the property with the given name from the dataset. More... | |
std::auto_ptr< te::dt::Property > | getProperty (const std::string &datasetName, std::size_t propertyPos) |
It retrieves the property lying in the given position from the dataset. More... | |
std::vector< std::string > | getPropertyNames (const std::string &datasetName) |
It gets the property names of the given dataset. More... | |
std::auto_ptr< te::da::Sequence > | getSequence (const std::string &name) |
It gets the sequence with the given name in the data source. More... | |
std::vector< std::string > | getSequenceNames () |
It gets the sequence names available in the data source. More... | |
std::auto_ptr< te::da::UniqueKey > | getUniqueKey (const std::string &datasetName, const std::string &name) |
It gets the unique key in the dataset with the given name. More... | |
std::vector< std::string > | getUniqueKeyNames (const std::string &datasetName) |
It gets the unique key names of the given dataset. More... | |
bool | hasDataSets () |
It checks if the data source has any dataset. More... | |
bool | indexExists (const std::string &datasetName, const std::string &name) |
It checks if an index with the given name exists in the dataset. More... | |
bool | isDataSetNameValid (const std::string &datasetName) |
It returns true if the given string is a valid dataset name. More... | |
bool | isInTransaction () const |
It returns true if a transaction is in progress, otherwise, it returns false. More... | |
bool | isPropertyNameValid (const std::string &propertyName) |
It checks if the given property name is valid. More... | |
void | optimize (const std::map< std::string, std::string > &opInfo) |
For some data access drivers, this method will perform some operations to optimize the data storage. More... | |
bool | primaryKeyExists (const std::string &datasetName, const std::string &name) |
It checks if a primary key exists in the dataset. More... | |
bool | propertyExists (const std::string &datasetName, const std::string &name) |
It checks if a property with the given name exists in the dataset. More... | |
std::auto_ptr< te::da::DataSet > | query (const te::da::Select &q, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess) |
It executes a query that may return some data using a generic query. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source. This method is different of the method that accepts a dataset name and a spatial filter, because it allows the retrieving of only a subset of the attributes, since a query can include a property list. More... | |
std::auto_ptr< te::da::DataSet > | query (const std::string &query, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess) |
It executes a query that may return some data using the data source native language. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source. More... | |
void | remove (const std::string &datasetName, const te::da::ObjectIdSet *oids=0) |
It removes all the informed items from the dataset. More... | |
void | renameDataSet (const std::string &name, const std::string &newName) |
It renames a dataset. More... | |
void | renameProperty (const std::string &datasetName, const std::string &propertyName, const std::string &newPropertyName) |
It renames a property of the given dataset. More... | |
void | rollBack () |
It aborts the transaction. Any changes will be rolled-back. More... | |
bool | sequenceExists (const std::string &name) |
It checks if a sequence with the given name exists in the data source. More... | |
Transactor (DataSource *ds, TeDatabase *db) | |
bool | uniqueKeyExists (const std::string &datasetName, const std::string &name) |
It checks if a unique key with the given name exists in the dataset. More... | |
void | update (const std::string &datasetName, te::da::DataSet *dataset, const std::vector< std::size_t > &properties, const te::da::ObjectIdSet *oids, const std::map< std::string, std::string > &options, std::size_t limit=0) |
It updates the contents of a dataset for the set of data items. More... | |
~Transactor () | |
DataSet Retrieval | |
Methods for retrieving data from the data source. | |
std::auto_ptr< te::da::DataSet > | getDataSet (const std::string &name, const ObjectIdSet *oids, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess) |
It gets the dataset identified by the given name using the set of objects identification. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source. More... | |
Private Attributes | |
TeDatabase * | m_db |
DataSource * | m_ds |
bool | m_isInTransaction |
Definition at line 54 of file Transactor.h.
terralib4::Transactor::Transactor | ( | DataSource * | ds, |
TeDatabase * | db | ||
) |
Definition at line 78 of file Transactor.cpp.
terralib4::Transactor::~Transactor | ( | ) |
Definition at line 85 of file Transactor.cpp.
|
virtual |
It adds data items to the dataset in the data source.
datasetName | The target dataset name. |
d | The data items to be added to the dataset. |
options | A list of optional modifiers (driver specific). |
limit | The number of items to be used from the input dataset. If set to 0 (default), all items are used. |
Exception | An exception can be thrown, if the input dataset items could not be added to the given dataset. |
Implements te::da::DataSourceTransactor.
Definition at line 687 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It adds a check constraint to the dataset.
datasetName | The dataset where the constraint will be added. |
cc | The check constraint. |
Exception | An exception can be thrown, if the check constraint could not be added to the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 571 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It adds a foreign key constraint to a dataset.
datasetName | The dataset where the foreign key constraint will be added. |
fk | The foreign key constraint. |
Exception | An exception can be thrown, if the foreign key could not be added to the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 521 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It adds an index to the dataset.
datasetName | The dataset where the index will be added. |
idx | The index to be added. |
options | A list of optional modifiers (driver specific). |
Exception | An exception can be thrown, if the index could not be added to the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 596 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It adds a primary key constraint to the dataset schema.
datasetName | The name of the dataset where the primary key will be added. |
pk | The primary key constraint. |
Exception | An exception can be thrown, if the primary key could not be added to the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 496 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It adds a new property to the dataset schema.
datasetName | The dataset where the property will be added. |
p | The new property to be added. |
Exception | An exception can be thrown, if the property could not be added to the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 424 of file Transactor.cpp.
References terralib4::Convert2T4(), terralib4::Convert2T4GeomType(), te::dt::GEOMETRY_TYPE, te::gm::Geometry::getGeomTypeId(), te::dt::Property::getName(), te::dt::Property::getType(), and TR_TERRALIB4.
|
virtual |
It creates a new sequence in the data source.
Exception | An exception can be thrown, if the sequence could not be added to the data source. |
Implements te::da::DataSourceTransactor.
Definition at line 622 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It adds a unique key constraint to the dataset.
datasetName | The dataset where the unique key will be added. |
uk | The unique key constraint. |
Exception | An exception can be thrown, if the unique key could not be added to the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 546 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It starts a new transaction.
Implements te::da::DataSourceTransactor.
Definition at line 94 of file Transactor.cpp.
|
virtual |
It requests that the data source stop the processing of the current command.
Implements te::da::DataSourceTransactor.
Definition at line 215 of file Transactor.cpp.
|
virtual |
It checks if a check-constraint with the given name exists in the data source.
datasetName | The dataset name. |
name | The check-constraint name. |
Exception | An exception can be thrown, if the existence of the check constraint could not be determined. |
Implements te::da::DataSourceTransactor.
Definition at line 566 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It clones the dataset in the data source.
name | The dataset to be cloned. |
cloneName | The name of the cloned dataset. |
options | A list of optional modifiers. It is driver specific. |
Exception | An exception can be thrown, if the dataset schema could not be cloned. |
Implements te::da::DataSourceTransactor.
Definition at line 670 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It commits the transaction.
After commiting or rolling back, you can start another transaction.
Implements te::da::DataSourceTransactor.
Definition at line 100 of file Transactor.cpp.
|
virtual |
It creates the dataset schema definition in the target data source.
If a dataset schema with the same name already exists in the target data source, this may throw an exception.
After calling this method, the dataset schema may be updated.
dt | The dataset schema to be created. It may be changed during the operation. |
options | A list of optional modifiers (driver specific). |
Implements te::da::DataSourceTransactor.
Definition at line 665 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It checks if a dataset with the given name exists in the data source.
name | The dataset name. |
Exception | An exception can be thrown, if the existence of a dataset in the data source could not be determined. |
Implements te::da::DataSourceTransactor.
Definition at line 654 of file Transactor.cpp.
|
virtual |
It removes the check constraint from the dataset.
datasetName | The dataset from where the check constraint will be removed. |
name | The check constraint to be removed. |
Exception | An exception can be thrown, if the check constraint could not be removed from the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 576 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It removes the dataset schema from the data source.
name | The dataset name whose schema will be removed from the data source. |
Exception | An exception can be thrown, if the dataset could not be removed from the data source. |
Implements te::da::DataSourceTransactor.
Definition at line 677 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It removes the foreign key constraint from the dataset schema.
datasetName | The dataset where the foreign key will be removed. |
fkName | The foreign key to be removed. |
Exception | An exception can be thrown, if the foreign key could not be removed from the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 526 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It removes the index from the dataset schema.
datasetName | The dataset where the index will be removed. |
idxName | The index to be removed. |
Exception | An exception can be thrown, if the index could not be removed from the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 602 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It removes the primary key constraint from the dataset schema.
datasetName | The dataset from where the primary key will be removed. |
Exception | An exception can be thrown, if the primary key could not be dropped from the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 501 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It removes a property from the given dataset.
datasetName | The dataset from where the given property will be removed. |
name | The property to be removed from the dataset. |
Exception | An exception can be thrown, if the dataset property could not be removed. |
Implements te::da::DataSourceTransactor.
Definition at line 467 of file Transactor.cpp.
|
virtual |
It removes the sequence from the data source.
name | The sequence that will be removed. |
Exception | An exception can be thrown, if the sequence could not be removed from the data source. |
Implements te::da::DataSourceTransactor.
Definition at line 627 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It removes the unique key constraint from the dataset.
datasetName | The dataset from where the unique key will be removed. |
name | The unique key constraint name. |
Exception | An exception can be thrown, if the unique key could not be removed from the dataset schema. |
Implements te::da::DataSourceTransactor.
Definition at line 551 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It escapes a string for using in commands and queries.
value | Any string. |
Implements te::da::DataSourceTransactor.
Definition at line 224 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It executes the specified command using a generic query representation.
command | A query like: CREATE, DROP, ALTER, INSERT, UPDATE, DELETE. |
Exception | It can throw an exception, if the query cannot be performed. |
Implements te::da::DataSourceTransactor.
Definition at line 195 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It executes the specifed command in the data source native language.
command | A query string in the data source native language (like: CREATE, DROP, ALTER, INSERT, UPDATE, DELETE). |
Exception | It can throw an exception, if the query cannot be performed. |
Implements te::da::DataSourceTransactor.
Definition at line 200 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It checks if a foreign key with the given name exists in the data source.
datasetName | The dataset name. |
name | The foreign key name. |
Exception | An exception can be thrown, if the existence of the foreign key could not be obtained. |
Implements te::da::DataSourceTransactor.
Definition at line 516 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It creates a batch command executor.
Exception | An exception can be thrown if the batch command executor cannot be performed. |
Implements te::da::DataSourceTransactor.
Definition at line 210 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the check constraint of the dataset with the given name.
datasetName | The dataset name. |
name | The check constraint name. |
Exception | An exception can be thrown, if the check constraint could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 556 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the check constraint names of the given dataset.
datasetName | The dataset name. |
Exception | An exception can be thrown, if the check constraint names could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 561 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the dataset identified by the given name. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source.
name | The dataset name. |
accessPolicy | Access policy. |
travType | The traverse type associated to the returned dataset. |
connected | A flag to indicate if the returned dataset is connected or not. |
Exception | It can throw an exception if:
|
Implements te::da::DataSourceTransactor.
Definition at line 117 of file Transactor.cpp.
|
virtual |
It gets the dataset identified by the given name using a spatial filter over the specified property. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source.
name | The dataset name. |
propertyName | The name of the spatial property that will be used to apply the spatial filter. |
e | A rectangle to be used as a spatial filter when retrieving datasets. |
r | The spatial relation to be used during the filter. |
accessPolicy | Access policy. |
travType | The traversal type associated to the returned dataset. |
connected | A flag to indicate if the returned dataset is connected or not. |
Exception | It can throw an exception if:
|
Implements te::da::DataSourceTransactor.
Definition at line 146 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the dataset identified by the given name using a spatial filter over the given geometric property. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source.
name | The dataset name. |
propertyName | The name of the spatial property that will be used to apply the spatial filter. |
g | The geometry that will be used as a spatial filter when retrieving the dataset. |
r | The spatial relation that will be used during the filtering. |
accessPolicy | Access policy. |
travType | The traverse type associated to the returned dataset. |
connected | A flag to indicate if the returned dataset is connected or not. |
Exception | It can throw an exception if:
|
Implements te::da::DataSourceTransactor.
Definition at line 157 of file Transactor.cpp.
References TR_TERRALIB4.
std::auto_ptr< te::da::DataSet > terralib4::Transactor::getDataSet | ( | const std::string & | name, |
const ObjectIdSet * | oids, | ||
te::common::TraverseType | travType = te::common::FORWARDONLY , |
||
bool | connected = false , |
||
const te::common::AccessPolicy | accessPolicy = te::common::RAccess |
||
) |
Definition at line 168 of file Transactor.cpp.
References TR_TERRALIB4.
|
inherited |
It gets the dataset identified by the given name using the set of objects identification. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source.
name | The dataset name of the dataset. |
oids | A pointer for the set of objects. Do not pass null, nor an empty set. |
accessPolicy | Access policy. |
travType | The traverse type associated to the returned dataset. |
connected | A flag to indicate if the returned dataset is connected or not. |
Exception | It can throw an exception if:
|
Definition at line 49 of file DataSourceTransactor.cpp.
References te::da::ObjectIdSet::getExpression(), and te::da::ObjectIdSet::size().
|
virtual |
It It gets the dataset names available in the data source.
Exception | An exception can be thrown, if the dataset names could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 239 of file Transactor.cpp.
|
virtual |
It gets information about the given dataset.
This method can provide the following information about a dataset:
name | The name of the dataset we are looking information for. |
Exception | An exception can be thrown, if the information about the dataset could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 266 of file Transactor.cpp.
References te::dt::Property::clone(), terralib4::Convert2T5(), terralib4::Convert2T5GeomType(), te::dt::Property::getName(), te::dt::Property::setName(), and te::da::PrimaryKey::setProperties().
|
virtual |
It returns the parent data source of the transactor.
Implements te::da::DataSourceTransactor.
Definition at line 89 of file Transactor.cpp.
|
virtual |
It retrieves the bounding rectangle of the spatial property for the given dataset.
datasetName | The dataset name. |
propertyName | The spatial property name. |
Exception | An exception can be thrown, if the extent of the geometry property could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 632 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It retrieves the bounding rectangle for the spatial property lying in the given position in the dataset.
datasetName | The dataset name. |
propertyPos | The spatial property position. |
Exception | An exception can be thrown, if the extent of the geometry property lying in the given position could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 638 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It retrieves the foreign key from the given dataset.
datasetName | The dataset name. |
name | The foreign key name. |
Exception | An exception can be thrown, if the foreign key could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 506 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the foreign key names of the given dataset.
datasetName | The dataset name. |
Exception | An exception can be thrown, if the foreign key names could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 511 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the index with the given name from the dataset.
datasetName | The dataset name. |
name | The index name. |
Exception | An exception can be thrown, if the index could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 581 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the index names of the given dataset.
datasetName | The dataset name. |
Exception | An exception can be thrown, if the index names could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 586 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It returns the last id generated by an insertion command.
Implements te::da::DataSourceTransactor.
Definition at line 219 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It retrieves the number of data sets available in the data source.
Exception | An exception can be thrown, if the number of datasets could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 261 of file Transactor.cpp.
|
virtual |
It retrieves the number of items of the given dataset.
datasetName | The dataset name. |
Exception | An exception can be thrown, if the number of items of the dataset could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 644 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the number of properties of the given dataset.
datasetName | The dataset name. |
Exception | An exception can be thrown, if the number of dataset properties could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 405 of file Transactor.cpp.
|
virtual |
It creates a prepared query object that may be used for query commands (select, insert, update and delete) that are used repeatedly.
qName | The prepared query name. |
Exception | An exception can be thrown if the prepared query cannot be performed. |
Implements te::da::DataSourceTransactor.
Definition at line 205 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It retrieves the primary key of the dataset.
datasetName | The dataset name. |
Exception | An exception can be thrown, if the primary key could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 479 of file Transactor.cpp.
|
virtual |
It retrieves the properties of the dataset.
datasetName | The dataset name. |
Exception | An exception can be thrown, if the dataset properties could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 358 of file Transactor.cpp.
|
virtual |
It retrieves the property with the given name from the dataset.
datasetName | The dataset name. |
propertyName | The property name. |
Exception | An exception can be thrown, if the dataset property could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 372 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It retrieves the property lying in the given position from the dataset.
datasetName | The dataset name. |
propertyPos | The property position. |
Exception | An exception can be thrown, if the property lying in the given position could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 382 of file Transactor.cpp.
|
virtual |
It gets the property names of the given dataset.
datasetName | The dataset name. |
Exception | An exception can be thrown, if the property names of the dataset could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 391 of file Transactor.cpp.
|
virtual |
It gets the sequence with the given name in the data source.
name | The sequence name. |
Exception | An exception can be thrown, if the sequence could not be retrieved from the data source. |
Implements te::da::DataSourceTransactor.
Definition at line 607 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the sequence names available in the data source.
Exception | An exception can be thrown, if the sequence names could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 612 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the unique key in the dataset with the given name.
datasetName | The dataset name. |
name | The unique key name. |
Exception | An exception can be thrown, if the unique key could not be retrieved. |
Implements te::da::DataSourceTransactor.
Definition at line 531 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It gets the unique key names of the given dataset.
datasetName | The dataset name. |
Exception | An exception can be thrown, if the unique key names could not be obtained. |
Implements te::da::DataSourceTransactor.
Definition at line 536 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It checks if the data source has any dataset.
Exception | An exception can be thrown, if it is not possible to check if the data source has datasets . |
Implements te::da::DataSourceTransactor.
Definition at line 649 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It checks if an index with the given name exists in the dataset.
datasetName | The dataset name. |
name | The index name. |
Exception | An exception can be thrown, if the index existence could not be determined. |
Implements te::da::DataSourceTransactor.
Definition at line 591 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It returns true if the given string is a valid dataset name.
datasetName | A dataset name whose validity will be checked. |
Implements te::da::DataSourceTransactor.
Definition at line 229 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It returns true if a transaction is in progress, otherwise, it returns false.
Implements te::da::DataSourceTransactor.
Definition at line 112 of file Transactor.cpp.
|
virtual |
It checks if the given property name is valid.
propertyName | A property name whose validity will be checked. |
Implements te::da::DataSourceTransactor.
Definition at line 234 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
For some data access drivers, this method will perform some operations to optimize the data storage.
This is can be a typical maintenance command in database systems (like vacuum).
opInfo | Any information needed by the underlying driver in order to fine tune the optimization. |
Exception | It may throw an exception if something goes wrong. |
Implements te::da::DataSourceTransactor.
Definition at line 710 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It checks if a primary key exists in the dataset.
datasetName | The dataset name. |
name | The primary key name. |
Exception | An exception can be thrown, if the existence of the primary key could not be determined. |
Implements te::da::DataSourceTransactor.
Definition at line 486 of file Transactor.cpp.
|
virtual |
It checks if a property with the given name exists in the dataset.
datasetName | The dataset name. |
name | The property name. |
Exception | An exception can be thrown, if the existence of the dataset property could not be obtained. |
Implements te::da::DataSourceTransactor.
Definition at line 412 of file Transactor.cpp.
|
virtual |
It executes a query that may return some data using a generic query. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source. This method is different of the method that accepts a dataset name and a spatial filter, because it allows the retrieving of only a subset of the attributes, since a query can include a property list.
Exception | It can throw an exception if:
|
q | A valid query object. |
travType | The traverse type associated to the returned dataset. |
connected | A flag to indicate if the returned dataset is connected or not. |
accessPolicy | Access policy. |
Implements te::da::DataSourceTransactor.
Definition at line 179 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It executes a query that may return some data using the data source native language. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source.
query | A query string in the data source native language. |
travType | The traverse type associated to the returned dataset. |
connected | A flag to indicate if the returned dataset is connected or not. |
accessPolicy | Access policy. |
Exception | It can throw an exception if:
|
Implements te::da::DataSourceTransactor.
Definition at line 187 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It removes all the informed items from the dataset.
It removes all the data items from a dataset which are identified by a set of object identifiers. If this set is not informed, all items will be removed.
datasetName | The dataset name. |
oids | A list of object identifiers used to remove data from the datasource, or NULL for all. |
Exception | An exception can be thrown, if the data items could not be removed. |
Implements te::da::DataSourceTransactor.
Definition at line 695 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It renames a dataset.
name | The name of the dataset to be renamed. |
newName | The new dataset name. |
Exception | An exception can be thrown, if the dataset could not be renamed. |
Implements te::da::DataSourceTransactor.
Definition at line 682 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It renames a property of the given dataset.
datasetName | The dataset containig the property to be renamed. |
propertyName | The property to be renamed from the dataset. |
newPropertyName | The new property name. |
Exception | An exception can be thrown, if the dataset property could not be renamed. |
Implements te::da::DataSourceTransactor.
Definition at line 472 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It aborts the transaction. Any changes will be rolled-back.
After commiting or rolling back, you can start another transaction.
Implements te::da::DataSourceTransactor.
Definition at line 106 of file Transactor.cpp.
|
virtual |
It checks if a sequence with the given name exists in the data source.
name | The sequence name. |
Exception | An exception can be thrown, if the index existence could not be determined. |
Implements te::da::DataSourceTransactor.
Definition at line 617 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It checks if a unique key with the given name exists in the dataset.
datasetName | The dataset name. |
name | The unique key name. |
Exception | An exception can be thrown, if the existence of the unique key could not be determined. |
Implements te::da::DataSourceTransactor.
Definition at line 541 of file Transactor.cpp.
References TR_TERRALIB4.
|
virtual |
It updates the contents of a dataset for the set of data items.
datasetName | The target dataset name. |
dataset | The list of data items to be updated. |
properties | The list of properties of the dataset to be updated. |
oids | The list of objects to be updated. |
options | A list of optional modifiers. It is driver specific. |
limit | The number of items to be used from the input dataset. If set to 0 (default) all items are used. |
Exception | An exception can be thrown, if the dataset could not be updated. |
Implements te::da::DataSourceTransactor.
Definition at line 700 of file Transactor.cpp.
References TR_TERRALIB4.
|
private |
Definition at line 253 of file Transactor.h.
|
private |
Definition at line 252 of file Transactor.h.
|
private |
Definition at line 254 of file Transactor.h.