Implementation of a random-access dataset class for the TerraLib In-Memory Data Access driver. More...

#include <DataSource.h>

Inheritance diagram for te::mem::DataSource:

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)
	It adds data items to the dataset in the data source. More...

void	addProperty (const std::string &datasetName, te::dt::Property *p)
	It adds a new property to the dataset schema. 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	close ()
	It closes the data source and clears all the resources used by its internal communication channel. 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...

	DataSource (const std::string &connInfo)

	DataSource (const te::core::URI &uri)

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

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

const te::da::DataSourceCapabilities &	getCapabilities () const
	It returns the known capabilities of the data source. More...

const te::core::URI &	getConnectionInfo () const
	An Uniform Resource Identifier used to describe the datasource connection. More...

std::auto_ptr< te::da::DataSet >	getDataSet (const std::string &name, te::common::TraverseType travType=te::common::FORWARDONLY, const te::common::AccessPolicy accessPolicy=te::common::RAccess)
	It gets the dataset identified by the given name. This method always returns a disconnected dataset, that is, a dataset that no more depends of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released. More...

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

const std::map< std::string, te::da::DataSetPtr > &	getDataSets () const
	It returns a map relating the dataset names and their contents. More...

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

const te::da::SQLDialect *	getDialect () const
	It returns the data source SQL dialect, if there is one. More...

const std::string &	getId () const
	An identification value for the data source. 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...

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

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

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

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

const std::map< std::string, te::da::DataSetTypePtr >	getSchemas () const
	It returns a map relating the dataset names and their schemas. More...

std::auto_ptr< te::da::DataSourceTransactor >	getTransactor ()
	It returns the set of parameters used to set up the access channel to the underlying repository. More...

std::string	getType () const
	It returns the data source type name (in UPPER CASE). Ex: POSTGIS, SQLITE, WFS, WMS, or MYSQL. More...

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

bool	isOpened () const
	It returns true if the data source is opened, otherwise it returns false. More...

bool	isValid () const
	It checks if the data source is valid (available for using). More...

void	open ()
	It opens the data source and makes it ready for using. More...

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

void	remove (const std::string &datasetName, const te::da::ObjectIdSet *oids)
	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 &name, const std::string &newName)
	It renames a property of the given dataset. More...

void	setId (const std::string &id)
	It sets the data source identification. 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...

	~DataSource ()
	Virtual destructor. More...

Dataset Metadata Retrieval
Methods for retrieving metadata about the datasets of the data source.
std::auto_ptr< te::da::DataSetTypeCapabilities >	getCapabilities (const std::string &name)
	It gets capabilities about a data set. More...

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

virtual void	changePropertiesDefinitions (const std::string &datasetName, const std::vector< std::string > &propsNames, const std::vector< te::dt::Property * > newProps)

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

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

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

virtual void	dropPrimaryKey (const std::string &datasetName)
	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)
	It retrieves the foreign key from the given dataset. More...

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

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

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

virtual void	dropForeignKey (const std::string &datasetName, const std::string &fkName)
	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)
	It gets the unique key in the dataset with the given name. More...

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

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

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

virtual void	dropUniqueKey (const std::string &datasetName, const std::string &name)
	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)
	It gets the check constraint of the dataset with the given name. More...

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

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

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

virtual void	dropCheckConstraint (const std::string &datasetName, const std::string &name)
	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)
	It gets the index with the given name from the dataset. More...

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

virtual bool	indexExists (const std::string &datasetName, const std::string &name)
	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)
	It adds an index to the dataset. More...

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

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

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

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

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

virtual void	dropSequence (const std::string &name)
	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)
	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)
	It retrieves the bounding rectangle for the spatial property lying in the given position in the dataset. More...

Data Retrieval
Methods for retrieving data from the data source.
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, 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. This method always returns a disconnected dataset, that is, a dataset that no more depends of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released. 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, 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. This method always returns a disconnected dataset, that is, a dataset that no more depends of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released. More...

std::auto_ptr< te::da::DataSet >	getDataSet (const std::string &name, const te::da::ObjectIdSet *oids, te::common::TraverseType travType=te::common::FORWARDONLY, const te::common::AccessPolicy accessPolicy=te::common::RAccess)
	It gets the dataset identified by the given name using the identification of the objects. This method always returns a disconnected dataset, that is, a dataset that no more depends of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released. More...

virtual std::auto_ptr< DataSet >	query (const Select &q, te::common::TraverseType travType=te::common::FORWARDONLY, const te::common::AccessPolicy accessPolicy=te::common::RAccess)
	It executes a query that may return some data using a generic query. This method always returns a disconnected dataset, that is, a dataset that no more depends of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released. More...

virtual std::auto_ptr< DataSet >	query (const std::string &query, te::common::TraverseType travType=te::common::FORWARDONLY, const te::common::AccessPolicy accessPolicy=te::common::RAccess)
	It executes a query that may return some data using the data source native language. This method always returns a disconnected dataset, that is, a dataset that is no more dependent of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released. More...

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

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

Auxiliary Methods for Commands and Queries
Auxiliary methods for commands and queries.
virtual std::string	escape (const std::string &value)
	It escapes a string for using in commands and queries. More...

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

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

Dataset Persistence Methods
Methods for dealing with the persistence of data in a data source.
virtual void	update (const std::string &datasetName, DataSet *dataset, const std::vector< std::set< int > > &properties, const std::vector< size_t > &ids)
	It updates the contents of a dataset. More...

virtual te::core::EncodingType	getEncoding ()
	It return the DataSource current encoding. More...

virtual void	setEncoding (const te::core::EncodingType &et)
	It sets the encodings for the data source. More...

Static Public Member Functions
static void	setCapabilities (const te::da::DataSourceCapabilities &capabilities)
	It sets the capabilities document. More...

Data Source static methods
Data Source static methods
static std::unique_ptr< DataSource >	create (const std::string &dsType, const std::string &connInfo)
	It creates a new repository for a data source. More...

static void	drop (const std::string &dsType, const std::string &connInfo)
	It removes a data source identified by its connection information and the driver type. More...

static bool	exists (const std::string &dsType, const std::string &connInfo)
	It checks if the data source exists with the connection information and the driver type. More...

static std::vector< std::string >	getDataSourceNames (const std::string &dsType, const std::string &connInfo)
	It returns the data source names available in the driver. More...

Protected Member Functions
void	create (const std::string &connInfo)
	It creates a new data source. More...

void	drop (const std::string &connInfo)
	It removes the data source with the connection information from a driver. More...

bool	exists (const std::string &connInfo)
	Check the existence of a data source in a driver. More...

std::vector< std::string >	getDataSourceNames (const std::string &connInfo)
	It gets the data source names available in a driver. More...

Protected Attributes
std::string	m_id
	The data source identification. More...

te::core::URI	m_uri
	The URI used to describe the datasource connection;. More...

Private Attributes
std::map< std::string, te::da::DataSetPtr >	m_datasets
	The set of datasets stored in memory. More...

bool	m_deepCopy
	If true, each dataset is cloned in the getDataSet method. More...

bool	m_isOpened
	A flag to control the state of the data source. More...

std::size_t	m_maxNumDatasets
	The maximum number of datasets to be handled by the data source. More...

boost::recursive_mutex	m_mtx
	The internal mutex. More...

std::size_t	m_numDatasets
	The number of datasets kept in the data source. More...

std::map< std::string, te::da::DataSetTypePtr >	m_schemas
	The set of dataset schemas. More...

Static Private Attributes
static te::da::DataSourceCapabilities	sm_capabilities
	The Memory data source capabilities. More...

static const te::da::SQLDialect	sm_dialect
	A dummy dialect. More...

Detailed Description

Implementation of a random-access dataset class for the TerraLib In-Memory Data Access driver.

See also: te::da::DataSource

Definition at line 52 of file DataSource.h.

Constructor & Destructor Documentation

te::mem::DataSource::DataSource ( const std::string & connInfo )

te::mem::DataSource::DataSource ( const te::core::URI & uri )

te::mem::DataSource::~DataSource ( )

virtual

Virtual destructor.

Reimplemented from te::da::DataSource.

Member Function Documentation

void te::mem::DataSource::add	(	const std::string &	datasetName,
		te::da::DataSet *	d,
		const std::map< std::string, std::string > &	options,
		std::size_t	limit
	)

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.; Thread-safe!

Reimplemented from te::da::DataSource.

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

virtualinherited

It adds a check constraint to the dataset.

Parameters

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

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.; Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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.; Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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.; Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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.; Thread-safe!

Reimplemented in te::gdal::DataSource.

void te::mem::DataSource::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.; Thread-safe!

Reimplemented from te::da::DataSource.

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

virtualinherited

It adds 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 data source will take the ownership of it.; Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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.; Thread-safe!

Reimplemented in te::gdal::DataSource.

virtual void te::da::DataSource::changePropertiesDefinitions	(	const std::string &	datasetName,
		const std::vector< std::string > &	propsNames,
		const std::vector< te::dt::Property * >	newProps
	)

virtualinherited

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

virtualinherited

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

void te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

void te::mem::DataSource::close ( )

virtual

It closes the data source and clears all the resources used by its internal communication channel.

This method closes any connection, any opened file, and releases any other resources.

Exceptions

Exception An exception can be thrown, if the data source cannot be closed.

Note: Not thread-safe!

Implements te::da::DataSource.

void te::mem::DataSource::create ( const std::string & connInfo )

protectedvirtual

It creates a new data source.

Parameters

connInfo The information for creating a new data source.

Exceptions

Exception An exception can be thrown, if the data source could not be created.

Note: Not thread-safe!

Implements te::da::DataSource.

static std::unique_ptr<DataSource> te::da::DataSource::create	(	const std::string &	dsType,
		const std::string &	connInfo
	)

staticinherited

It creates a new repository for a data source.

Parameters

dsType	The type of data source to be created (example: POSTGIS, ORACLE, SQLITE).
connInfo	The information for creating a new data source.

Exceptions

Exception An exception can be thrown, if the data source could not be created.

Returns: A data source for the new data repository.

Note: Thread-safe!

void te::mem::DataSource::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.; Thread-safe!

Reimplemented from te::da::DataSource.

bool te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

void te::mem::DataSource::drop ( const std::string & connInfo )

protectedvirtual

It removes the data source with the connection information from a driver.

Parameters

connInfo The information for removing a data source from a driver.

Exceptions

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

Note: Not thread-safe!

Implements te::da::DataSource.

static void te::da::DataSource::drop	(	const std::string &	dsType,
		const std::string &	connInfo
	)

staticinherited

It removes a data source identified by its connection information and the driver type.

Parameters

dsType	The data source type name (example: POSTGIS, ORACLE, SQLITE).
dsInfo	The connection information for removing the data source.

Exceptions

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

Note: No other instance of the data source to be removed can be opened, when calling this method.; Thread-safe!

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

void te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

It removes the index from the given dataset.

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

void te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

It escapes a string for using in commands and queries.

Parameters

value Any string.

Returns: A valid escaped string.

Note: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

It executes the specified command using a generic query representation.

Parameters

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

Exceptions

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

Note: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

It executes the specified 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 An exception can be thrown if the query can not be performed.

Note: Thread-safe!

Reimplemented in te::gdal::DataSource.

bool te::mem::DataSource::exists ( const std::string & connInfo )

protectedvirtual

Check the existence of a data source in a driver.

Parameters

connInfo The data source information.

Exceptions

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

Returns: True, if the data source exists, or false, otherwise.

Note: Thread-safe!

Implements te::da::DataSource.

static bool te::da::DataSource::exists	(	const std::string &	dsType,
		const std::string &	connInfo
	)

staticinherited

It checks if the data source exists with the connection information and the driver type.

Parameters

dsType	The data source type name (example: POSTGIS, ORACLE, SQLITE).
dsInfo	The data source information.

Exceptions

Exception An exception can be thrown, if the data source exists in the driver.

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

Note: Thread-safe!

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

virtualinherited

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.

Reimplemented in te::gdal::DataSource.

const te::da::DataSourceCapabilities& te::mem::DataSource::getCapabilities ( ) const

virtual

It returns the known capabilities of the data source.

The returned object has all the information about the operations the data source can perform. Here you will find if the data source implementation supports primary keys, foreign keys, if it can be used in a thread environment and much more information.

Parameters

capabilities The known capabilities of the data source.

Note: Thread-safe!

Implements te::da::DataSource.

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

inherited

It gets capabilities about a data set.

Parameters

name	Name of the dataset.

Returns: The capabilities of the data set.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

const te::core::URI& te::da::DataSource::getConnectionInfo ( ) const

inherited

An Uniform Resource Identifier used to describe the datasource connection.

Returns: A reference to the URI of the datasource.

std::auto_ptr<te::da::DataSet> te::mem::DataSource::getDataSet	(	const std::string &	name,
		te::common::TraverseType	travType = `te::common::FORWARDONLY`,
		const te::common::AccessPolicy	accessPolicy = `te::common::RAccess`
	)

virtual

It gets the dataset identified by the given name. This method always returns a disconnected dataset, that is, a dataset that no more depends of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released.

Parameters

name	The dataset name.
accessPolicy	Access policy.
travType	The traverse type associated to the returned dataset.

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: Thread-safe!

Reimplemented from te::da::DataSource.

virtual std::auto_ptr<DataSet> te::da::DataSource::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`,
		const te::common::AccessPolicy	accessPolicy = `te::common::RAccess`
	)

virtualinherited

It gets the dataset identified by the given name using a spatial filter over the specified property. This method always returns a disconnected dataset, that is, a dataset that no more depends of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released.

Parameters

name	The dataset name.
propertyName	The name of the spatial property used to apply the spatial filter.
e	A rectangle used as a spatial filter when retrieving the dataset.
r	The spatial relation used during the filtering.
accessPolicy	Access policy.
travType	The traversal type associated to the returned dataset.

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.; Thread-safe!

virtual std::auto_ptr<DataSet> te::da::DataSource::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`,
		const te::common::AccessPolicy	accessPolicy = `te::common::RAccess`
	)

virtualinherited

It gets the dataset identified by the given name using a spatial filter over the given geometric property. This method always returns a disconnected dataset, that is, a dataset that no more depends of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released.

Parameters

name	The dataset name.
propertyName	The name of the spatial property used to apply the spatial filter.
g	The geometry used as a spatial filter when retrieving the dataset.
r	The spatial relation used during the filtering.
accessPolicy	Access policy.
travType	The traverse type associated to the returned dataset.

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

std::auto_ptr<te::da::DataSet> te::da::DataSource::getDataSet	(	const std::string &	name,
		const te::da::ObjectIdSet *	oids,
		te::common::TraverseType	travType = `te::common::FORWARDONLY`,
		const te::common::AccessPolicy	accessPolicy = `te::common::RAccess`
	)

inherited

It gets the dataset identified by the given name using the identification of the objects. This method always returns a disconnected dataset, that is, a dataset that no more depends of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released.

Parameters

name	The dataset name.
oids	A pointer to the set of objects. Do not pass a null pointer nor an empty set.
accessPolicy	Access policy.
travType	The traverse type associated to the returned dataset.

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

Note: Thread-safe!

std::vector<std::string> te::mem::DataSource::getDataSetNames ( )

virtual

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 (".").; Thread-safe!

Reimplemented from te::da::DataSource.

const std::map<std::string, te::da::DataSetPtr>& te::mem::DataSource::getDataSets ( ) const

It returns a map relating the dataset names and their contents.

Returns: The map relating the dataset names and their contents..

std::auto_ptr<te::da::DataSetType> te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

std::vector<std::string> te::mem::DataSource::getDataSourceNames ( const std::string & connInfo )

protectedvirtual

It gets the data source names available in a driver.

Parameters

dsInfo The data source information.

Exceptions

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

Returns: The data source names available in the driver.

Note: Not thread-safe!

Implements te::da::DataSource.

static std::vector<std::string> te::da::DataSource::getDataSourceNames	(	const std::string &	dsType,
		const std::string &	connInfo
	)

staticinherited

It returns the data source names available in the driver.

Parameters

dsType	The type name of the data source(example: PostGIS, Oracle, WFS).
dsInfo	The information about the data sources.

Exceptions

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

Returns: The data source names available.

Exceptions

Exception An exception can be thrown, if the list of data source names could not be retrieved.

const te::da::SQLDialect* te::mem::DataSource::getDialect ( ) const

virtual

It returns the data source SQL dialect, if there is one.

Returns: The data source SQL dialect.

Note: Thread-safe!

Implements te::da::DataSource.

virtual te::core::EncodingType te::da::DataSource::getEncoding ( )

virtualinherited

It return the DataSource current encoding.

Returns: The DataSource current encoding.

Reimplemented in te::ogr::DataSource.

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

virtualinherited

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: Thread-safe!

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

virtualinherited

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: Thread-safe!

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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

Note: Thread-safe!

Reimplemented in te::gdal::DataSource.

const std::string& te::da::DataSource::getId ( ) const

inherited

An identification value for the data source.

Returns: The data source identification.

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

virtualinherited

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 from the given dataset.

Note: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

std::size_t te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

std::size_t te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

std::size_t te::mem::DataSource::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 dataset properties.

Note: Thread-safe!

Reimplemented from te::da::DataSource.

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

virtualinherited

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: Thread-safe!

boost::ptr_vector<te::dt::Property> te::mem::DataSource::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 dataset properties.

Note: Thread-safe!

Reimplemented from te::da::DataSource.

std::auto_ptr<te::dt::Property> te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

std::auto_ptr<te::dt::Property> te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

std::vector<std::string> te::mem::DataSource::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 (".").; Thread-safe!

Reimplemented from te::da::DataSource.

const std::map<std::string, te::da::DataSetTypePtr> te::mem::DataSource::getSchemas ( ) const

It returns a map relating the dataset names and their schemas.

Returns: The map relating the dataset names and their schemas.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

std::auto_ptr<te::da::DataSourceTransactor> te::mem::DataSource::getTransactor ( )

virtual

It returns the set of parameters used to set up the access channel to the underlying repository.

This is the connection information used by a data source in order to enter in an operational mode, when the open method is called.

The key-value-pairs (kvp) may contain information about: maximum number of accepted connections, user name and password required for establishing a connection, the url of a service, or any other information needed by the data source to operate. This information is dependent on the data source driver, so check the driver documentation for any additional information about the kvp.

Returns: An associative container (key-value-pair) with information about the data source.

Note: Thread-safe!

It sets the connection information to be used when connecting to the data source.

Parameters

connInfo The connection information.

It returns an object that can execute transactions in the context of a data source.

Use this method to get an object that allows to retrieve a dataset, to insert or update data, or to modify dataset types(schemas). You don't need to cache this kind of object because each driver in TerraLib already keeps a connection pooling. So, as soon as you finish using the transactor, destroy it.

Returns: A pointer to an object that can execute transactions in the context of a data source.

Exceptions

Exception An exception can be thrown, if it is not possible to get a transactor; for example, if there is no available connection.

Note: Thread-safe!

Implements te::da::DataSource.

std::string te::mem::DataSource::getType ( ) const

virtual

It returns the data source type name (in UPPER CASE). Ex: POSTGIS, SQLITE, WFS, WMS, or MYSQL.

Returns: The data source type name. Ex: POSTGIS, SQLITE, WFS, WMS, or MYSQL.

Note: Each data source driver must have a unique name.; Thread-safe!

Implements te::da::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

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: Thread-safe!

bool te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

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

virtualinherited

It checks if the given dataset name is valid.

Parameters

datasetName A dataset name whose validity will be checked.

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

Note: Thread-safe!

bool te::mem::DataSource::isOpened ( ) const

virtual

It returns true if the data source is opened, otherwise it returns false.

This method will not check if the data source is available for using; it will just answer if the data source has already been opened. If you want to know if the data source is available for using, check the isValid() method.

Returns: It returns true if the data source is opened; otherwise, it returns false.

Note: Not thread-safe!

Implements te::da::DataSource.

virtual bool te::da::DataSource::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: Thread-safe!

bool te::mem::DataSource::isValid ( ) const

virtual

It checks if the data source is valid (available for using).

For a DBMS, it will check the opened connections. For a WFS client, it will check if the server is reachable. For a file, it will check if it can be read.

Returns: It returns true if the data source is available; otherwise, it returns false.

Note: Not thread-safe!

Implements te::da::DataSource.

void te::mem::DataSource::open ( )

virtual

It opens the data source and makes it ready for using.

If the subclass needs to open a connection to a database server, to open a file, or to get information from a Web Service, this method can do this kind of job to prepare the data source to be in an operational mode. It will use the connection information provided by the setConnectionInfo methods.

Exceptions

Exception An exception can be thrown, if the data source cannot be opened.

Note: Not thread-safe!

Implements te::da::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

bool te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

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

virtualinherited

It executes a query that may return some data using a generic query. This method always returns a disconnected dataset, that is, a dataset that no more depends of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released.

This method is different of the method that accepts a dataset name and a spatial filter; this method allows the retrieving of only a subset of the attributes, since a query can include a property list.

Parameters

q	A valid query object.
travType	The traverse type associated to the returned dataset.
accessPolicy	Access policy.

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

Note: Thread-safe!

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

virtualinherited

It executes a query that may return some data using the data source native language. This method always returns a disconnected dataset, that is, a dataset that is no more dependent of the data source that provided the connection for its creation. Therefore, the disconnected dataset continues to live after the connection given by the data source has been released.

Parameters

query	A query string in the data source native language.
travType	The traverse type associated to the returned dataset.
accessPolicy	Access policy.

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

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

void te::mem::DataSource::remove	(	const std::string &	datasetName,
		const te::da::ObjectIdSet *	oids
	)

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 set of object identifiers used used to remove data from the dataset, or NULL, for removing all.

Exceptions

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

Note: Thread-safe!

Reimplemented from te::da::DataSource.

void te::mem::DataSource::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: Thread-safe!

Reimplemented from te::da::DataSource.

void te::mem::DataSource::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 containing 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: Thread-safe!

Reimplemented from te::da::DataSource.

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

virtualinherited

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: Thread-safe!

Reimplemented in te::gdal::DataSource.

static void te::mem::DataSource::setCapabilities ( const te::da::DataSourceCapabilities & capabilities )

static

It sets the capabilities document.

Parameters

capabilities The memory data source capabilities.

Note: The memory data source will take the ownership of the given capabilities object.; Memory driver extended method.

virtual void te::da::DataSource::setEncoding ( const te::core::EncodingType & et )

virtualinherited

It sets the encodings for the data source.

Parameters

et	The char encoding type.

Note: This function only takes effect if datasource support this option.

Reimplemented in te::ogr::DataSource.

void te::da::DataSource::setId ( const std::string & id )

inherited

It sets the data source identification.

Parameters

id	An identification value.

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

virtualinherited

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 dataset; otherwise, it returns false.

Note: Thread-safe!

Reimplemented in te::gdal::DataSource.

void te::mem::DataSource::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.; Thread-safe!

Reimplemented from te::da::DataSource.

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

virtualinherited

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.

Member Data Documentation

std::map<std::string, te::da::DataSetPtr> te::mem::DataSource::m_datasets

private

The set of datasets stored in memory.

Definition at line 170 of file DataSource.h.

bool te::mem::DataSource::m_deepCopy

private

If true, each dataset is cloned in the getDataSet method.

Definition at line 176 of file DataSource.h.

std::string te::da::DataSource::m_id

protectedinherited

The data source identification.

Definition at line 1434 of file DataSource.h.

bool te::mem::DataSource::m_isOpened

private

A flag to control the state of the data source.

Definition at line 175 of file DataSource.h.

std::size_t te::mem::DataSource::m_maxNumDatasets

private

The maximum number of datasets to be handled by the data source.

Definition at line 174 of file DataSource.h.

boost::recursive_mutex te::mem::DataSource::m_mtx

mutableprivate

The internal mutex.

Definition at line 172 of file DataSource.h.

std::size_t te::mem::DataSource::m_numDatasets

private

The number of datasets kept in the data source.

Definition at line 173 of file DataSource.h.

std::map<std::string, te::da::DataSetTypePtr> te::mem::DataSource::m_schemas

private

The set of dataset schemas.

Definition at line 171 of file DataSource.h.

te::core::URI te::da::DataSource::m_uri

protectedinherited

The URI used to describe the datasource connection;.

Definition at line 1435 of file DataSource.h.

te::da::DataSourceCapabilities te::mem::DataSource::sm_capabilities

staticprivate

The Memory data source capabilities.

Definition at line 178 of file DataSource.h.

const te::da::SQLDialect te::mem::DataSource::sm_dialect

staticprivate

A dummy dialect.

Definition at line 179 of file DataSource.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/src/terralib/memory/DataSource.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation