A DataSourceTransactor can be viewed as a connection to the data source for reading/writing things into it. More...

#include <DataSourceTransactor.h>

Inheritance diagram for te::da::DataSourceTransactor:

Public Member Functions
	DataSourceTransactor ()
	Default constructor that can be called by subclasses. More...

virtual DataSource *	getDataSource () const =0
	It returns the parent data source of the transactor. More...

virtual	~DataSourceTransactor ()
	Virtual destructor. More...

Transaction
Methods for dealing with transactions.
virtual void	begin ()=0
	It starts a new transaction. More...

virtual void	commit ()=0
	It commits the transaction. More...

virtual void	rollBack ()=0
	It aborts the transaction. Any changes will be rolled-back. More...

virtual bool	isInTransaction () const =0
	It returns true if a transaction is in progress, otherwise, it returns false. More...

DataSet Retrieval
Methods for retrieving data from the data source.
virtual std::auto_ptr< DataSet >	getDataSet (const std::string &name, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess)=0
	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...

virtual std::auto_ptr< 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)=0
	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...

virtual std::auto_ptr< 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)=0
	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)
	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...

virtual std::auto_ptr< DataSet >	query (const Select &q, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess)=0
	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...

virtual std::auto_ptr< DataSet >	query (const std::string &query, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess)=0
	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...

Command Execution Methods
Methods for executing commands against the data source.
virtual void	execute (const Query &command)=0
	It executes the specified command using a generic query representation. More...

virtual void	execute (const std::string &command)=0
	It executes the specifed command in the data source native language. More...

Fine Grained Transactor Objects
Methods for retrieving fine-grained transactor objects.
virtual std::auto_ptr< PreparedQuery >	getPrepared (const std::string &qName=std::string(""))=0
	It creates a prepared query object that may be used for query commands (select, insert, update and delete) that are used repeatedly. More...

virtual std::auto_ptr< BatchExecutor >	getBatchExecutor ()=0
	It creates a batch command executor. More...

Auxiliary Commands for Commands and Queries
Auxiliary methods for commands and queries.
virtual void	cancel ()=0
	It requests that the data source stop the processing of the current command. More...

virtual boost::int64_t	getLastGeneratedId ()=0
	It returns the last id generated by an insertion command. More...

virtual std::string	escape (const std::string &value)=0
	It escapes a string for using in commands and queries. More...

virtual bool	isDataSetNameValid (const std::string &datasetName)
	It returns true if the given string is a valid dataset name. More...

virtual bool	isPropertyNameValid (const std::string &propertyName)
	It checks if the given property name is valid. More...

Dataset Metadata Retrieval
Methods for retrieving metadata about the datasets of the data source.
virtual std::vector< std::string >	getDataSetNames ()=0
	It It gets the dataset names available in the data source. More...

virtual std::size_t	getNumberOfDataSets ()=0
	It retrieves the number of data sets available in the data source. More...

virtual std::auto_ptr< te::da::DataSetType >	getDataSetType (const std::string &name)=0
	It gets information about the given dataset. More...

virtual std::auto_ptr< te::da::DataSetTypeCapabilities >	getCapabilities (const std::string &name)
	It gets capabilities about a data set. More...

virtual boost::ptr_vector< te::dt::Property >	getProperties (const std::string &datasetName)=0
	It retrieves the properties of the dataset. More...

virtual std::auto_ptr< te::dt::Property >	getProperty (const std::string &datasetName, const std::string &name)=0
	It retrieves the property with the given name from the dataset. More...

virtual std::auto_ptr< te::dt::Property >	getProperty (const std::string &datasetName, std::size_t propertyPos)=0
	It retrieves the property lying in the given position from the dataset. More...

virtual std::vector< std::string >	getPropertyNames (const std::string &datasetName)=0
	It gets the property names of the given dataset. More...

virtual std::size_t	getNumberOfProperties (const std::string &datasetName)=0
	It gets the number of properties of the given dataset. More...

virtual bool	propertyExists (const std::string &datasetName, const std::string &name)=0
	It checks if a property with the given name exists in the dataset. More...

virtual void	addProperty (const std::string &datasetName, te::dt::Property *p)=0
	It adds a new property to the dataset schema. More...

virtual void	dropProperty (const std::string &datasetName, const std::string &name)=0
	It removes a property from the given dataset. More...

virtual void	renameProperty (const std::string &datasetName, const std::string &propertyName, const std::string &newPropertyName)=0
	It renames a property of the given dataset. More...

virtual void	changePropertyDefinition (const std::string &datasetName, const std::string &propName, te::dt::Property *newProp)

virtual std::auto_ptr< te::da::PrimaryKey >	getPrimaryKey (const std::string &datasetName)=0
	It retrieves the primary key of the dataset. More...

virtual bool	primaryKeyExists (const std::string &datasetName, const std::string &name)=0
	It checks if a primary key exists in the dataset. More...

virtual void	addPrimaryKey (const std::string &datasetName, PrimaryKey *pk)=0
	It adds a primary key constraint to the dataset schema. More...

virtual void	dropPrimaryKey (const std::string &datasetName)=0
	It removes the primary key constraint from the dataset schema. More...

virtual std::auto_ptr< ForeignKey >	getForeignKey (const std::string &datasetName, const std::string &name)=0
	It retrieves the foreign key from the given dataset. More...

virtual std::vector< std::string >	getForeignKeyNames (const std::string &datasetName)=0
	It gets the foreign key names of the given dataset. More...

virtual bool	foreignKeyExists (const std::string &datasetName, const std::string &name)=0
	It checks if a foreign key with the given name exists in the data source. More...

virtual void	addForeignKey (const std::string &datasetName, ForeignKey *fk)=0
	It adds a foreign key constraint to a dataset. More...

virtual void	dropForeignKey (const std::string &datasetName, const std::string &fkName)=0
	It removes the foreign key constraint from the dataset schema. More...

virtual std::auto_ptr< te::da::UniqueKey >	getUniqueKey (const std::string &datasetName, const std::string &name)=0
	It gets the unique key in the dataset with the given name. More...

virtual std::vector< std::string >	getUniqueKeyNames (const std::string &datasetName)=0
	It gets the unique key names of the given dataset. More...

virtual bool	uniqueKeyExists (const std::string &datasetName, const std::string &name)=0
	It checks if a unique key with the given name exists in the dataset. More...

virtual void	addUniqueKey (const std::string &datasetName, UniqueKey *uk)=0
	It adds a unique key constraint to the dataset. More...

virtual void	dropUniqueKey (const std::string &datasetName, const std::string &name)=0
	It removes the unique key constraint from the dataset. More...

virtual std::auto_ptr< te::da::CheckConstraint >	getCheckConstraint (const std::string &datasetName, const std::string &name)=0
	It gets the check constraint of the dataset with the given name. More...

virtual std::vector< std::string >	getCheckConstraintNames (const std::string &datasetName)=0
	It gets the check constraint names of the given dataset. More...

virtual bool	checkConstraintExists (const std::string &datasetName, const std::string &name)=0
	It checks if a check-constraint with the given name exists in the data source. More...

virtual void	addCheckConstraint (const std::string &datasetName, CheckConstraint *cc)=0
	It adds a check constraint to the dataset. More...

virtual void	dropCheckConstraint (const std::string &datasetName, const std::string &name)=0
	It removes the check constraint from the dataset. More...

virtual std::auto_ptr< te::da::Index >	getIndex (const std::string &datasetName, const std::string &name)=0
	It gets the index with the given name from the dataset. More...

virtual std::vector< std::string >	getIndexNames (const std::string &datasetName)=0
	It gets the index names of the given dataset. More...

virtual bool	indexExists (const std::string &datasetName, const std::string &name)=0
	It checks if an index with the given name exists in the dataset. More...

virtual void	addIndex (const std::string &datasetName, Index *idx, const std::map< std::string, std::string > &options)=0
	It adds an index to the dataset. More...

virtual void	dropIndex (const std::string &datasetName, const std::string &idxName)=0
	It removes the index from the dataset schema. More...

virtual std::auto_ptr< Sequence >	getSequence (const std::string &name)=0
	It gets the sequence with the given name in the data source. More...

virtual std::vector< std::string >	getSequenceNames ()=0
	It gets the sequence names available in the data source. More...

virtual bool	sequenceExists (const std::string &name)=0
	It checks if a sequence with the given name exists in the data source. More...

virtual void	addSequence (Sequence *sequence)=0
	It creates a new sequence in the data source. More...

virtual void	dropSequence (const std::string &name)=0
	It removes the sequence from the data source. More...

virtual std::auto_ptr< te::gm::Envelope >	getExtent (const std::string &datasetName, const std::string &propertyName)=0
	It retrieves the bounding rectangle of the spatial property for the given dataset. More...

virtual std::auto_ptr< te::gm::Envelope >	getExtent (const std::string &datasetName, std::size_t propertyPos)=0
	It retrieves the bounding rectangle for the spatial property lying in the given position in the dataset. More...

virtual std::size_t	getNumberOfItems (const std::string &datasetName)=0
	It retrieves the number of items of the given dataset. More...

virtual bool	hasDataSets ()=0
	It checks if the data source has any dataset. More...

virtual bool	dataSetExists (const std::string &name)=0
	It checks if a dataset with the given name exists in the data source. More...

Dataset Schema Persistence Methods
Methods for dealing with datasource and dataset schema changes.
virtual void	createDataSet (DataSetType *dt, const std::map< std::string, std::string > &options)=0
	It creates the dataset schema definition in the target data source. More...

virtual void	cloneDataSet (const std::string &name, const std::string &cloneName, const std::map< std::string, std::string > &options)=0
	It clones the dataset in the data source. More...

virtual void	dropDataSet (const std::string &name)=0
	It removes the dataset schema from the data source. More...

virtual void	renameDataSet (const std::string &name, const std::string &newName)=0
	It renames a dataset. More...

Dataset Persistence Methods
Methods for dealing with the persistence of data in a data source.
virtual void	add (const std::string &datasetName, DataSet *d, const std::map< std::string, std::string > &options, std::size_t limit=0)=0
	It adds data items to the dataset in the data source. More...

virtual void	remove (const std::string &datasetName, const ObjectIdSet *oids=0)=0
	It removes all the informed items from the dataset. More...

virtual void	update (const std::string &datasetName, DataSet dataset, const std::vector< std::size_t > &properties, const ObjectIdSet oids, const std::map< std::string, std::string > &options, std::size_t limit=0)=0
	It updates the contents of a dataset for the set of data items. More...

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...

virtual void	optimize (const std::map< std::string, std::string > &opInfo)=0
	For some data access drivers, this method will perform some operations to optimize the data storage. More...

Detailed Description

A DataSourceTransactor can be viewed as a connection to the data source for reading/writing things into it.

A transactor can be used to create a transaction, a prepared query or a batch command executor.

If you are planning a multi-thread application, it is better not to share the same transactor between threads because its methods are not thread-safe. Instead, use one transactor per thread.

See also: DataSource, DataSet, Query, PreparedQuery, BatchExecutor

Definition at line 88 of file DataSourceTransactor.h.

Constructor & Destructor Documentation

te::da::DataSourceTransactor::DataSourceTransactor ( )

Default constructor that can be called by subclasses.

virtual te::da::DataSourceTransactor::~DataSourceTransactor ( )

virtual

Virtual destructor.

Member Function Documentation

virtual void te::da::DataSourceTransactor::add	(	const std::string &	datasetName,
		DataSet *	d,
		const std::map< std::string, std::string > &	options,
		std::size_t	limit = `0`
	)

pure virtual

It adds data items to the dataset in the data source.

Parameters

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.

Exceptions

Exception An exception can be thrown, if the input dataset items could not be added to the given dataset.

Note: The dataset reading will start in the current position. So, keep in mind that it is the caller responsability to inform the right position(and a valid one) in the dataset 'd', to start the inserting process.; Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual void te::da::DataSourceTransactor::addCheckConstraint	(	const std::string &	datasetName,
		CheckConstraint *	cc
	)

pure virtual

It adds a check constraint to the dataset.

Parameters

datasetName	The dataset where the constraint will be added.
cc	The check constraint.

Exceptions

Exception An exception can be thrown, if the check constraint could not be added to the dataset schema.

Note: Don't delete the given check constraint, because the schema will take the ownership of it.; Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::addForeignKey	(	const std::string &	datasetName,
		ForeignKey *	fk
	)

pure virtual

It adds a foreign key constraint to a dataset.

Parameters

datasetName	The dataset where the foreign key constraint will be added.
fk	The foreign key constraint.

Exceptions

Exception An exception can be thrown, if the foreign key could not be added to the dataset schema.

Note: Don't delete the given foreign key, because the schema will take the ownership of it.; Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::addIndex	(	const std::string &	datasetName,
		Index *	idx,
		const std::map< std::string, std::string > &	options
	)

pure virtual

It adds an index to the dataset.

Parameters

datasetName	The dataset where the index will be added.
idx	The index to be added.
options	A list of optional modifiers (driver specific).

Exceptions

Exception An exception can be thrown, if the index could not be added to the dataset schema.

Note: Don't delete the given index, because the schema will take the ownership of it.; Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::addPrimaryKey	(	const std::string &	datasetName,
		PrimaryKey *	pk
	)

pure virtual

It adds a primary key constraint to the dataset schema.

Parameters

datasetName	The name of the dataset where the primary key will be added.
pk	The primary key constraint.

Exceptions

Exception An exception can be thrown, if the primary key could not be added to the dataset schema.

Note: Don't delete the given primary key, because the schema will take the ownership of it.; Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::addProperty	(	const std::string &	datasetName,
		te::dt::Property *	p
	)

pure virtual

It adds a new property to the dataset schema.

Parameters

datasetName	The dataset where the property will be added.
p	The new property to be added.

Exceptions

Exception An exception can be thrown, if the property could not be added to the dataset schema.

Note: Don't delete the given property, because the schema will take the ownership of it.; Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual void te::da::DataSourceTransactor::addSequence ( Sequence * sequence )

pure virtual

It creates a new sequence in the data source.

Exceptions

Exception An exception can be thrown, if the sequence could not be added to the data source.

Note: Don't delete the given sequence, because the schema will take the ownership of it.; Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::addUniqueKey	(	const std::string &	datasetName,
		UniqueKey *	uk
	)

pure virtual

It adds a unique key constraint to the dataset.

Parameters

datasetName	The dataset where the unique key will be added.
uk	The unique key constraint.

Exceptions

Exception An exception can be thrown, if the unique key could not be added to the dataset schema.

Note: Don't delete the given unique key, because the schema will take the ownership of it.; Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::begin ( )

pure virtual

It starts a new transaction.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::stmem::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::cancel ( )

pure virtual

It requests that the data source stop the processing of the current command.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::changePropertyDefinition	(	const std::string &	datasetName,
		const std::string &	propName,
		te::dt::Property *	newProp
	)

virtual

Reimplemented in te::pgis::Transactor, te::ado::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual bool te::da::DataSourceTransactor::checkConstraintExists	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It checks if a check-constraint with the given name exists in the data source.

Parameters

datasetName	The dataset name.
name	The check-constraint name.

Exceptions

Exception An exception can be thrown, if the existence of the check constraint could not be determined.

Returns: True, if the check-constraint exists in the dataset; otherwise, it returns false.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::cloneDataSet	(	const std::string &	name,
		const std::string &	cloneName,
		const std::map< std::string, std::string > &	options
	)

pure virtual

It clones the dataset in the data source.

Parameters

name	The dataset to be cloned.
cloneName	The name of the cloned dataset.
options	A list of optional modifiers. It is driver specific.

Exceptions

Exception An exception can be thrown, if the dataset schema could not be cloned.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual void te::da::DataSourceTransactor::commit ( )

pure virtual

It commits the transaction.

After commiting or rolling back, you can start another transaction.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::stmem::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::createDataSet	(	DataSetType *	dt,
		const std::map< std::string, std::string > &	options
	)

pure 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.

Parameters

dt	The dataset schema to be created. It may be changed during the operation.
options	A list of optional modifiers (driver specific).

Precondition: The schema of a related dataset in a foreign key must be already in the data source.

Postcondition: In some data sources, this method may output implicit indexes, sequences or constraints. The method, if necessary, will create and adjust the dataset schema.; The caller of this method will take the ownership of the given schema.

Note: If you want to create a new schema based on an already existing one, you must create a fresh copy of the DataSetType with the clone() method.; Not thread-safe!

Implemented in te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual bool te::da::DataSourceTransactor::dataSetExists ( const std::string & name )

pure virtual

It checks if a dataset with the given name exists in the data source.

Parameters

name	The dataset name.

Exceptions

Exception An exception can be thrown, if the existence of a dataset in the data source could not be determined.

Returns: True, if the dataset exists in the data source; otherwise, it returns false.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual void te::da::DataSourceTransactor::dropCheckConstraint	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It removes the check constraint from the dataset.

Parameters

datasetName	The dataset from where the check constraint will be removed.
name	The check constraint to be removed.

Exceptions

Exception An exception can be thrown, if the check constraint could not be removed from the dataset schema.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::dropDataSet ( const std::string & name )

pure virtual

It removes the dataset schema from the data source.

Parameters

name	The dataset name whose schema will be removed from the data source.

Exceptions

Exception An exception can be thrown, if the dataset could not be removed from the data source.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual void te::da::DataSourceTransactor::dropForeignKey	(	const std::string &	datasetName,
		const std::string &	fkName
	)

pure virtual

It removes the foreign key constraint from the dataset schema.

Parameters

datasetName	The dataset where the foreign key will be removed.
fkName	The foreign key to be removed.

Exceptions

Exception An exception can be thrown, if the foreign key could not be removed from the dataset schema.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::dropIndex	(	const std::string &	datasetName,
		const std::string &	idxName
	)

pure virtual

It removes the index from the dataset schema.

Parameters

datasetName	The dataset where the index will be removed.
idxName	The index to be removed.

Exceptions

Exception An exception can be thrown, if the index could not be removed from the dataset schema.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::dropPrimaryKey ( const std::string & datasetName )

pure virtual

It removes the primary key constraint from the dataset schema.

Parameters

datasetName The dataset from where the primary key will be removed.

Exceptions

Exception An exception can be thrown, if the primary key could not be dropped from the dataset schema.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::dropProperty	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It removes a property from the given dataset.

Parameters

datasetName	The dataset from where the given property will be removed.
name	The property to be removed from the dataset.

Exceptions

Exception An exception can be thrown, if the dataset property could not be removed.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual void te::da::DataSourceTransactor::dropSequence ( const std::string & name )

pure virtual

It removes the sequence from the data source.

Parameters

name	The sequence that will be removed.

Exceptions

Exception An exception can be thrown, if the sequence could not be removed from the data source.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::dropUniqueKey	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It removes the unique key constraint from the dataset.

Parameters

datasetName	The dataset from where the unique key will be removed.
name	The unique key constraint name.

Exceptions

Exception An exception can be thrown, if the unique key could not be removed from the dataset schema.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::string te::da::DataSourceTransactor::escape ( const std::string & value )

pure virtual

It escapes a string for using in commands and queries.

Parameters

value Any string.

Returns: A valid escaped string.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::execute ( const Query & command )

pure virtual

It executes the specified command using a generic query representation.

Parameters

command A query like: CREATE, DROP, ALTER, INSERT, UPDATE, DELETE.

Exceptions

Exception It can throw an exception, if the query cannot be performed.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::execute ( const std::string & command )

pure virtual

It executes the specifed command in the data source native language.

Parameters

command A query string in the data source native language (like: CREATE, DROP, ALTER, INSERT, UPDATE, DELETE).

Exceptions

Exception It can throw an exception, if the query cannot be performed.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual bool te::da::DataSourceTransactor::foreignKeyExists	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It checks if a foreign key with the given name exists in the data source.

Parameters

datasetName	The dataset name.
name	The foreign key name.

Exceptions

Exception An exception can be thrown, if the existence of the foreign key could not be obtained.

Returns: True, if the foreign key exists in the dataset; otherwise, it returns false.

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<BatchExecutor> te::da::DataSourceTransactor::getBatchExecutor ( )

pure virtual

It creates a batch command executor.

Exceptions

Exception An exception can be thrown if the batch command executor cannot be performed.

Returns: A batch command executor owned by the caller.

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<te::da::DataSetTypeCapabilities> te::da::DataSourceTransactor::getCapabilities ( const std::string & name )

virtual

It gets capabilities about a data set.

Parameters

name	Name of the dataset.

Returns: The capabilities of the data set.

Note: By default it returns a fully support capabilities. If a driver does not support any capabilty, it may reimplement this function.

Reimplemented in te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<te::da::CheckConstraint> te::da::DataSourceTransactor::getCheckConstraint	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It gets the check constraint of the dataset with the given name.

Parameters

datasetName	The dataset name.
name	The check constraint name.

Exceptions

Exception An exception can be thrown, if the check constraint could not be retrieved.

Returns: The check constraint with the given name.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::vector<std::string> te::da::DataSourceTransactor::getCheckConstraintNames ( const std::string & datasetName )

pure virtual

It gets the check constraint names of the given dataset.

Parameters

datasetName The dataset name.

Exceptions

Exception An exception can be thrown, if the check constraint names could not be retrieved.

Returns: The check constraint names of the dataset.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<DataSet> te::da::DataSourceTransactor::getDataSet	(	const std::string &	name,
		te::common::TraverseType	travType = `te::common::FORWARDONLY`,
		bool	connected = `false`,
		const te::common::AccessPolicy	accessPolicy = `te::common::RAccess`
	)

pure 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.

Parameters

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.

Exceptions

Exception

It can throw an exception if:

something goes wrong during the data retrieval
if the data source driver doesn't support the traversal type

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::stmem::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<DataSet> te::da::DataSourceTransactor::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`
	)

pure 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.

Parameters

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.

Exceptions

Exception

It can throw an exception if:

something goes wrong during the data retrieval
if the data source driver doesn't support the traversal type

Note: The envelope coordinates should be in the same coordinate system as the dataset.; Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::stmem::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<DataSet> te::da::DataSourceTransactor::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`
	)

pure 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.

Parameters

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.

Exceptions

Exception

It can throw an exception if:

something goes wrong during the data retrieval
if the data source driver doesn't support the traversal type

Note: The geometry coordinates should be in the same coordinate system as the dataset.; Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::stmem::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

std::auto_ptr<te::da::DataSet> te::da::DataSourceTransactor::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.

Parameters

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.

Exceptions

Exception

It can throw an exception if:

something goes wrong during data retrieval
if the data source driver doesn't support the traversal type

virtual std::vector<std::string> te::da::DataSourceTransactor::getDataSetNames ( )

pure virtual

It It gets the dataset names available in the data source.

Returns: The dataset names available in the data source.

Exceptions

Exception An exception can be thrown, if the dataset names could not be retrieved.

Note: Each dataset in the data source must have a unique name. For example, in a DBMS the name may contain the schema name before the table name separated by a dot notation (".").; Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::ado::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::auto_ptr<te::da::DataSetType> te::da::DataSourceTransactor::getDataSetType ( const std::string & name )

pure virtual

It gets information about the given dataset.

This method can provide the following information about a dataset:

the list of properties, including: name, data type, size, if the value is required or not, if it is an autoincrement
primary key
foreign keys
unique keys
check constraints
indexes

Parameters

name	The name of the dataset we are looking information for.

Exceptions

Exception An exception can be thrown, if the information about the dataset could not be retrieved.

Returns: The dataset schema.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::ado::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual DataSource* te::da::DataSourceTransactor::getDataSource ( ) const

pure virtual

It returns the parent data source of the transactor.

Implemented in te::pgis::Transactor, te::gdal::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::stmem::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<te::gm::Envelope> te::da::DataSourceTransactor::getExtent	(	const std::string &	datasetName,
		const std::string &	propertyName
	)

pure virtual

It retrieves the bounding rectangle of the spatial property for the given dataset.

Parameters

datasetName	The dataset name.
propertyName	The spatial property name.

Exceptions

Exception An exception can be thrown, if the extent of the geometry property could not be retrieved.

Returns: The spatial property bounding rectangle, or NULL, if none can be retrieved.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::auto_ptr<te::gm::Envelope> te::da::DataSourceTransactor::getExtent	(	const std::string &	datasetName,
		std::size_t	propertyPos
	)

pure virtual

It retrieves the bounding rectangle for the spatial property lying in the given position in the dataset.

Parameters

datasetName	The dataset name.
propertyPos	The spatial property position.

Exceptions

Exception An exception can be thrown, if the extent of the geometry property lying in the given position could not be retrieved.

Returns: The spatial property bounding rectangle, or NULL if none can be retrieved.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::auto_ptr<ForeignKey> te::da::DataSourceTransactor::getForeignKey	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It retrieves the foreign key from the given dataset.

Parameters

datasetName	The dataset name.
name	The foreign key name.

Exceptions

Exception An exception can be thrown, if the foreign key could not be retrieved.

Returns: If the foreign key exists in the dataset, it is returned; otherwise, a NULL is returned.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::vector<std::string> te::da::DataSourceTransactor::getForeignKeyNames ( const std::string & datasetName )

pure virtual

It gets the foreign key names of the given dataset.

Parameters

datasetName The dataset name.

Exceptions

Exception An exception can be thrown, if the foreign key names could not be retrieved.

Returns: The foreign key names of the given dataset.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<te::da::Index> te::da::DataSourceTransactor::getIndex	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It gets the index with the given name from the dataset.

Parameters

datasetName	The dataset name.
name	The index name.

Exceptions

Exception An exception can be thrown, if the index could not be retrieved.

Returns: The index with the given name.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::vector<std::string> te::da::DataSourceTransactor::getIndexNames ( const std::string & datasetName )

pure virtual

It gets the index names of the given dataset.

Parameters

datasetName The dataset name.

Exceptions

Exception An exception can be thrown, if the index names could not be retrieved.

Returns: The index names of the given dataset.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual boost::int64_t te::da::DataSourceTransactor::getLastGeneratedId ( )

pure virtual

It returns the last id generated by an insertion command.

Returns: The last id generated by an insertion command.

Note: This is the way to deal with auto-increment values.; Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::size_t te::da::DataSourceTransactor::getNumberOfDataSets ( )

pure virtual

It retrieves the number of data sets available in the data source.

Exceptions

Exception An exception can be thrown, if the number of datasets could not be retrieved.

Returns: The number of data sets available in the data source.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::ado::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::size_t te::da::DataSourceTransactor::getNumberOfItems ( const std::string & datasetName )

pure virtual

It retrieves the number of items of the given dataset.

Parameters

datasetName The dataset name.

Exceptions

Exception An exception can be thrown, if the number of items of the dataset could not be retrieved.

Returns: The number of items of the given dataset.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::size_t te::da::DataSourceTransactor::getNumberOfProperties ( const std::string & datasetName )

pure virtual

It gets the number of properties of the given dataset.

Parameters

datasetName The dataset name.

Exceptions

Exception An exception can be thrown, if the number of dataset properties could not be retrieved.

Returns: The number of properties of the given dataset.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::ado::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::auto_ptr<PreparedQuery> te::da::DataSourceTransactor::getPrepared ( const std::string & qName = std::string("") )

pure virtual

It creates a prepared query object that may be used for query commands (select, insert, update and delete) that are used repeatedly.

Parameters

qName The prepared query name.

Exceptions

Exception An exception can be thrown if the prepared query cannot be performed.

Returns: A prepared query object owned by the caller.

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<te::da::PrimaryKey> te::da::DataSourceTransactor::getPrimaryKey ( const std::string & datasetName )

pure virtual

It retrieves the primary key of the dataset.

Parameters

datasetName The dataset name.

Exceptions

Exception An exception can be thrown, if the primary key could not be retrieved.

Returns: If a primary key exists in the dataset, it is returned; otherwise, a NULL is returned.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual boost::ptr_vector<te::dt::Property> te::da::DataSourceTransactor::getProperties ( const std::string & datasetName )

pure virtual

It retrieves the properties of the dataset.

Parameters

datasetName The dataset name.

Exceptions

Exception An exception can be thrown, if the dataset properties could not be retrieved.

Returns: The properties of the dataset.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::ado::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::auto_ptr<te::dt::Property> te::da::DataSourceTransactor::getProperty	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It retrieves the property with the given name from the dataset.

Parameters

datasetName	The dataset name.
propertyName	The property name.

Exceptions

Exception An exception can be thrown, if the dataset property could not be retrieved.

Returns: The property with the given name from the dataset.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::ado::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::auto_ptr<te::dt::Property> te::da::DataSourceTransactor::getProperty	(	const std::string &	datasetName,
		std::size_t	propertyPos
	)

pure virtual

It retrieves the property lying in the given position from the dataset.

Parameters

datasetName	The dataset name.
propertyPos	The property position.

Exceptions

Exception An exception can be thrown, if the property lying in the given position could not be retrieved.

Returns: The property in the given position.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::ado::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::vector<std::string> te::da::DataSourceTransactor::getPropertyNames ( const std::string & datasetName )

pure virtual

It gets the property names of the given dataset.

Parameters

datasetName The dataset name.

Exceptions

Exception An exception can be thrown, if the property names of the dataset could not be retrieved.

Returns: The property names of the dataset.

Note: Each dataset in the data source must have a unique name. For example, in a DBMS the name may contain the schema name before the table name separated by a dot notation (".").; Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::ado::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::auto_ptr<Sequence> te::da::DataSourceTransactor::getSequence ( const std::string & name )

pure virtual

It gets the sequence with the given name in the data source.

Parameters

name	The sequence name.

Exceptions

Exception An exception can be thrown, if the sequence could not be retrieved from the data source.

Returns: The sequence with the given name.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::vector<std::string> te::da::DataSourceTransactor::getSequenceNames ( )

pure virtual

It gets the sequence names available in the data source.

Note: Each sequence in the data source must have a unique name. For example, in a DBMS the name may contain the schema name before the sequence name separated by a dot notation (".").

Exceptions

Exception An exception can be thrown, if the sequence names could not be retrieved.

Returns: The sequence names of the data source.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<te::da::UniqueKey> te::da::DataSourceTransactor::getUniqueKey	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It gets the unique key in the dataset with the given name.

Parameters

datasetName	The dataset name.
name	The unique key name.

Exceptions

Exception An exception can be thrown, if the unique key could not be retrieved.

Returns: The unique key with the given name in the dataset.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::vector<std::string> te::da::DataSourceTransactor::getUniqueKeyNames ( const std::string & datasetName )

pure virtual

It gets the unique key names of the given dataset.

Parameters

datasetName The dataset name.

Exceptions

Exception An exception can be thrown, if the unique key names could not be obtained.

Returns: The unique key names of the dataset.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual bool te::da::DataSourceTransactor::hasDataSets ( )

pure virtual

It checks if the data source has any dataset.

Exceptions

Exception An exception can be thrown, if it is not possible to check if the data source has datasets .

Returns: True, if the data source has datasets; otherwise, it returns false.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual bool te::da::DataSourceTransactor::indexExists	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It checks if an index with the given name exists in the dataset.

Parameters

datasetName	The dataset name.
name	The index name.

Exceptions

Exception An exception can be thrown, if the index existence could not be determined.

Returns: True, if the index exists in the dataset; otherwise, it returns false.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual bool te::da::DataSourceTransactor::isDataSetNameValid ( const std::string & datasetName )

virtual

It returns true if the given string is a valid dataset name.

Parameters

datasetName A dataset name whose validity will be checked.

Returns: True, if the name is valid according to the data source rules.

Note: Not thread-safe!

Reimplemented in te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, and te::wfs::Transactor.

virtual bool te::da::DataSourceTransactor::isInTransaction ( ) const

pure virtual

It returns true if a transaction is in progress, otherwise, it returns false.

Returns: True, if a transaction is in progress, otherwise, false.

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::stmem::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual bool te::da::DataSourceTransactor::isPropertyNameValid ( const std::string & propertyName )

virtual

It checks if the given property name is valid.

Parameters

propertyName A property name whose validity will be checked.

Returns: True, if the name is valid according to the data source rules.

Note: Not thread-safe!

Reimplemented in te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, and te::wfs::Transactor.

virtual void te::da::DataSourceTransactor::optimize ( const std::map< std::string, std::string > & opInfo )

pure 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).

Parameters

opInfo Any information needed by the underlying driver in order to fine tune the optimization.

Exceptions

Exception It may throw an exception if something goes wrong.

Note: Not thread-safe!; For some systems you must assure that no other thread are executing commands against the data source.; For some drivers, this method has no effect.

Implemented in te::pgis::Transactor, te::gdal::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::wfs::Transactor.

virtual bool te::da::DataSourceTransactor::primaryKeyExists	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It checks if a primary key exists in the dataset.

Parameters

datasetName	The dataset name.
name	The primary key name.

Exceptions

Exception An exception can be thrown, if the existence of the primary key could not be determined.

Returns: True, if a primary key exists in the dataset; otherwise, it returns false.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual bool te::da::DataSourceTransactor::propertyExists	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It checks if a property with the given name exists in the dataset.

Parameters

datasetName	The dataset name.
name	The property name.

Exceptions

Exception An exception can be thrown, if the existence of the dataset property could not be obtained.

Returns: True, if the property exists in the dataset; otherwise, it returns false.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::ado::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual std::auto_ptr<DataSet> te::da::DataSourceTransactor::query	(	const Select &	q,
		te::common::TraverseType	travType = `te::common::FORWARDONLY`,
		bool	connected = `false`,
		const te::common::AccessPolicy	accessPolicy = `te::common::RAccess`
	)

pure 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.

Exceptions

Exception

It can throw an exception if:

something goes wrong during the data retrieval
if the data source driver doesn't support the traversal type

Parameters

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.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual std::auto_ptr<DataSet> te::da::DataSourceTransactor::query	(	const std::string &	query,
		te::common::TraverseType	travType = `te::common::FORWARDONLY`,
		bool	connected = `false`,
		const te::common::AccessPolicy	accessPolicy = `te::common::RAccess`
	)

pure 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.

Parameters

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.

Exceptions

Exception

It can throw an exception if:

something goes wrong during the data retrieval
if the data source driver doesn't support the traversal type

Note: Don't use this method, if you want portability for your application.; Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::remove	(	const std::string &	datasetName,
		const ObjectIdSet *	oids = `0`
	)

pure 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.

Parameters

datasetName	The dataset name.
oids	A list of object identifiers used to remove data from the datasource, or NULL for all.

Exceptions

Exception An exception can be thrown, if the data items could not be removed.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual void te::da::DataSourceTransactor::renameDataSet	(	const std::string &	name,
		const std::string &	newName
	)

pure virtual

It renames a dataset.

Parameters

name	The name of the dataset to be renamed.
newName	The new dataset name.

Exceptions

Exception An exception can be thrown, if the dataset could not be renamed.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual void te::da::DataSourceTransactor::renameProperty	(	const std::string &	datasetName,
		const std::string &	propertyName,
		const std::string &	newPropertyName
	)

pure virtual

It renames a property of the given dataset.

Parameters

datasetName	The dataset containig the property to be renamed.
propertyName	The property to be renamed from the dataset.
newPropertyName	The new property name.

Exceptions

Exception An exception can be thrown, if the dataset property could not be renamed.

Note: Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual void te::da::DataSourceTransactor::rollBack ( )

pure virtual

It aborts the transaction. Any changes will be rolled-back.

After commiting or rolling back, you can start another transaction.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, te::stmem::Transactor, te::ws::ogc::wms::da::Transactor, terralib4::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual bool te::da::DataSourceTransactor::sequenceExists ( const std::string & name )

pure virtual

It checks if a sequence with the given name exists in the data source.

Parameters

name	The sequence name.

Exceptions

Exception An exception can be thrown, if the index existence could not be determined.

Returns: True, if the sequence exists in the data source; otherwise, it returns false.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ado::Transactor, te::ws::ogc::wcs::da::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual bool te::da::DataSourceTransactor::uniqueKeyExists	(	const std::string &	datasetName,
		const std::string &	name
	)

pure virtual

It checks if a unique key with the given name exists in the dataset.

Parameters

datasetName	The dataset name.
name	The unique key name.

Exceptions

Exception An exception can be thrown, if the existence of the unique key could not be determined.

Returns: True, if the unique key exists in the data source; otherwise, it returns false.

Note: Not thread-safe!

Implemented in te::gdal::Transactor, te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

virtual void te::da::DataSourceTransactor::update	(	const std::string &	datasetName,
		DataSet *	dataset,
		const std::vector< std::size_t > &	properties,
		const ObjectIdSet *	oids,
		const std::map< std::string, std::string > &	options,
		std::size_t	limit = `0`
	)

pure virtual

It updates the contents of a dataset for the set of data items.

Parameters

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.

Exceptions

Exception An exception can be thrown, if the dataset could not be updated.

Note: The dataset reading will start in the current position. So, keep in mind that it is the caller responsability to inform the right position(and a valid one) for the dataset 'd', to start the updating process.; Not thread-safe!

Implemented in te::pgis::Transactor, te::ws::ogc::wcs::da::Transactor, te::ado::Transactor, terralib4::Transactor, te::ws::ogc::wms::da::Transactor, te::stmem::Transactor, te::mem::Transactor, te::wfs::Transactor, te::ogr::Transactor, te::gpkg::Transactor, and te::gdal::Transactor.

virtual void te::da::DataSourceTransactor::update	(	const std::string &	datasetName,
		DataSet *	dataset,
		const std::vector< std::set< int > > &	properties,
		const std::vector< size_t > &	ids
	)

virtual

It updates the contents of a dataset.

All rows are edited. The third parameter tells wich columns are edited for each row.

Parameters

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.

Exceptions

te::da::Exception An exception can be thrown, if the dataset could not be updated.

Reimplemented in te::pgis::Transactor, te::ado::Transactor, te::ogr::Transactor, and te::gpkg::Transactor.

The documentation for this class was generated from the following file:

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/dataaccess/datasource/DataSourceTransactor.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation