An implementation of DataSourceTransactor class for the ST in-memory driver. More...
#include <Transactor.h>
Public Member Functions | |
void | add (const std::string &name, te::da::DataSetType *t, DataSet *d) |
It adds the DataSet and its type associated to a given name. More... | |
std::auto_ptr< te::da::DataSet > | getDataSet (const std::string &name, const te::dt::DateTime *dt, te::dt::TemporalRelation r=te::dt::DURING, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess) |
It returns a data set with observations whose phenomenon times satisfy a given temporal relation. More... | |
std::auto_ptr< te::da::DataSet > | getDataSet (const std::string &name, const te::gm::Geometry *geom, te::gm::SpatialRelation sr, const te::dt::DateTime *dt, te::dt::TemporalRelation tr=te::dt::DURING, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess) |
It returns a data set with observations whose observed geometries satisfy a given spatial relation and phenomenon times satisfy a given temporal relation. More... | |
std::auto_ptr< te::da::DataSet > | getDataSet (const std::string &name, const te::gm::Envelope *e, te::gm::SpatialRelation sr, const te::dt::DateTime *dt, te::dt::TemporalRelation tr=te::dt::DURING, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess) |
It returns a data set with observations whose observed geometries satisfy a given spatial relation and phenomenon times satisfy a given temporal relation. More... | |
DataSource * | getSTMemDataSource () const |
It returns its associated ST In-Memory DataSource. More... | |
std::auto_ptr < te::dt::DateTimePeriod > | getTemporalExtent (const std::string &name) |
It returns the temporal extent associated to a DataSet. More... | |
Transactor (DataSource *parent) | |
It constructs a Transactor. More... | |
~Transactor () | |
It constructs a Transactor. More... | |
inherited methods | |
te::da::DataSource * | getDataSource () const |
It returns the parent data source of the transactor. More... | |
void | begin () |
It starts a new transaction. More... | |
void | commit () |
It commits the transaction. More... | |
void | rollBack () |
It aborts the transaction. Any changes will be rolled-back. More... | |
bool | isInTransaction () const |
It returns true if a transaction is in progress, otherwise, it returns false. 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 > | 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 | 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... | |
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::BatchExecutor > | getBatchExecutor () |
It creates a batch command executor. More... | |
void | cancel () |
It requests that the data source stop the processing of the current command. More... | |
boost::int64_t | getLastGeneratedId () |
It returns the last id generated by an insertion command. More... | |
std::string | escape (const std::string &value) |
It escapes a string for using in commands and queries. More... | |
bool | isDataSetNameValid (const std::string &datasetName) |
It returns true if the given string is a valid dataset name. More... | |
bool | isPropertyNameValid (const std::string &propertyName) |
It checks if the given property name is valid. More... | |
std::vector< std::string > | getDataSetNames () |
It It gets the dataset names available in the data source. More... | |
std::size_t | getNumberOfDataSets () |
It retrieves the number of data sets 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... | |
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::size_t | getNumberOfProperties (const std::string &datasetName) |
It gets the number of properties of the given 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... | |
void | addProperty (const std::string &datasetName, te::dt::Property *p) |
It adds a new property to the dataset schema. More... | |
void | dropProperty (const std::string &datasetName, const std::string &name) |
It removes a property from the given 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... | |
std::auto_ptr< te::da::PrimaryKey > | getPrimaryKey (const std::string &datasetName) |
It retrieves the primary key of the dataset. More... | |
bool | primaryKeyExists (const std::string &datasetName, const std::string &name) |
It checks if a primary key exists in 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 | dropPrimaryKey (const std::string &datasetName) |
It removes the primary key constraint from the dataset schema. 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... | |
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... | |
void | addForeignKey (const std::string &datasetName, te::da::ForeignKey *fk) |
It adds a foreign key constraint to a dataset. More... | |
void | dropForeignKey (const std::string &datasetName, const std::string &fkName) |
It removes the foreign key constraint from the dataset schema. 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 | 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 | addUniqueKey (const std::string &datasetName, te::da::UniqueKey *uk) |
It adds a unique key constraint to the dataset. More... | |
void | dropUniqueKey (const std::string &datasetName, const std::string &name) |
It removes the unique key constraint from the dataset. 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... | |
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 | addCheckConstraint (const std::string &datasetName, te::da::CheckConstraint *cc) |
It adds a check constraint to the dataset. More... | |
void | dropCheckConstraint (const std::string &datasetName, const std::string &name) |
It removes the check constraint from the 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... | |
bool | indexExists (const std::string &datasetName, const std::string &name) |
It checks if an index with the given name exists in the 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 | dropIndex (const std::string &datasetName, const std::string &idxName) |
It removes the index from the dataset schema. 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... | |
bool | sequenceExists (const std::string &name) |
It checks if a sequence with the given name exists in the data source. More... | |
void | addSequence (te::da::Sequence *sequence) |
It creates a new sequence in the data source. More... | |
void | dropSequence (const std::string &name) |
It removes the sequence from the data source. 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::size_t | getNumberOfItems (const std::string &datasetName) |
It retrieves the number of items of the given dataset. More... | |
bool | hasDataSets () |
It checks if the data source has any dataset. More... | |
bool | dataSetExists (const std::string &name) |
It checks if a dataset with the given name exists in the data source. 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... | |
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 | dropDataSet (const std::string &name) |
It removes the dataset schema from the data source. More... | |
void | renameDataSet (const std::string &name, const std::string &newName) |
It renames a dataset. More... | |
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 | remove (const std::string &datasetName, const te::da::ObjectIdSet *oids=0) |
It removes all the informed items from 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... | |
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... | |
te::common::CharEncoding | getEncoding () |
It return the DataSource current encoding. More... | |
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... | |
Dataset Metadata Retrieval | |
Methods for retrieving metadata about the datasets of the data source. | |
virtual std::auto_ptr < te::da::DataSetTypeCapabilities > | getCapabilities (const std::string &name) |
It gets capabilities about a data set. More... | |
virtual void | changePropertyDefinition (const std::string &datasetName, const std::string &propName, te::dt::Property *newProp) |
Dataset Persistence Methods | |
Methods for dealing with the persistence of data in a data source. | |
virtual void | update (const std::string &datasetName, DataSet *dataset, const std::vector< std::set< int > > &properties, const std::vector< size_t > &ids) |
It updates the contents of a dataset. More... | |
Protected Member Functions | |
DataSet * | getData (const std::string &datasetName) |
It returns the DataSet associated to a given name. More... | |
te::da::DataSetType * | getType (const std::string &datasetName) |
It returns the DataSetType associated to a given name. More... | |
Private Attributes | |
DataSource * | m_ds |
The associated data source. More... | |
An implementation of DataSourceTransactor class for the ST in-memory driver.
Definition at line 49 of file Transactor.h.
te::stmem::Transactor::Transactor | ( | DataSource * | parent | ) |
It constructs a Transactor.
Definition at line 37 of file Transactor.cpp.
te::stmem::Transactor::~Transactor | ( | ) |
It constructs a Transactor.
Definition at line 42 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 534 of file Transactor.cpp.
void te::stmem::Transactor::add | ( | const std::string & | name, |
te::da::DataSetType * | t, | ||
DataSet * | d | ||
) |
|
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 375 of file Transactor.cpp.
|
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 325 of file Transactor.cpp.
|
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 400 of file Transactor.cpp.
|
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 298 of file Transactor.cpp.
References te::da::DataSetType::add().
|
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 260 of file Transactor.cpp.
|
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 426 of file Transactor.cpp.
|
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 350 of file Transactor.cpp.
|
virtual |
It starts a new transaction.
Implements te::da::DataSourceTransactor.
Definition at line 51 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 148 of file Transactor.cpp.
|
virtualinherited |
Reimplemented in te::pgis::Transactor, te::ado::Transactor, and te::ogr::Transactor.
Definition at line 94 of file DataSourceTransactor.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 370 of file Transactor.cpp.
|
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 481 of file Transactor.cpp.
|
virtual |
It commits the transaction.
After commiting or rolling back, you can start another transaction.
Implements te::da::DataSourceTransactor.
Definition at line 56 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 476 of file Transactor.cpp.
|
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 468 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 380 of file Transactor.cpp.
|
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 489 of file Transactor.cpp.
|
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 330 of file Transactor.cpp.
|
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 406 of file Transactor.cpp.
|
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 304 of file Transactor.cpp.
|
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 265 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 431 of file Transactor.cpp.
|
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 355 of file Transactor.cpp.
|
virtual |
It escapes a string for using in commands and queries.
value | Any string. |
Implements te::da::DataSourceTransactor.
Definition at line 158 of file Transactor.cpp.
|
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 126 of file Transactor.cpp.
|
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 131 of file Transactor.cpp.
|
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 320 of file Transactor.cpp.
|
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 143 of file Transactor.cpp.
|
virtualinherited |
It gets capabilities about a data set.
name | Name of the dataset. |
Reimplemented in te::ogr::Transactor.
Definition at line 85 of file DataSourceTransactor.cpp.
|
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 360 of file Transactor.cpp.
|
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 365 of file Transactor.cpp.
|
protected |
It returns the DataSet associated to a given name.
Definition at line 623 of file Transactor.cpp.
|
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 71 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 81 of file Transactor.cpp.
References te::stmem::DataSet::filter(), te::stmem::DataSet::getGeomPropIdx(), and te::dt::CompositeProperty::getPropertyPosition().
|
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 96 of file Transactor.cpp.
References te::stmem::DataSet::filter(), te::stmem::DataSet::getGeomPropIdx(), and te::dt::CompositeProperty::getPropertyPosition().
|
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 51 of file DataSourceTransactor.cpp.
References te::da::ObjectIdSet::getExpression(), and te::da::ObjectIdSet::size().
std::auto_ptr< te::da::DataSet > te::stmem::Transactor::getDataSet | ( | const std::string & | name, |
const te::dt::DateTime * | dt, | ||
te::dt::TemporalRelation | r = te::dt::DURING , |
||
te::common::TraverseType | travType = te::common::FORWARDONLY , |
||
bool | connected = false , |
||
const te::common::AccessPolicy | accessPolicy = te::common::RAccess |
||
) |
It returns a data set with observations whose phenomenon times satisfy a given temporal relation.
The possible temporal relations are: 1. AFTER;
name | The DataSet name. |
dt | A given datetime. |
r | A given temporal relation. |
travType | The traverse type associated to the returned dataset. |
connected | If the returned DataSet is connecet or not. |
Definition at line 578 of file Transactor.cpp.
References te::stmem::DataSet::filter().
std::auto_ptr< te::da::DataSet > te::stmem::Transactor::getDataSet | ( | const std::string & | name, |
const te::gm::Geometry * | geom, | ||
te::gm::SpatialRelation | sr, | ||
const te::dt::DateTime * | dt, | ||
te::dt::TemporalRelation | tr = te::dt::DURING , |
||
te::common::TraverseType | travType = te::common::FORWARDONLY , |
||
bool | connected = false , |
||
const te::common::AccessPolicy | accessPolicy = te::common::RAccess |
||
) |
It returns a data set with observations whose observed geometries satisfy a given spatial relation and phenomenon times satisfy a given temporal relation.
The possible spatial relations are: INTERSECTS The possible temporal relations are: 1. AFTER;
name | The DataSet name. |
geom | A given geometry. |
sr | A given spatial relation. |
dt | A given datetime. |
tr | A given temporal relation. |
travType | The traverse type associated to the returned dataset. |
connected | If the returned DataSet is connecet or not. |
Definition at line 587 of file Transactor.cpp.
References te::stmem::DataSet::filter().
std::auto_ptr< te::da::DataSet > te::stmem::Transactor::getDataSet | ( | const std::string & | name, |
const te::gm::Envelope * | e, | ||
te::gm::SpatialRelation | sr, | ||
const te::dt::DateTime * | dt, | ||
te::dt::TemporalRelation | tr = te::dt::DURING , |
||
te::common::TraverseType | travType = te::common::FORWARDONLY , |
||
bool | connected = false , |
||
const te::common::AccessPolicy | accessPolicy = te::common::RAccess |
||
) |
It returns a data set with observations whose observed geometries satisfy a given spatial relation and phenomenon times satisfy a given temporal relation.
The possible spatial relations are: INTERSECTS The possible temporal relations are: 1. AFTER;
name | The DataSet name. |
e | A given envelope. |
sr | A given spatial relation. |
dt | A given datetime. |
tr | A given temporal relation. |
travType | The traverse type associated to the returned dataset. |
connected | If the returned DataSet is connecet or not. |
Definition at line 597 of file Transactor.cpp.
References te::stmem::DataSet::filter().
|
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 176 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 193 of file Transactor.cpp.
References te::da::DataSetType::clone().
|
virtual |
It returns the parent data source of the transactor.
Implements te::da::DataSourceTransactor.
Definition at line 46 of file Transactor.cpp.
|
virtual |
It return the DataSource current encoding.
Implements te::da::DataSourceTransactor.
Definition at line 631 of file Transactor.cpp.
References te::common::UTF8.
|
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 436 of file Transactor.cpp.
References te::stmem::DataSet::getExtent(), te::stmem::DataSet::getGeomPropIdx(), and te::dt::CompositeProperty::getPropertyPosition().
|
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 447 of file Transactor.cpp.
References te::stmem::DataSet::getExtent(), and te::stmem::DataSet::getGeomPropIdx().
|
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 310 of file Transactor.cpp.
|
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 315 of file Transactor.cpp.
|
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 385 of file Transactor.cpp.
|
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 390 of file Transactor.cpp.
|
virtual |
It returns the last id generated by an insertion command.
Implements te::da::DataSourceTransactor.
Definition at line 153 of file Transactor.cpp.
|
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 188 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 457 of file Transactor.cpp.
References te::stmem::DataSet::size().
|
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 243 of file Transactor.cpp.
References te::dt::CompositeProperty::size().
|
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 137 of file Transactor.cpp.
|
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 277 of file Transactor.cpp.
References te::da::PrimaryKey::clone(), and te::da::DataSetType::getPrimaryKey().
|
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 199 of file Transactor.cpp.
References te::dt::Property::clone(), te::dt::CompositeProperty::getProperty(), and te::dt::CompositeProperty::size().
|
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 214 of file Transactor.cpp.
References te::dt::Property::clone(), and te::dt::CompositeProperty::getProperty().
|
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 222 of file Transactor.cpp.
References te::dt::Property::clone(), and te::dt::CompositeProperty::getProperty().
|
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 229 of file Transactor.cpp.
References te::dt::Property::getName(), te::dt::CompositeProperty::getProperty(), and te::dt::CompositeProperty::size().
|
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 411 of file Transactor.cpp.
|
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 416 of file Transactor.cpp.
te::stmem::DataSource * te::stmem::Transactor::getSTMemDataSource | ( | ) | const |
It returns its associated ST In-Memory DataSource.
Definition at line 563 of file Transactor.cpp.
std::auto_ptr< te::dt::DateTimePeriod > te::stmem::Transactor::getTemporalExtent | ( | const std::string & | name | ) |
It returns the temporal extent associated to a DataSet.
name | The DataSet name. |
Definition at line 608 of file Transactor.cpp.
References te::stmem::DataSet::getTemporalExtent().
|
protected |
It returns the DataSetType associated to a given name.
Definition at line 615 of file Transactor.cpp.
|
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 335 of file Transactor.cpp.
|
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 340 of file Transactor.cpp.
|
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 463 of file Transactor.cpp.
|
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 395 of file Transactor.cpp.
|
virtual |
It returns true if the given string is a valid dataset name.
datasetName | A dataset name whose validity will be checked. |
Reimplemented from te::da::DataSourceTransactor.
Definition at line 163 of file Transactor.cpp.
|
virtual |
It returns true if a transaction is in progress, otherwise, it returns false.
Implements te::da::DataSourceTransactor.
Definition at line 66 of file Transactor.cpp.
|
virtual |
It checks if the given property name is valid.
propertyName | A property name whose validity will be checked. |
Reimplemented from te::da::DataSourceTransactor.
Definition at line 171 of file Transactor.cpp.
|
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 557 of file Transactor.cpp.
|
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 284 of file Transactor.cpp.
References te::da::Constraint::getName(), and te::da::DataSetType::getPrimaryKey().
|
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 250 of file Transactor.cpp.
References te::dt::CompositeProperty::getProperty().
|
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 111 of file Transactor.cpp.
|
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 118 of file Transactor.cpp.
|
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 542 of file Transactor.cpp.
|
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 506 of file Transactor.cpp.
References te::dt::Property::setName().
|
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 270 of file Transactor.cpp.
|
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 61 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 421 of file Transactor.cpp.
|
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 345 of file Transactor.cpp.
|
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 547 of file Transactor.cpp.
|
virtualinherited |
It updates the contents of a dataset.
All rows are edited. The third parameter tells wich columns are edited for each row.
datasetName | Name pf the dataset. |
dataset | Dataset with editions. |
properties | Columns edited for each row. Note that the size of properties must be the same of the dataset. |
ids | List of positions of the columns that identifies rows. |
te::da::Exception | An exception can be thrown, if the dataset could not be updated. |
Reimplemented in te::pgis::Transactor, te::ado::Transactor, and te::ogr::Transactor.
Definition at line 98 of file DataSourceTransactor.cpp.
|
private |
The associated data source.
Definition at line 379 of file Transactor.h.