Namespace for the DataAccess API of TerraLib. More...

Classes
class	AbstractConnectionPool
	This class defines the basic interface for a connection pool. More...

class	Add
	The addition operator. More...

class	And
	Boolean logic operator: AND. More...

class	AttributeConverterManager
	A singleton to keep all the registered Attribute Converters. More...

struct	AttributeRestriction
	A struct that represents an attribute restriction. More...

class	AttributeRestrictionVisitor
	A visitor that retrieves attribute restrictions from a Query hierarchy. More...

class	Avg
	Avg statistical function. More...

class	BatchExecutor
	A class that models an object that submits commands in batch to the data source. More...

class	BinaryFunction
	A base class for binary functions. More...

class	BinaryOp
	A base class for binary operations. More...

class	BinaryOpEncoder
	A query encoder for binary operations. More...

class	Cast
	Cast a expression function. More...

struct	CharEncodingConverter

class	CheckConstraint
	A class that describes a check constraint. More...

class	Coalesce
	Coalesce operator. More...

class	Constraint

class	Count
	Count statistical function. More...

class	DataSet
	A dataset is the unit of information manipulated by the data access module of TerraLib. More...

class	DataSetAdapter
	An adapter for DataSet. More...

class	DataSetCapabilities
	A class that informs what the dataset implementation of a given data source can perform. More...

class	DataSetName
	A class that models the name of a dataset used in a From clause. More...

class	DataSetType
	A class that models the description of a dataset. More...

class	DataSetTypeCapabilities
	A class that informs what kind of constraint and index is supported by a given data source. More...

class	DataSetTypeConverter
	An converter for DataSetType. More...

class	DataSource
	An abstract class for data providers like a DBMS, Web Services or a regular file. More...

class	DataSourceCapabilities
	A class that represents the known capabilities of a specific data source, i.e. this class informs all information about what 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. More...

class	DataSourceCatalog
	It represents the system catalog of a DataSource. More...

class	DataSourceCatalogManager
	This is a singleton for managing all the data source catalog instances available in the system. More...

class	DataSourceFactory
	A factory for data sources. More...

class	DataSourceInfo
	A class that represents a data source component. More...

class	DataSourceInfoManager
	A singleton to keep all the registered data sources. More...

class	DataSourceManager
	This is a singleton for managing all data source instances available in the system. More...

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

class	DataTypeCapabilities
	A class that represents the supported data types of a specific data source. More...

class	Div
	The division operator. More...

class	EqualTo
	It models the comparison operator. More...

class	Expression
	This is an abstract class that models a query expression. More...

class	Field
	The Field class can be used to model an expression that takes part of the output items of a SELECT. More...

class	FilteredDataSet
	This class represents a filtered data set. More...

class	ForeignKey
	It models a foreign key constraint for a DataSetType. More...

class	FromFunctionCall
	A Select can be used as a source of information in another query. More...

class	FromItem
	An abstract class that models a source of data in a query. More...

class	Function
	A class that models a Function expression. More...

class	FunctionCatalog
	A FunctionCatalog can be used to keep track of registered functions. More...

class	FunctionCatalogManager
	A FunctionCatalogManager is a singleton that can be used to manage function catalogs of data source implementations. More...

class	FunctionDefn
	The definition of a function that can be used in a query object. More...

class	FunctionEncoder
	An SQL encoder for general function expressions. More...

class	FunctionNames
	A static class with global function name definitions. More...

class	FunctionNoArgsEncoder
	An SQL encoder for functions with no arguments that is invoked just by its name. More...

class	FunctionParameter
	A FunctionParameter models the parameter of a function definition. More...

class	GreaterThan
	It models the inequality operator greater than (>). More...

class	GreaterThanOrEqualTo
	It models the inequality operator greater than or equal to (>=). More...

class	GroupByItem
	A class that can be used in a GROUP BY clause. More...

class	Having
	A class that can be used to model a filter expression that can be applied to a query. More...

class	In
	A class that represents the IN operator. More...

class	Index
	It describes an index associated to a DataSetType. More...

class	Insert
	The Insert object can add the return of a select object. More...

class	IsNull
	Tells if a value is NULL. More...

class	Join
	A Join clause combines two FromItems. More...

class	JoinCondition
	A condition to be used in a Join clause. More...

class	JoinConditionOn
	JoinConditionOn is a boolean expression and it specifies which items in a join are considered to match. More...

class	JoinConditionUsing
	JoinConditionUsing class can be used to model a USING clause in a Join. More...

class	LessThan
	It models the inequality operator less than (<). More...

class	LessThanOrEqualTo
	It models the inequality operator less than or equal to (<=). More...

class	Like
	It is intended to encode a character string comparison operator with pattern matching. More...

class	Literal
	This class models a literal value. More...

class	LiteralBool
	This class models a bool Literal value. More...

class	LiteralByteArray
	A class that models a literal for ByteArray values. More...

class	LiteralDateTime
	A class that models a literal for Date and Time values. More...

class	LiteralDouble
	A class that models a literal for double values. More...

class	LiteralEnvelope
	A class that models a literal for Envelope values. More...

class	LiteralGeom
	A class that models a literal for Geometry values. More...

class	LiteralInt16

class	LiteralInt32

class	LiteralInt64

class	LiteralString
	This class models a string Literal value. More...

class	Max
	Max statistical function. More...

class	Min
	Min statistical function. More...

class	Module
	This singleton defines the TerraLib Data Access module entry. More...

class	Mul
	The multiply operator. More...

class	Not
	Boolean NOT operator. More...

class	NotEqualTo
	Tells if two values are not equal. More...

class	ObjectId
	This class represents an unique id for a data set element. More...

class	ObjectIdSet
	This class represents a set of unique ids created in the same context. i.e. from the same data set. More...

class	Or

class	OrderByItem
	A class that can be used in an ORDER BY clause to sort the items of a resulting query. More...

class	PreparedQuery
	A class that model a prepared query. More...

class	PrimaryKey
	It describes a primary key (pk) constraint. More...

class	PropertyName
	A class that models the name of any property of an object. More...

class	Query
	A Query is independent from the data source language/dialect. More...

class	QueryCapabilities
	A class that informs the query support of a given data source. More...

class	QueryVisitor
	A visitor interface for the Query hierarchy. More...

class	ScopedTransaction
	An utility class to coordinate transactions. More...

class	Select
	A Select models a query to be used when retrieving data from a DataSource. More...

class	SelectExpression
	A Select can be used as a source of information in another query. More...

class	Sequence
	It describes a sequence (a number generator). More...

class	SpatialQueryProcessor
	A basic query processor for spatial restrictions. More...

struct	SpatialRestriction
	A struct that represents a spatial restriction. More...

class	SpatialRestrictionVisitor
	A visitor for retrieves spatial restrictions from a Query hierarchy. More...

class	SQLDialect
	It represents the SQL query dialect accepted by a given data source. More...

class	SQLFunctionEncoder
	A base class for encoders of SQL function expressions. More...

class	SQLVisitor
	A visitor for building an SQL statement from a given Query hierarchy. More...

struct	SRIDAssociation

class	ST_Area
	Spatial area operator. More...

class	ST_Beyond
	Spatial Distance Buffer Beyond operator. More...

class	ST_Boundary
	ST_Boundary statistical function. More...

class	ST_Buffer
	Spatial Buffer operator. More...

class	ST_Centroid
	Spatial centroid operator. More...

class	ST_Collect
	ST_Collect statistical function. More...

class	ST_Contains
	Spatial contains operator. More...

class	ST_ConvexHull

class	ST_Crosses
	Spatial crosses operator. More...

class	ST_Difference
	Spatial difference operator. More...

class	ST_Disjoint
	Spatial Disjoint operator. More...

class	ST_DistanceBuffer
	Spatial Distance Buffer operator. More...

class	ST_Dump
	ST_Dump statistical function. More...

class	ST_DumpRings
	ST_DumpRings statistical function. More...

class	ST_DWithin
	Spatial Distance Buffer Within operator. More...

class	ST_Envelope
	Spatial envelope operator. More...

class	ST_EnvelopeIntersects
	An operator that considers the intersection among approximations or envelopes of geometries. More...

class	ST_Equals
	Spatial equals operator. More...

class	ST_Intersection
	Spatial intersection operator. More...

class	ST_Intersects
	Spatial intersects operator. More...

class	ST_IsEmpty
	Spatial is empty operator. More...

class	ST_IsValid
	Spatial is valid operator. More...

class	ST_Length
	Spatial length operator. More...

class	ST_MakePolygon
	ST_MakePolygon statistical function. More...

class	ST_MakeValid
	Spatial operator that tries to make geometry valid. More...

class	ST_Multi
	Spatial multi operator. More...

class	ST_NumGeometries
	ST_NumGeometries statistical function. More...

class	ST_Overlaps
	Spatial overlaps operator. More...

class	ST_Perimeter
	Spatial perimeter operator. More...

class	ST_Relate
	Spatial relation function. More...

class	ST_SetSRID
	Spatial Set SRID operator. More...

class	ST_Touches
	Spatial touches operator. More...

class	ST_Transform

class	ST_Union
	ST_Union statistical function. More...

class	ST_Within
	Spatial within operator. More...

class	StdDev
	StdDev statistical function. More...

class	Sub
	The subtraction operator. More...

class	SubSelect
	A Select can be used as a source of information in another query. More...

class	Substring
	Allows the extraction of substrings. More...

class	Sum
	Sum aggregate operator. More...

class	TemplateEncoder
	A query encoder for binary operator expressions. More...

class	UnaryFunction
	A base class for unary functions. More...

class	UnaryOp
	A base class for unary operators. More...

class	UnaryOpEncoder
	A query encoder for unary operator expressions. More...

class	UniqueKey
	It describes a unique key (uk) constraint. More...

class	Variance
	Variance statistical function. More...

class	Where
	A class that can be used to model a filter expression that can be applied to a query. More...

Typedefs
typedef boost::function3< te::dt::AbstractData , DataSet , const std::vector< std::size_t > &, int >	AttributeConverter
	The type of attribute converter functions. More...

typedef boost::shared_ptr< DataSet >	DataSetPtr

typedef boost::shared_ptr< DataSetType >	DataSetTypePtr

typedef boost::shared_ptr< DataSourceCatalog >	DataSourceCatalogPtr

typedef boost::shared_ptr< DataSourceInfo >	DataSourceInfoPtr

typedef boost::shared_ptr< DataSource >	DataSourcePtr

typedef boost::shared_ptr< DataSourceTransactor >	DataSourceTransactorPtr

typedef boost::ptr_vector< Expression >	Distinct
	A class that models a Distinct clause on a query. More...

typedef boost::ptr_vector< Field >	Fields
	Fields is just a boost::ptr_vector of Field pointers. More...

typedef boost::ptr_vector< FromItem >	From
	It models the FROM clause for a query. More...

typedef boost::ptr_vector< GroupByItem >	GroupBy
	A class that can be used to model a GROUP BY clause. More...

typedef boost::ptr_vector< OrderByItem >	OrderBy
	A class that can be used to model an ORDER BY clause. More...

Enumerations
enum	{ UNKNOWN_DATASET_TYPE, TABLE_TYPE, SYSTEM_TABLE_TYPE, VIEW_TYPE, QUERY_TYPE, INDEX_TYPE, SEQUENCE_TYPE, TRIGGER_TYPE, REGULAR_FILE_TYPE }
	An anonymous enum with the type of datasets retrieved from data sources. More...

enum	ConstraintType { UNKNOWN, PRIMARY_KEY, FOREIGN_KEY, UNIQUE_KEY, CHECK }
	A ConstraintType can have one of the following types: More...

enum	FKActionType { NO_ACTION, RESTRICT, CASCADE, SET_NULL, SET_DEFAULT }
	Type of action performed on the foreign key data. More...

enum	IndexType { B_TREE_TYPE, R_TREE_TYPE, QUAD_TREE_TYPE, HASH_TYPE }
	Index type. More...

enum	JoinType { JOIN, INNER_JOIN, LEFT_JOIN, RIGHT_JOIN, FULL_OUTER_JOIN, CROSS_JOIN, NATURAL_JOIN }
	The type of join in a query. More...

enum	SortOrder { DESC, ASC }
	Sort order type: asc or desc. More...

Functions
TEDATAACCESSEXPORT void	AssociateDataSetTypeConverterSRID (DataSetTypeConverter *converter, const int &inputSRID, const int &outputSRID=TE_UNKNOWN_SRS)

TEDATAACCESSEXPORT std::auto_ptr< Fields >	BuildFields (const std::vector< std::string > &properties)

TEDATAACCESSEXPORT std::auto_ptr< Select >	BuildSelect (const std::string &dsname)

TEDATAACCESSEXPORT std::auto_ptr< Select >	BuildSelect (const std::string &dsname, const std::string &propertyName)

TEDATAACCESSEXPORT std::auto_ptr< Select >	BuildSelect (const std::string &dsname, const std::vector< std::string > &properties)

TEDATAACCESSEXPORT std::auto_ptr< Select >	BuildSelect (const std::string &dsname, const std::vector< std::string > &properties, const std::string &geometryProperty, const te::gm::Envelope *e, int srid, te::gm::SpatialRelation r)

TEDATAACCESSEXPORT std::auto_ptr< Select >	BuildSelect (const std::string &dsname, const std::vector< std::string > &properties, const std::string &geometryProperty, te::gm::Geometry *g, te::gm::SpatialRelation r)

TEDATAACCESSEXPORT std::auto_ptr< Select >	BuildSelect (const std::string &dsname, const std::vector< std::string > &properties, const ObjectIdSet *oids)

TEDATAACCESSEXPORT std::auto_ptr< Expression >	BuildSpatialOp (Expression e1, Expression e2, te::gm::SpatialRelation r)

TEDATAACCESSEXPORT void	Create (DataSource ds, DataSetType dt, DataSet *d, std::size_t limit=0)
	It creates the dataset definition in a data source and then fill it with data from the input dataset. More...

TEDATAACCESSEXPORT void	Create (DataSource ds, DataSetType dt, DataSet *d, const std::map< std::string, std::string > &options, std::size_t limit=0)
	It creates the dataset definition in a data source and then fill it with data from the input dataset. More...

TEDATAACCESSEXPORT DataSetAdapter *	CreateAdapter (DataSet ds, DataSetTypeConverter converter, bool isOwner=false)

TEDATAACCESSEXPORT ObjectId *	GenerateOID (DataSet *dataset, const std::vector< std::string > &names)

TEDATAACCESSEXPORT ObjectIdSet *	GenerateOIDSet (DataSet dataset, const DataSetType type)

TEDATAACCESSEXPORT ObjectIdSet *	GenerateOIDSet (DataSet *dataset, const std::vector< std::string > &names)

TEDATAACCESSEXPORT te::dt::AbstractData *	GenericAttributeConverter (DataSet *dataset, const std::vector< std::size_t > &indexes, int dstType)

TEDATAACCESSEXPORT std::string	getBasePkey (te::da::ObjectId *oid, std::pair< std::string, int > &dsProps)

TEDATAACCESSEXPORT DataSet *	GetDataSet (const std::string &name, const std::string &datasourceId)

TEDATAACCESSEXPORT std::string	GetDataSetCategoryName (int category)

TEDATAACCESSEXPORT void	GetDataSetNames (std::vector< std::string > &datasetNames, const std::string &datasourceId)

TEDATAACCESSEXPORT DataSetType *	GetDataSetType (const std::string &name, const std::string &datasourceId)

TEDATAACCESSEXPORT DataSourcePtr	GetDataSource (const std::string &datasourceId, const bool opened=true)
	Search for a data source with the informed id in the DataSourceManager. More...

TEDATAACCESSEXPORT void	GetEmptyOIDSet (const DataSetType type, ObjectIdSet &set)
	Returns an empty ObjectIdSet, with the definitions of fields that compose it. More...

TEDATAACCESSEXPORT te::gm::Envelope *	GetExtent (const std::string &datasetName, const std::string &propertyName, const std::string &datasourceId)

TEDATAACCESSEXPORT te::gm::GeometryProperty *	GetFirstGeomProperty (const DataSetType *dt)

TEDATAACCESSEXPORT std::size_t	GetFirstPropertyPos (const te::da::DataSet *dataset, int datatype)

TEDATAACCESSEXPORT te::rst::RasterProperty *	GetFirstRasterProperty (const DataSetType *dt)

TEDATAACCESSEXPORT te::dt::Property *	GetFirstSpatialProperty (const DataSetType *dt)

TEDATAACCESSEXPORT std::size_t	GetFirstSpatialPropertyPos (const te::da::DataSet *dataset)
	It returns the first dataset spatial property or NULL if none is found. More...

TEDATAACCESSEXPORT void	GetOIDDatasetProps (const DataSetType *type, std::pair< std::string, int > &dsProps)

TEDATAACCESSEXPORT void	GetOIDPropertyNames (const DataSetType *type, std::vector< std::string > &pnames)

TEDATAACCESSEXPORT void	GetOIDPropertyPos (const DataSetType *type, std::vector< std::size_t > &ppos)

TEDATAACCESSEXPORT std::vector< int >	GetPropertyDataTypes (const te::da::DataSet *dataset)

TEDATAACCESSEXPORT int	GetPropertyIndex (te::da::DataSet *dataSet, const std::string propName)

TEDATAACCESSEXPORT void	GetPropertyInfo (const DataSetType *const dt, std::vector< std::string > &pnames, std::vector< int > &ptypes)

TEDATAACCESSEXPORT void	GetPropertyInfo (const DataSet *const dataset, std::vector< std::string > &pnames, std::vector< int > &ptypes)

TEDATAACCESSEXPORT std::size_t	GetPropertyPos (const DataSet *dataset, const std::string &name)

TEDATAACCESSEXPORT std::size_t	GetPropertyPos (const DataSetType *dt, const std::string &name)

TEDATAACCESSEXPORT std::string	GetSQLValueNames (const DataSetType *dt)

TEDATAACCESSEXPORT std::string	GetSQLValueNames (const DataSet *dataset)

TEDATAACCESSEXPORT double	GetSummarizedValue (std::vector< double > &values, const std::string &summary)
	It gets the summarized value. More...

TEDATAACCESSEXPORT std::string	GetSummarizedValue (const std::vector< std::string > &values, const std::string &sumary)
	It gets the summarized value. More...

TEDATAACCESSEXPORT double	GetValueAsDouble (const te::da::DataSet *ds, const size_t pos)
	It gets the value as double. More...

TEDATAACCESSEXPORT bool	HasDataSet (const std::string &datasourceId)

TEDATAACCESSEXPORT bool	HasLinkedTable (te::da::DataSetType *type)
	It checks if the datasettype has a linked table. More...

TEDATAACCESSEXPORT std::auto_ptr< te::da::DataSet >	HideColumns (te::da::DataSet ds, te::da::DataSetType dst, const std::vector< std::string > &columns)
	It hide columns of a DataSet using DataSetAdapter. More...

TEDATAACCESSEXPORT bool	IsValidName (const std::string &name, std::string &invalidChar)
	It checks if the name is not valid as the existence of invalid characters, reserved words, and others. More...

TEDATAACCESSEXPORT void	LoadFull (te::da::DataSetType *dataset, const std::string &datasourceId)

TEDATAACCESSEXPORT void	LoadProperties (te::da::DataSetType *dataset, const std::string &datasourceId)

JoinCondition *	new_clone (const JoinCondition &a)
	For use with boost conteiners. More...

Query *	new_clone (const Query &a)
	For use with boost conteiners. More...

Expression *	new_clone (const Expression &a)
	For use with boost conteiners. More...

FromItem *	new_clone (const FromItem &a)
	For use with boost conteiners. More...

TEDATAACCESSEXPORT te::dt::AbstractData *	PointToMConverter (DataSet *dataset, const std::vector< std::size_t > &indexes, int dstType)

TEDATAACCESSEXPORT te::dt::AbstractData *	PointToXConverter (DataSet *dataset, const std::vector< std::size_t > &indexes, int dstType)

TEDATAACCESSEXPORT te::dt::AbstractData *	PointToYConverter (DataSet *dataset, const std::vector< std::size_t > &indexes, int dstType)

TEDATAACCESSEXPORT te::dt::AbstractData *	PointToZConverter (DataSet *dataset, const std::vector< std::size_t > &indexes, int dstType)

TEDATAACCESSEXPORT double	Round (const double &value, const size_t &precision)
	It gets the round value. More...

TEDATAACCESSEXPORT te::dt::AbstractData *	TupleToStringConverter (DataSet *dataset, const std::vector< std::size_t > &indexes, int dstType)

TEDATAACCESSEXPORT te::dt::AbstractData *	XYMToPointConverter (DataSet *dataset, const std::vector< std::size_t > &indexes, int dstType)

TEDATAACCESSEXPORT te::dt::AbstractData *	XYToPointConverter (DataSet *dataset, const std::vector< std::size_t > &indexes, int dstType)

TEDATAACCESSEXPORT te::dt::AbstractData *	XYZMToPointConverter (DataSet *dataset, const std::vector< std::size_t > &indexes, int dstType)

TEDATAACCESSEXPORT te::dt::AbstractData *	XYZToPointConverter (DataSet *dataset, const std::vector< std::size_t > &indexes, int dstType)

Detailed Description

Namespace for the DataAccess API of TerraLib.

Typedef Documentation

typedef boost::function3<te::dt::AbstractData*, DataSet*, const std::vector<std::size_t>&, int> te::da::AttributeConverter

The type of attribute converter functions.

The functions following the typedef signature have:

type: e::dt::AbstractData*

input parameter: input data set (DataSet*)

input parameter: the position list of adapted properties in the input dataset (const std::vector<std::size_t>&)

input parameter: destination data type (int)

Definition at line 51 of file AttributeConverters.h.

typedef boost::shared_ptr<DataSet> te::da::DataSetPtr

Definition at line 668 of file DataSet.h.

typedef boost::shared_ptr< DataSetType > te::da::DataSetTypePtr

Definition at line 653 of file DataSetType.h.

typedef boost::shared_ptr<DataSourceCatalog> te::da::DataSourceCatalogPtr

Definition at line 493 of file DataSourceCatalog.h.

typedef boost::shared_ptr<DataSourceInfo> te::da::DataSourceInfoPtr

Definition at line 107 of file DataSourceInfo.h.

typedef boost::shared_ptr<DataSource> te::da::DataSourcePtr

Definition at line 1438 of file DataSource.h.

typedef boost::shared_ptr<DataSourceTransactor> te::da::DataSourceTransactorPtr

Definition at line 1240 of file DataSourceTransactor.h.

typedef boost::ptr_vector<Expression> te::da::Distinct

A class that models a Distinct clause on a query.

Definition at line 37 of file Distinct.h.

typedef boost::ptr_vector<Field> te::da::Fields

Fields is just a boost::ptr_vector of Field pointers.

Definition at line 37 of file Fields.h.

typedef boost::ptr_vector<FromItem> te::da::From

It models the FROM clause for a query.

Definition at line 37 of file From.h.

typedef boost::ptr_vector<GroupByItem> te::da::GroupBy

A class that can be used to model a GROUP BY clause.

Definition at line 37 of file GroupBy.h.

typedef boost::ptr_vector<OrderByItem> te::da::OrderBy

A class that can be used to model an ORDER BY clause.

Definition at line 37 of file OrderBy.h.

Enumeration Type Documentation

anonymous enum

An anonymous enum with the type of datasets retrieved from data sources.

Enumerator
UNKNOWN_DATASET_TYPE
TABLE_TYPE
SYSTEM_TABLE_TYPE
VIEW_TYPE
QUERY_TYPE
INDEX_TYPE
SEQUENCE_TYPE
TRIGGER_TYPE
REGULAR_FILE_TYPE

Definition at line 75 of file Enums.h.

enum te::da::ConstraintType

A ConstraintType can have one of the following types:

Enumerator
UNKNOWN	Used when the constraint type is unknown.
PRIMARY_KEY	Primary key constraint.
FOREIGN_KEY	Foreign key constraint.
UNIQUE_KEY	Unique key constraint.
CHECK	Check constraint.

Definition at line 65 of file Enums.h.

enum te::da::FKActionType

Type of action performed on the foreign key data.

Enumerator
NO_ACTION	Indicates that the deletion or update would create a foreign key constraint violation.
RESTRICT	Indicates that the deletion or update would create a foreign key constraint violation.
CASCADE	Delete any rows referencing the deleted row, or update the value of the referencing column to the new value of the referenced column, respectively.
SET_NULL	Set the referencing column(s) to null.
SET_DEFAULT	Set the referencing column(s) to their default values.

Definition at line 93 of file Enums.h.

enum te::da::IndexType

Index type.

Enumerator
B_TREE_TYPE	Btree index type.
R_TREE_TYPE	RTree index type.
QUAD_TREE_TYPE	QuadTree index type.
HASH_TYPE	Hash index type.

Definition at line 107 of file Enums.h.

enum te::da::JoinType

The type of join in a query.

Enumerator
JOIN	...
INNER_JOIN	...
LEFT_JOIN	left-outer-join
RIGHT_JOIN	right-outer-jin...
FULL_OUTER_JOIN	full-outer-jon...
CROSS_JOIN	...
NATURAL_JOIN	...

Definition at line 49 of file Enums.h.

enum te::da::SortOrder

Sort order type: asc or desc.

Enumerator
DESC	Descendent order type.
ASC	Ascendent order type.

Definition at line 38 of file Enums.h.

Function Documentation

TEDATAACCESSEXPORT void te::da::AssociateDataSetTypeConverterSRID	(	DataSetTypeConverter *	converter,
		const int &	inputSRID,
		const int &	outputSRID = `TE_UNKNOWN_SRS`
	)

TEDATAACCESSEXPORT std::auto_ptr<Fields> te::da::BuildFields ( const std::vector< std::string > & properties )

TEDATAACCESSEXPORT std::auto_ptr<Select> te::da::BuildSelect ( const std::string & dsname )

TEDATAACCESSEXPORT std::auto_ptr<Select> te::da::BuildSelect	(	const std::string &	dsname,
		const std::string &	propertyName
	)

TEDATAACCESSEXPORT std::auto_ptr<Select> te::da::BuildSelect	(	const std::string &	dsname,
		const std::vector< std::string > &	properties
	)

TEDATAACCESSEXPORT std::auto_ptr<Select> te::da::BuildSelect	(	const std::string &	dsname,
		const std::vector< std::string > &	properties,
		const std::string &	geometryProperty,
		const te::gm::Envelope *	e,
		int	srid,
		te::gm::SpatialRelation	r
	)

TEDATAACCESSEXPORT std::auto_ptr<Select> te::da::BuildSelect	(	const std::string &	dsname,
		const std::vector< std::string > &	properties,
		const std::string &	geometryProperty,
		te::gm::Geometry *	g,
		te::gm::SpatialRelation	r
	)

TEDATAACCESSEXPORT std::auto_ptr<Select> te::da::BuildSelect	(	const std::string &	dsname,
		const std::vector< std::string > &	properties,
		const ObjectIdSet *	oids
	)

TEDATAACCESSEXPORT std::auto_ptr<Expression> te::da::BuildSpatialOp	(	Expression *	e1,
		Expression *	e2,
		te::gm::SpatialRelation	r
	)

TEDATAACCESSEXPORT void te::da::Create	(	DataSource *	ds,
		DataSetType *	dt,
		DataSet *	d,
		std::size_t	limit = `0`
	)

It creates the dataset definition in a data source and then fill it with data from the input dataset.

This function will create the dataset schema definition and will save all the dataset data.

Parameters

t	The data source transactor.
dt	The source dataset definition.
d	The source dataset data.
limit	The number of items to be used from the input dataset. If set to 0 (default) all items are used.

Precondition: All parameters must be valid pointers.

Postcondition: It is the caller responsability to release the dataset 'd' pointer.

Exceptions

Exception It throws an exception if the dataset can not be created.

Note: DataSetPersistence will start reading the dataset 'd' in the current position. So, keep in mind that it is the caller responsability to inform the dataset 'd' in the right position (and a valid one) to start processing it.

TEDATAACCESSEXPORT void te::da::Create	(	DataSource *	ds,
		DataSetType *	dt,
		DataSet *	d,
		const std::map< std::string, std::string > &	options,
		std::size_t	limit = `0`
	)

It creates the dataset definition in a data source and then fill it with data from the input dataset.

This method will create the dataset schema definition and will save all the dataset data.

Parameters

dt	The source dataset definition.
d	The source dataset data.
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.

Precondition: All parameters must be valid pointers.

Exceptions

Exception It throws an exception if the dataset can not be created.

Note: It is the caller responsability to release the dataset 'd' pointer.; DataSetPersistence will start reading the dataset 'd' in the current position. So, keep in mind that it is the caller responsability to inform the dataset 'd' in the right position (and a valid one) to start processing it.

TEDATAACCESSEXPORT DataSetAdapter* te::da::CreateAdapter	(	DataSet *	ds,
		DataSetTypeConverter *	converter,
		bool	isOwner = `false`
	)

TEDATAACCESSEXPORT ObjectId* te::da::GenerateOID	(	DataSet *	dataset,
		const std::vector< std::string > &	names
	)

TEDATAACCESSEXPORT ObjectIdSet* te::da::GenerateOIDSet	(	DataSet *	dataset,
		const DataSetType *	type
	)

TEDATAACCESSEXPORT ObjectIdSet* te::da::GenerateOIDSet	(	DataSet *	dataset,
		const std::vector< std::string > &	names
	)

TEDATAACCESSEXPORT te::dt::AbstractData* te::da::GenericAttributeConverter	(	DataSet *	dataset,
		const std::vector< std::size_t > &	indexes,
		int	dstType
	)

TEDATAACCESSEXPORT std::string te::da::getBasePkey	(	te::da::ObjectId *	oid,
		std::pair< std::string, int > &	dsProps
	)

TEDATAACCESSEXPORT DataSet* te::da::GetDataSet	(	const std::string &	name,
		const std::string &	datasourceId
	)

TEDATAACCESSEXPORT std::string te::da::GetDataSetCategoryName ( int category )

TEDATAACCESSEXPORT void te::da::GetDataSetNames	(	std::vector< std::string > &	datasetNames,
		const std::string &	datasourceId
	)

TEDATAACCESSEXPORT DataSetType* te::da::GetDataSetType	(	const std::string &	name,
		const std::string &	datasourceId
	)

TEDATAACCESSEXPORT DataSourcePtr te::da::GetDataSource	(	const std::string &	datasourceId,
		const bool	opened = `true`
	)

Search for a data source with the informed id in the DataSourceManager.

If the data source is not found in that manager it will try to get some information in the DataSourceInfoManager and will create a new data source instance, storing a reference to the new data source in the manager.

Parameters

datasourceId	The data source to look for.
opened	Automatically open the data source.

Returns: A data source with the informed id.

Exceptions

Exception It throws an exception if the informed data source could not be retrieved.

TEDATAACCESSEXPORT void te::da::GetEmptyOIDSet	(	const DataSetType *	type,
		ObjectIdSet *&	set
	)

Returns an empty ObjectIdSet, with the definitions of fields that compose it.

Parameters

type[in]	A pointer to a valid data set type. Do not pass null.
set[out]	The ObjectIdSet containing only the the fields definitions. This pointer will be instantiated inside the method.

Note: The caller WILL TAKE the ownership of set.

TEDATAACCESSEXPORT te::gm::Envelope* te::da::GetExtent	(	const std::string &	datasetName,
		const std::string &	propertyName,
		const std::string &	datasourceId
	)

Returns: The data extent considering the informed property. The caller will take the ownership of the returned box.

Exceptions

Exception It throws an exception if the extent can not be determined.

TEDATAACCESSEXPORT te::gm::GeometryProperty* te::da::GetFirstGeomProperty ( const DataSetType * dt )

TEDATAACCESSEXPORT std::size_t te::da::GetFirstPropertyPos	(	const te::da::DataSet *	dataset,
		int	datatype
	)

TEDATAACCESSEXPORT te::rst::RasterProperty* te::da::GetFirstRasterProperty ( const DataSetType * dt )

TEDATAACCESSEXPORT te::dt::Property* te::da::GetFirstSpatialProperty ( const DataSetType * dt )

TEDATAACCESSEXPORT std::size_t te::da::GetFirstSpatialPropertyPos ( const te::da::DataSet * dataset )

It returns the first dataset spatial property or NULL if none is found.

Parameters

dataset The dataset to search for a spatial property.

Returns: The first dataset spatial property or NULL if none is found.

TEDATAACCESSEXPORT void te::da::GetOIDDatasetProps	(	const DataSetType *	type,
		std::pair< std::string, int > &	dsProps
	)

TEDATAACCESSEXPORT void te::da::GetOIDPropertyNames	(	const DataSetType *	type,
		std::vector< std::string > &	pnames
	)

TEDATAACCESSEXPORT void te::da::GetOIDPropertyPos	(	const DataSetType *	type,
		std::vector< std::size_t > &	ppos
	)

TEDATAACCESSEXPORT std::vector<int> te::da::GetPropertyDataTypes ( const te::da::DataSet * dataset )

TEDATAACCESSEXPORT int te::da::GetPropertyIndex	(	te::da::DataSet *	dataSet,
		const std::string	propName
	)

TEDATAACCESSEXPORT void te::da::GetPropertyInfo	(	const DataSetType *const	dt,
		std::vector< std::string > &	pnames,
		std::vector< int > &	ptypes
	)

TEDATAACCESSEXPORT void te::da::GetPropertyInfo	(	const DataSet *const	dataset,
		std::vector< std::string > &	pnames,
		std::vector< int > &	ptypes
	)

TEDATAACCESSEXPORT std::size_t te::da::GetPropertyPos	(	const DataSet *	dataset,
		const std::string &	name
	)

TEDATAACCESSEXPORT std::size_t te::da::GetPropertyPos	(	const DataSetType *	dt,
		const std::string &	name
	)

TEDATAACCESSEXPORT std::string te::da::GetSQLValueNames ( const DataSetType * dt )

TEDATAACCESSEXPORT std::string te::da::GetSQLValueNames ( const DataSet * dataset )

TEDATAACCESSEXPORT double te::da::GetSummarizedValue	(	std::vector< double > &	values,
		const std::string &	summary
	)

It gets the summarized value.

Parameters

values	The input values.
summary	The summary mode. It can be: "MIN", "MAX", "SUM", "AVERAGE", "MEDIAN", "STDDEV" or "VARIANCE"

Returns: The summarized value.

TEDATAACCESSEXPORT std::string te::da::GetSummarizedValue	(	const std::vector< std::string > &	values,
		const std::string &	sumary
	)

It gets the summarized value.

Parameters

values	The input values.
summary	The summary mode. It can be: "MIN" or "MAX"

Returns: The summarized value.

TEDATAACCESSEXPORT double te::da::GetValueAsDouble	(	const te::da::DataSet *	ds,
		const size_t	pos
	)

It gets the value as double.

Parameters

ds	The input dataset.
pos	The column position.

Returns: The double value. Default value is 0.

TEDATAACCESSEXPORT bool te::da::HasDataSet ( const std::string & datasourceId )

TEDATAACCESSEXPORT bool te::da::HasLinkedTable ( te::da::DataSetType * type )

It checks if the datasettype has a linked table.

Parameters

type	The Datasettype.

Returns: True if has linked table.

TEDATAACCESSEXPORT std::auto_ptr<te::da::DataSet> te::da::HideColumns	(	te::da::DataSet *	ds,
		te::da::DataSetType *	dst,
		const std::vector< std::string > &	columns
	)

It hide columns of a DataSet using DataSetAdapter.

Parameters

ds	The DataSet that will have hidden columns.
dst	The DataSetType used to hide columns.
columns	names to be hidden.

Returns: The DataSet result. The caller will take the ownership of the returned DataSet.

TEDATAACCESSEXPORT bool te::da::IsValidName	(	const std::string &	name,
		std::string &	invalidChar
	)

It checks if the name is not valid as the existence of invalid characters, reserved words, and others.

Parameters

name	Name that will be checked.
invalidChar	Records the invalid character.

Returns: If the name is valid.

TEDATAACCESSEXPORT void te::da::LoadFull	(	te::da::DataSetType *	dataset,
		const std::string &	datasourceId
	)

TEDATAACCESSEXPORT void te::da::LoadProperties	(	te::da::DataSetType *	dataset,
		const std::string &	datasourceId
	)

JoinCondition* te::da::new_clone ( const JoinCondition & a )

inline

For use with boost conteiners.

Definition at line 61 of file JoinCondition.h.

References te::da::JoinCondition::clone().

Query* te::da::new_clone ( const Query & a )

inline

For use with boost conteiners.

Definition at line 63 of file Query.h.

References te::da::Query::clone().

Expression* te::da::new_clone ( const Expression & a )

inline

For use with boost conteiners.

Definition at line 64 of file Expression.h.

References te::da::Expression::clone().

FromItem* te::da::new_clone ( const FromItem & a )

inline

For use with boost conteiners.

Definition at line 97 of file FromItem.h.

References te::da::FromItem::clone().

TEDATAACCESSEXPORT te::dt::AbstractData* te::da::PointToMConverter	(	DataSet *	dataset,
		const std::vector< std::size_t > &	indexes,
		int	dstType
	)

TEDATAACCESSEXPORT te::dt::AbstractData* te::da::PointToXConverter	(	DataSet *	dataset,
		const std::vector< std::size_t > &	indexes,
		int	dstType
	)

TEDATAACCESSEXPORT te::dt::AbstractData* te::da::PointToYConverter	(	DataSet *	dataset,
		const std::vector< std::size_t > &	indexes,
		int	dstType
	)

TEDATAACCESSEXPORT te::dt::AbstractData* te::da::PointToZConverter	(	DataSet *	dataset,
		const std::vector< std::size_t > &	indexes,
		int	dstType
	)

TEDATAACCESSEXPORT double te::da::Round	(	const double &	value,
		const size_t &	precision
	)

It gets the round value.

Parameters

value The input value.

Returns: The rounded value.

TEDATAACCESSEXPORT te::dt::AbstractData* te::da::TupleToStringConverter	(	DataSet *	dataset,
		const std::vector< std::size_t > &	indexes,
		int	dstType
	)

TEDATAACCESSEXPORT te::dt::AbstractData* te::da::XYMToPointConverter	(	DataSet *	dataset,
		const std::vector< std::size_t > &	indexes,
		int	dstType
	)

TEDATAACCESSEXPORT te::dt::AbstractData* te::da::XYToPointConverter	(	DataSet *	dataset,
		const std::vector< std::size_t > &	indexes,
		int	dstType
	)

TEDATAACCESSEXPORT te::dt::AbstractData* te::da::XYZMToPointConverter	(	DataSet *	dataset,
		const std::vector< std::size_t > &	indexes,
		int	dstType
	)

TEDATAACCESSEXPORT te::dt::AbstractData* te::da::XYZToPointConverter	(	DataSet *	dataset,
		const std::vector< std::size_t > &	indexes,
		int	dstType
	)

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation