#include <Transactor.h>

Inheritance diagram for te::ogr::Transactor:

Public Member Functions
void	add (const std::string &datasetName, te::da::DataSet *d, const std::map< std::string, std::string > &options, std::size_t limit=0, bool enableProgress=true)
	It adds data items to the dataset in the data source. More...

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

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

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

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

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

void	addSequence (te::da::Sequence *sequence)
	It creates a new sequence in the data source. More...

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

void	begin ()
	It starts a new transaction. More...

void	cancel ()
	It requests that the data source stop the processing of the current command. More...

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

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

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

void	commit ()
	It commits the transaction. More...

void	createDataSet (te::da::DataSetType *dt, const std::map< std::string, std::string > &options)
	It creates the dataset schema definition in the target data source. More...

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

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

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

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

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

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

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

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

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

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

void	execute (const te::da::Query &command)
	It executes the specified command using a generic query representation. More...

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

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

std::unique_ptr< te::da::BatchExecutor >	getBatchExecutor ()
	It creates a batch command executor. More...

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

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

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

std::unique_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::unique_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::unique_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::vector< std::string >	getDataSetNames ()
	It It gets the dataset names available in the data source. More...

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

te::da::DataSource *	getDataSource () const
	It returns the parent data source of the transactor. More...

std::unique_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::unique_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::unique_ptr< te::da::ForeignKey >	getForeignKey (const std::string &datasetName, const std::string &name)
	It retrieves the foreign key from the given dataset. More...

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

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

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

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

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

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

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

std::unique_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::unique_ptr< te::da::PrimaryKey >	getPrimaryKey (const std::string &datasetName)
	It retrieves the primary key of the dataset. More...

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

std::unique_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::unique_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::unique_ptr< te::da::Sequence >	getSequence (const std::string &name)
	It gets the sequence with the given name in the data source. More...

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

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

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

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

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

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

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

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

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

std::unique_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::unique_ptr< te::da::DataSet >	query (const std::string &query, te::common::TraverseType travType=te::common::FORWARDONLY, bool connected=false, const te::common::AccessPolicy accessPolicy=te::common::RAccess)
	It executes a query that may return some data using the data source native language. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source. More...

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

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

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

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

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

	Transactor (DataSource *ds)

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

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

virtual void	update (const std::string &datasetName, te::da::DataSet *dataset, const std::vector< std::set< int > > &properties, const std::vector< size_t > &ids)
	It updates the contents of a dataset. More...

	~Transactor ()

DataSet Retrieval
Methods for retrieving data from the data source.
std::unique_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...

Auxiliary Commands for Commands and Queries
Auxiliary methods for commands and queries.
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::string	getGeometryTypeName (te::gm::GeomType type)
	It gets the datasource geometry type name equivalent to terralib. More...

Protected Attributes
long int	m_fid

DataSource *	m_ogrDs

Detailed Description

Definition at line 43 of file src/terralib/ogr/Transactor.h.

Constructor & Destructor Documentation

te::ogr::Transactor::Transactor ( DataSource * ds )

Definition at line 82 of file src/terralib/ogr/Transactor.cpp.

References ~Transactor().

te::ogr::Transactor::~Transactor ( )

default

Referenced by Transactor().

Member Function Documentation

void te::ogr::Transactor::add	(	const std::string &	datasetName,
		te::da::DataSet *	d,
		const std::map< std::string, std::string > &	options,
		std::size_t	limit = `0`,
		bool	enableProgress = `true`
	)

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.
enableProgress	Enable task progress during the save.

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!

Implements te::da::DataSourceTransactor.

Definition at line 1079 of file src/terralib/ogr/Transactor.cpp.

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

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!

Implements te::da::DataSourceTransactor.

Definition at line 852 of file src/terralib/ogr/Transactor.cpp.

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

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!

Implements te::da::DataSourceTransactor.

Definition at line 806 of file src/terralib/ogr/Transactor.cpp.

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

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!

Implements te::da::DataSourceTransactor.

Definition at line 875 of file src/terralib/ogr/Transactor.cpp.

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

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!

Implements te::da::DataSourceTransactor.

Definition at line 783 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::addProperty	(	const std::string &	datasetName,
		te::dt::Property *	p
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 628 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::Convert2OGR(), te::dt::GEOMETRY_TYPE, te::dt::Property::getName(), te::ogr::DataSource::getOGRDataSource(), te::dt::Property::getType(), m_ogrDs, and TE_TR.

Referenced by createDataSet().

void te::ogr::Transactor::addSequence ( te::da::Sequence * sequence )

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!

Implements te::da::DataSourceTransactor.

Definition at line 899 of file src/terralib/ogr/Transactor.cpp.

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

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!

Implements te::da::DataSourceTransactor.

Definition at line 829 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::begin ( )

virtual

It starts a new transaction.

Note: Not thread-safe!

Implements te::da::DataSourceTransactor.

Definition at line 93 of file src/terralib/ogr/Transactor.cpp.

Referenced by add(), and remove().

void te::ogr::Transactor::cancel ( )

virtual

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

Note: Not thread-safe!

Implements te::da::DataSourceTransactor.

Definition at line 371 of file src/terralib/ogr/Transactor.cpp.

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

virtual

Reimplemented from te::da::DataSourceTransactor.

Definition at line 710 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), GetOGRType(), te::dt::Property::getType(), m_ogrDs, p, and TE_TR.

bool te::ogr::Transactor::checkConstraintExists	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 847 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::cloneDataSet	(	const std::string &	name,
		const std::string &	cloneName,
		const std::map< std::string, std::string > &	options
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 1033 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), m_ogrDs, and TE_TR.

void te::ogr::Transactor::commit ( )

virtual

It commits the transaction.

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

Note: Not thread-safe!

Implements te::da::DataSourceTransactor.

Definition at line 97 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

Referenced by add(), and remove().

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

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!

Implements te::da::DataSourceTransactor.

Definition at line 973 of file src/terralib/ogr/Transactor.cpp.

References addProperty(), te::ogr::Convert2OGR(), te::ogr::Convert2OGRProjection(), te::common::Convert2UCase(), te::ogr::DataSource::createOGRDataSource(), te::core::Expand(), te::da::DataSource::getConnectionInfo(), te::da::GetFirstGeomProperty(), te::dt::Property::getName(), te::ogr::DataSource::getOGRDataSource(), te::dt::CompositeProperty::getProperty(), te::gm::GeometryProperty::getSRID(), te::da::DataSetType::hasGeom(), m_ogrDs, p, te::core::URI::query(), te::dt::Property::setName(), te::dt::CompositeProperty::size(), TE_TR, and TE_UNKNOWN_SRS.

bool te::ogr::Transactor::dataSetExists ( const std::string & name )

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!

Implements te::da::DataSourceTransactor.

Definition at line 965 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

void te::ogr::Transactor::dropCheckConstraint	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 856 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::dropDataSet ( const std::string & name )

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!

Implements te::da::DataSourceTransactor.

Definition at line 1054 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), m_ogrDs, and TE_TR.

void te::ogr::Transactor::dropForeignKey	(	const std::string &	datasetName,
		const std::string &	fkName
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 810 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::dropIndex	(	const std::string &	datasetName,
		const std::string &	idxName
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 880 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::dropPrimaryKey ( const std::string & datasetName )

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!

Implements te::da::DataSourceTransactor.

Definition at line 787 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::dropProperty	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 655 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), m_ogrDs, and TE_TR.

void te::ogr::Transactor::dropSequence ( const std::string & name )

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!

Implements te::da::DataSourceTransactor.

Definition at line 903 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::dropUniqueKey	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 833 of file src/terralib/ogr/Transactor.cpp.

std::string te::ogr::Transactor::escape ( const std::string & value )

virtual

It escapes a string for using in commands and queries.

Parameters

value Any string.

Returns: A valid escaped string.

Note: Not thread-safe!

Implements te::da::DataSourceTransactor.

Definition at line 380 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::execute ( const te::da::Query & command )

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!

Implements te::da::DataSourceTransactor.

Definition at line 340 of file src/terralib/ogr/Transactor.cpp.

References te::common::BaseVisitable< T, R >::accept(), te::ogr::DataSource::getDialect(), and m_ogrDs.

void te::ogr::Transactor::execute ( const std::string & command )

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!

Implements te::da::DataSourceTransactor.

Definition at line 350 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

bool te::ogr::Transactor::foreignKeyExists	(	const std::string &	datasetName,
		const std::string &	name
	)

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.

Implements te::da::DataSourceTransactor.

Definition at line 801 of file src/terralib/ogr/Transactor.cpp.

std::unique_ptr< te::da::BatchExecutor > te::ogr::Transactor::getBatchExecutor ( )

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.

Implements te::da::DataSourceTransactor.

Definition at line 366 of file src/terralib/ogr/Transactor.cpp.

std::unique_ptr< te::da::DataSetTypeCapabilities > te::ogr::Transactor::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 from te::da::DataSourceTransactor.

Definition at line 471 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

std::unique_ptr< te::da::CheckConstraint > te::ogr::Transactor::getCheckConstraint	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 837 of file src/terralib/ogr/Transactor.cpp.

std::vector< std::string > te::ogr::Transactor::getCheckConstraintNames ( const std::string & datasetName )

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!

Implements te::da::DataSourceTransactor.

Definition at line 842 of file src/terralib/ogr/Transactor.cpp.

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

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!

Implements te::da::DataSourceTransactor.

Definition at line 114 of file src/terralib/ogr/Transactor.cpp.

References DataSet(), ds, te::ogr::DataSource::getEncoding(), te::core::CharEncoding::getEncodingName(), te::ogr::DataSource::getOGRDataSource(), te::ogr::getStaticMutex(), m_ogrDs, te::common::RWAccess, TE_TR, te::core::UTF8, and te::common::WAccess.

std::unique_ptr< te::da::DataSet > te::ogr::Transactor::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`
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 152 of file src/terralib/ogr/Transactor.cpp.

References DataSet(), ds, te::ogr::DataSource::getEncoding(), te::core::CharEncoding::getEncodingName(), te::ogr::DataSource::getOGRDataSource(), te::ogr::getStaticMutex(), te::gm::Envelope::m_llx, te::gm::Envelope::m_lly, m_ogrDs, te::gm::Envelope::m_urx, te::gm::Envelope::m_ury, te::common::RWAccess, TE_TR, te::core::UTF8, and te::common::WAccess.

std::unique_ptr< te::da::DataSet > te::ogr::Transactor::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`
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 195 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::Convert2OGR(), DataSet(), ds, te::ogr::DataSource::getEncoding(), te::core::CharEncoding::getEncodingName(), te::ogr::DataSource::getOGRDataSource(), te::ogr::getStaticMutex(), m_ogrDs, te::common::RWAccess, TE_TR, te::core::UTF8, and te::common::WAccess.

std::unique_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`
	)

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.

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

Definition at line 47 of file src/terralib/dataaccess/datasource/DataSourceTransactor.cpp.

References te::da::ObjectIdSet::getExpression(), te::da::DataSourceTransactor::query(), and te::da::ObjectIdSet::size().

std::vector< std::string > te::ogr::Transactor::getDataSetNames ( )

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!

Implements te::da::DataSourceTransactor.

Definition at line 385 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

std::unique_ptr< te::da::DataSetType > te::ogr::Transactor::getDataSetType ( const std::string & name )

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!

Implements te::da::DataSourceTransactor.

Definition at line 406 of file src/terralib/ogr/Transactor.cpp.

References te::da::PrimaryKey::add(), te::ogr::Convert2TerraLib(), te::ogr::Convert2TerraLibProjection(), te::gm::GeometryType, te::da::GetFirstGeomProperty(), te::ogr::DataSource::getOGRDataSource(), m_ogrDs, and te::gm::GeometryProperty::setSRID().

te::da::DataSource * te::ogr::Transactor::getDataSource ( ) const

virtual

It returns the parent data source of the transactor.

Implements te::da::DataSourceTransactor.

Definition at line 88 of file src/terralib/ogr/Transactor.cpp.

std::unique_ptr< te::gm::Envelope > te::ogr::Transactor::getExtent	(	const std::string &	datasetName,
		const std::string &	propertyName
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 907 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::Convert2TerraLib(), te::ogr::DataSource::getOGRDataSource(), m_ogrDs, and TE_TR.

Referenced by getExtent().

std::unique_ptr< te::gm::Envelope > te::ogr::Transactor::getExtent	(	const std::string &	datasetName,
		std::size_t	propertyPos
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 938 of file src/terralib/ogr/Transactor.cpp.

References getExtent().

std::unique_ptr< te::da::ForeignKey > te::ogr::Transactor::getForeignKey	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 791 of file src/terralib/ogr/Transactor.cpp.

std::vector< std::string > te::ogr::Transactor::getForeignKeyNames ( const std::string & datasetName )

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!

Implements te::da::DataSourceTransactor.

Definition at line 796 of file src/terralib/ogr/Transactor.cpp.

std::string te::da::DataSourceTransactor::getGeometryTypeName ( te::gm::GeomType type )

virtualinherited

It gets the datasource geometry type name equivalent to terralib.

Parameters

type	The terralib geometry type.

Returns: The geometry type name equivalent to terralib.

Reimplemented in te::pgis::Transactor.

Definition at line 114 of file src/terralib/dataaccess/datasource/DataSourceTransactor.cpp.

std::unique_ptr< te::da::Index > te::ogr::Transactor::getIndex	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 860 of file src/terralib/ogr/Transactor.cpp.

std::vector< std::string > te::ogr::Transactor::getIndexNames ( const std::string & datasetName )

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!

Implements te::da::DataSourceTransactor.

Definition at line 865 of file src/terralib/ogr/Transactor.cpp.

boost::int64_t te::ogr::Transactor::getLastGeneratedId ( )

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!

Implements te::da::DataSourceTransactor.

Definition at line 375 of file src/terralib/ogr/Transactor.cpp.

References m_fid.

std::size_t te::ogr::Transactor::getNumberOfDataSets ( )

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!

Implements te::da::DataSourceTransactor.

Definition at line 398 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

std::size_t te::ogr::Transactor::getNumberOfItems ( const std::string & datasetName )

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!

Implements te::da::DataSourceTransactor.

Definition at line 944 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

std::size_t te::ogr::Transactor::getNumberOfProperties ( const std::string & datasetName )

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!

Implements te::da::DataSourceTransactor.

Definition at line 585 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

std::unique_ptr< te::da::PreparedQuery > te::ogr::Transactor::getPrepared ( const std::string & qName = std::string("") )

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.

Implements te::da::DataSourceTransactor.

Definition at line 361 of file src/terralib/ogr/Transactor.cpp.

std::unique_ptr< te::da::PrimaryKey > te::ogr::Transactor::getPrimaryKey ( const std::string & datasetName )

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!

Implements te::da::DataSourceTransactor.

Definition at line 746 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), getProperty(), and m_ogrDs.

boost::ptr_vector< te::dt::Property > te::ogr::Transactor::getProperties ( const std::string & datasetName )

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!

Implements te::da::DataSourceTransactor.

Definition at line 487 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::Convert2TerraLib(), te::ogr::Convert2TerraLibProjection(), dt, te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

std::unique_ptr< te::dt::Property > te::ogr::Transactor::getProperty	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 515 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

Referenced by getPrimaryKey().

std::unique_ptr< te::dt::Property > te::ogr::Transactor::getProperty	(	const std::string &	datasetName,
		std::size_t	propertyPos
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 534 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::Convert2TerraLib(), te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

std::vector< std::string > te::ogr::Transactor::getPropertyNames ( const std::string & datasetName )

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!

Implements te::da::DataSourceTransactor.

Definition at line 560 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

std::unique_ptr< te::da::Sequence > te::ogr::Transactor::getSequence ( const std::string & name )

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!

Implements te::da::DataSourceTransactor.

Definition at line 884 of file src/terralib/ogr/Transactor.cpp.

std::vector< std::string > te::ogr::Transactor::getSequenceNames ( )

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!

Implements te::da::DataSourceTransactor.

Definition at line 889 of file src/terralib/ogr/Transactor.cpp.

std::unique_ptr< te::da::UniqueKey > te::ogr::Transactor::getUniqueKey	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 814 of file src/terralib/ogr/Transactor.cpp.

std::vector< std::string > te::ogr::Transactor::getUniqueKeyNames ( const std::string & datasetName )

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!

Implements te::da::DataSourceTransactor.

Definition at line 819 of file src/terralib/ogr/Transactor.cpp.

bool te::ogr::Transactor::hasDataSets ( )

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!

Implements te::da::DataSourceTransactor.

Definition at line 957 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

bool te::ogr::Transactor::indexExists	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 870 of file src/terralib/ogr/Transactor.cpp.

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

virtualinherited

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::wms::Transactor, te::wcs::Transactor, te::mem::Transactor, te::wfs::Transactor, and te::sqlite::DataSourceTransactor.

Definition at line 102 of file src/terralib/dataaccess/datasource/DataSourceTransactor.cpp.

References te::da::IsValidName().

bool te::ogr::Transactor::isInTransaction ( ) const

virtual

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

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

Implements te::da::DataSourceTransactor.

Definition at line 109 of file src/terralib/ogr/Transactor.cpp.

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

virtualinherited

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::wms::Transactor, te::wcs::Transactor, te::mem::Transactor, te::wfs::Transactor, and te::sqlite::DataSourceTransactor.

Definition at line 108 of file src/terralib/dataaccess/datasource/DataSourceTransactor.cpp.

References te::da::IsValidName().

void te::ogr::Transactor::optimize ( const std::map< std::string, std::string > & opInfo )

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.

Implements te::da::DataSourceTransactor.

Definition at line 1433 of file src/terralib/ogr/Transactor.cpp.

bool te::ogr::Transactor::primaryKeyExists	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 778 of file src/terralib/ogr/Transactor.cpp.

bool te::ogr::Transactor::propertyExists	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 607 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), and m_ogrDs.

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

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!

Implements te::da::DataSourceTransactor.

Definition at line 242 of file src/terralib/ogr/Transactor.cpp.

References te::common::BaseVisitable< T, R >::accept(), DataSet(), ds, te::ogr::DataSource::getDialect(), te::ogr::DataSource::getEncoding(), te::core::CharEncoding::getEncodingName(), te::ogr::DataSource::getOGRDataSource(), te::ogr::getStaticMutex(), te::gm::Envelope::m_llx, te::gm::Envelope::m_lly, m_ogrDs, te::gm::Envelope::m_urx, te::gm::Envelope::m_ury, te::ogr::RemoveSpatialSql(), te::common::RWAccess, TE_TR, te::core::UTF8, and te::common::WAccess.

Referenced by query().

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

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!

Implements te::da::DataSourceTransactor.

Definition at line 294 of file src/terralib/ogr/Transactor.cpp.

References DataSet(), ds, te::ogr::DataSource::getEncoding(), te::core::CharEncoding::getEncodingName(), te::ogr::DataSource::getOGRDataSource(), te::ogr::getStaticMutex(), m_ogrDs, query(), te::common::RWAccess, TE_TR, te::core::UTF8, and te::common::WAccess.

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

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!

Implements te::da::DataSourceTransactor.

Definition at line 1274 of file src/terralib/ogr/Transactor.cpp.

References begin(), te::da::ObjectIdSet::begin(), commit(), te::da::ObjectIdSet::end(), te::ogr::DataSource::getOGRDataSource(), m_ogrDs, rollBack(), and TE_TR.

void te::ogr::Transactor::renameDataSet	(	const std::string &	name,
		const std::string &	newName
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 1075 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::renameProperty	(	const std::string &	datasetName,
		const std::string &	propertyName,
		const std::string &	newPropertyName
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 681 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::DataSource::getOGRDataSource(), m_ogrDs, and TE_TR.

void te::ogr::Transactor::rollBack ( )

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!

Implements te::da::DataSourceTransactor.

Definition at line 105 of file src/terralib/ogr/Transactor.cpp.

Referenced by add(), and remove().

bool te::ogr::Transactor::sequenceExists ( const std::string & name )

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!

Implements te::da::DataSourceTransactor.

Definition at line 894 of file src/terralib/ogr/Transactor.cpp.

bool te::ogr::Transactor::uniqueKeyExists	(	const std::string &	datasetName,
		const std::string &	name
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 824 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::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`
	)

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!

Implements te::da::DataSourceTransactor.

Definition at line 1338 of file src/terralib/ogr/Transactor.cpp.

void te::ogr::Transactor::update	(	const std::string &	datasetName,
		te::da::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 from te::da::DataSourceTransactor.

Definition at line 1347 of file src/terralib/ogr/Transactor.cpp.

References te::ogr::Convert2OGR(), te::dt::DOUBLE_TYPE, te::dt::GEOMETRY_TYPE, te::da::DataSet::getDouble(), te::da::DataSet::getGeometry(), te::da::DataSet::getInt16(), te::da::DataSet::getInt32(), te::da::DataSet::getInt64(), te::ogr::DataSource::getOGRDataSource(), te::da::DataSet::getPropertyDataType(), te::da::DataSet::getString(), te::dt::INT16_TYPE, te::dt::INT32_TYPE, m_ogrDs, te::da::DataSet::moveFirst(), te::da::DataSet::moveNext(), te::dt::NUMERIC_TYPE, te::dt::STRING_TYPE, and TE_TR.

Member Data Documentation

long int te::ogr::Transactor::m_fid

protected

Definition at line 243 of file src/terralib/ogr/Transactor.h.

Referenced by add(), and getLastGeneratedId().

DataSource* te::ogr::Transactor::m_ogrDs

protected

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation