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

#include <DataSet.h>

Inheritance diagram for te::da::DataSet:

Public Member Functions
	DataSet ()
	Default constructor. More...

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

DataSet Methods
Methods for obtaining information about a given dataset.
virtual te::common::TraverseType	getTraverseType () const =0
	It returns the traverse type associated to the dataset. More...

virtual te::common::AccessPolicy	getAccessPolicy () const =0
	It returns the read and write permission associated to the dataset. More...

virtual std::size_t	getNumProperties () const =0
	It returns the number of properties that composes an item of the dataset. More...

virtual int	getPropertyDataType (std::size_t i) const =0
	It returns the underlying data type of the property at position pos. More...

virtual std::string	getPropertyName (std::size_t i) const =0
	It returns the property name at position pos. More...

virtual te::common::CharEncoding	getPropertyCharEncoding (std::size_t i) const =0
	It returns the property character encoding at position pos. More...

virtual std::string	getDatasetNameOfProperty (std::size_t i) const =0
	It returns the underlying dataset name of the property at position pos. More...

Collection Methods
Methods for getting/setting atomic datasets.
virtual bool	isEmpty () const =0
	It returns true if the collection is empty. More...

virtual bool	isConnected () const =0
	It returns true if the dataset is connected and false if it is disconnected. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source. More...

virtual std::size_t	size () const =0
	It returns the collection size, if it is known. More...

virtual std::auto_ptr< te::gm::Envelope >	getExtent (std::size_t i)=0
	It computes the bounding rectangle for a spatial property of the dataset. More...

virtual bool	moveNext ()=0
	It moves the internal pointer to the next item of the collection. More...

virtual bool	movePrevious ()=0
	It moves the internal pointer to the previous item of the collection. More...

virtual bool	moveBeforeFirst ()=0
	It moves the internal pointer to a position before the first item in the collection. More...

virtual bool	moveFirst ()=0
	It moves the internal pointer to the first item in the collection. More...

virtual bool	moveLast ()=0
	It sets the dataset internal pointer to the last item in the collection. More...

virtual bool	move (std::size_t i)=0
	It moves the dataset internal pointer to a given position. More...

virtual bool	isAtBegin () const =0
	It tells if the dataset internal pointer is on the first element of the collection or not. More...

virtual bool	isBeforeBegin () const =0
	It tells if the dataset internal pointer is in a position before the first element of the collection or not. More...

virtual bool	isAtEnd () const =0
	It tells if the dataset internal pointer is on the last element of the collection. More...

virtual bool	isAfterEnd () const =0
	It tells if the dataset internal pointer is on the sentinel position after the last element of the collection or not. More...

DataSet Element Properties
Methods for retrieving/setting the dataset item component values without the need to explicitly instantiate an item via getItem method.
virtual char	getChar (std::size_t i) const =0
	Method for retrieving a signed character attribute value (1 byte long). More...

virtual char	getChar (const std::string &name) const
	Method for retrieving a signed character attribute value (1 byte long). More...

virtual unsigned char	getUChar (std::size_t i) const =0
	Method for retrieving an unsigned character attribute value (1 byte long). More...

virtual unsigned char	getUChar (const std::string &name) const
	Method for retrieving an unsigned character attribute value (1 byte long). More...

virtual boost::int16_t	getInt16 (std::size_t i) const =0
	Method for retrieving a 16-bit integer attribute value (2 bytes long). More...

virtual boost::int16_t	getInt16 (const std::string &name) const
	Method for retrieving a 16-bit integer attribute value (2 bytes long). More...

virtual boost::int32_t	getInt32 (std::size_t i) const =0
	Method for retrieving a 32-bit integer attribute value (4 bytes long). More...

virtual boost::int32_t	getInt32 (const std::string &name) const
	Method for retrieving a 32-bit integer attribute value (4 bytes long). More...

virtual boost::int64_t	getInt64 (std::size_t i) const =0
	Method for retrieving a 64-bit integer attribute value (8 bytes long). More...

virtual boost::int64_t	getInt64 (const std::string &name) const
	Method for retrieving a 64-bit integer attribute value (8 bytes long). More...

virtual bool	getBool (std::size_t i) const =0
	Method for retrieving a boolean attribute value. More...

virtual bool	getBool (const std::string &name) const
	Method for retrieving a boolean attribute value. More...

virtual float	getFloat (std::size_t i) const =0
	Method for retrieving a float attribute value. More...

virtual float	getFloat (const std::string &name) const
	Method for retrieving a float attribute value. More...

virtual double	getDouble (std::size_t i) const =0
	Method for retrieving a double attribute value. More...

virtual double	getDouble (const std::string &name) const
	Method for retrieving a double attribute value. More...

virtual std::string	getNumeric (std::size_t i) const =0
	Method for retrieving a numeric attribute value. More...

virtual std::string	getNumeric (const std::string &name) const
	Method for retrieving a numeric attribute value. More...

virtual std::string	getString (std::size_t i) const =0
	Method for retrieving a string value attribute. More...

virtual std::string	getString (const std::string &name) const
	Method for retrieving a string attribute value. More...

virtual std::auto_ptr< te::dt::ByteArray >	getByteArray (std::size_t i) const =0
	Method for retrieving a byte array. More...

virtual std::auto_ptr< te::dt::ByteArray >	getByteArray (const std::string &name) const
	Method for retrieving a byte array. More...

virtual std::auto_ptr< te::gm::Geometry >	getGeometry (std::size_t i) const =0
	Method for retrieving a geometric attribute value. More...

virtual std::auto_ptr< te::gm::Geometry >	getGeometry (const std::string &name) const
	Method for retrieving a geometric attribute value. More...

virtual std::auto_ptr< te::rst::Raster >	getRaster (std::size_t i) const =0
	Method for retrieving a raster attribute value. More...

virtual std::auto_ptr< te::rst::Raster >	getRaster (const std::string &name) const
	Method for retrieving a raster attribute value. More...

virtual std::auto_ptr< te::dt::DateTime >	getDateTime (std::size_t i) const =0
	Method for retrieving a date and time attribute value. More...

virtual std::auto_ptr< te::dt::DateTime >	getDateTime (const std::string &name) const
	Method for retrieving a date and time attribute value. More...

virtual std::auto_ptr< te::dt::Array >	getArray (std::size_t i) const =0
	Method for retrieving an array. More...

virtual std::auto_ptr< te::dt::Array >	getArray (const std::string &name) const
	Method for retrieving an array. More...

virtual std::auto_ptr< te::dt::AbstractData >	getValue (std::size_t i) const
	Method for retrieving any other type of data value stored in the data source. More...

virtual std::auto_ptr< te::dt::AbstractData >	getValue (const std::string &name) const
	Method for retrieving any other type of data value stored in the data source. More...

virtual std::string	getAsString (std::size_t i, int precision=0) const
	Method for retrieving a data value as a string plain representation. More...

virtual std::string	getAsString (const std::string &name, int precision=0) const
	Method for retrieving a data value as a string plain representation. More...

virtual bool	isNull (std::size_t i) const =0
	It checks if the attribute value is NULL. More...

virtual bool	isNull (const std::string &name) const
	It checks if the attribute value is NULL. More...

Detailed Description

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

A dataset is a container for a data collection with an internal pointer pointing to a specific item in the collection. There are move methods that can be used to set the position of this internal pointer.

When the dataset is created, its internal pointer points to a sentinel location before the first item of the collection. So, in order to retrieve data from this collection one of the move methods must be called before.

Each item of the dataset is composed by any number of properties. You have special methods to query the property information (name, data type, constraints).

The individual value of a property of an item in the collection, can be retrieved by an appropriated get method. These methods retrieve the value by an integer index identifying the property position or by a string with the property name.

When the dataset is the result of a query involving several datasets, you can find out the dataset that gave the original dataset name of a specific property.

A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source.

See also: DataSource, DataSourceTransactor, DataSetType

Note: A geometric or raster property is represented just like any other data type.; Our design also allows a dataset to have multiple geometric or raster properties.

Definition at line 112 of file DataSet.h.

Constructor & Destructor Documentation

te::da::DataSet::DataSet ( )

inline

Default constructor.

Definition at line 117 of file DataSet.h.

virtual te::da::DataSet::~DataSet ( )

inlinevirtual

Virtual destructor.

Reimplemented in te::stmem::DataSet, te::mem::DataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::ado::DataSet, and te::gdal::DataSet.

Definition at line 120 of file DataSet.h.

Member Function Documentation

virtual te::common::AccessPolicy te::da::DataSet::getAccessPolicy ( ) const

pure virtual

It returns the read and write permission associated to the dataset.

Returns: The read and write permission associated to the dataset.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::auto_ptr<te::dt::Array> te::da::DataSet::getArray ( std::size_t i ) const

pure virtual

Method for retrieving an array.

Parameters

i	The attribute index.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::gdal::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::auto_ptr<te::dt::Array> te::da::DataSet::getArray ( const std::string & name ) const

virtual

Method for retrieving an array.

Parameters

name	The attribute name.

Returns: An array. The caller will take its ownership.

Reimplemented in te::gdal::DataSet.

virtual std::string te::da::DataSet::getAsString	(	std::size_t	i,
		int	precision = `0`
	)		const

virtual

Method for retrieving a data value as a string plain representation.

Parameters

i	The attribute index.
precision	The precision in the conversion.

Returns: The attribute value in a string format.

Note: It is safe to call this method for any data type, the data source implementation will take care of how to convert the internal representation to a string.

virtual std::string te::da::DataSet::getAsString	(	const std::string &	name,
		int	precision = `0`
	)		const

virtual

Method for retrieving a data value as a string plain representation.

Parameters

name	The attribute name.
precision	The precision in the conversion.

Returns: The attribute value in a string format.

Note: It is safe to call this method for any data type, the data source implementation will take care of how to convert the internal representation to a string.

virtual bool te::da::DataSet::getBool ( std::size_t i ) const

pure virtual

Method for retrieving a boolean attribute value.

Parameters

i	The attribute index.

Returns: The boolean attribute value in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::getBool ( const std::string & name ) const

virtual

Method for retrieving a boolean attribute value.

Parameters

name	The attribute name.

Returns: The boolean attribute value with the given name.

Reimplemented in te::gdal::DataSet.

virtual std::auto_ptr<te::dt::ByteArray> te::da::DataSet::getByteArray ( std::size_t i ) const

pure virtual

Method for retrieving a byte array.

You can use this method in order to retrieve a BLOB data.

Parameters

i	The attribute index.

Returns: The byte array attribute.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::auto_ptr<te::dt::ByteArray> te::da::DataSet::getByteArray ( const std::string & name ) const

virtual

Method for retrieving a byte array.

You can use this method in order to retrieve a BLOB data.

Parameters

name	The attribute name.

Returns: The byte array attribute.

Reimplemented in te::gdal::DataSet.

virtual char te::da::DataSet::getChar ( std::size_t i ) const

pure virtual

Method for retrieving a signed character attribute value (1 byte long).

Parameters

i	The attribute index.

Returns: The signed character attribute value (1 byte long) in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual char te::da::DataSet::getChar ( const std::string & name ) const

virtual

Method for retrieving a signed character attribute value (1 byte long).

Parameters

name	The attribute name.

Returns: The signed character attribute value (1 byte long) with the given name.

Reimplemented in te::gdal::DataSet.

virtual std::string te::da::DataSet::getDatasetNameOfProperty ( std::size_t i ) const

pure virtual

It returns the underlying dataset name of the property at position pos.

Parameters

i	The property position of interest.

Returns: The underlying dataset name of the property at position pos.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::da::DataSetAdapter, te::ogr::DataSet, te::gpkg::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::auto_ptr<te::dt::DateTime> te::da::DataSet::getDateTime ( std::size_t i ) const

pure virtual

Method for retrieving a date and time attribute value.

Parameters

i	The attribute index.

Returns: The date and time attribute value in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::gdal::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::auto_ptr<te::dt::DateTime> te::da::DataSet::getDateTime ( const std::string & name ) const

virtual

Method for retrieving a date and time attribute value.

Parameters

name	The attribute name.

Returns: The date and time attribute value with the given name.

Reimplemented in te::gdal::DataSet.

virtual double te::da::DataSet::getDouble ( std::size_t i ) const

pure virtual

Method for retrieving a double attribute value.

Parameters

i	The attribute index.

Returns: The double attribute value in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual double te::da::DataSet::getDouble ( const std::string & name ) const

virtual

Method for retrieving a double attribute value.

Parameters

name	The attribute name.

Returns: The double attribute value with the given name.

Reimplemented in te::gdal::DataSet.

virtual std::auto_ptr<te::gm::Envelope> te::da::DataSet::getExtent ( std::size_t i )

pure virtual

It computes the bounding rectangle for a spatial property of the dataset.

Parameters

i	The position of a spatial property to get its bounding box.

Precondition: The position i must be associated to a spatial property of the dataset.

Exceptions

Exception It throws an exception if something goes wrong during MBR search.

Returns: The spatial property bounding rectangle, or an invalid box, if none is found.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::da::FilteredDataSet, terralib4::RasterDataSet, te::da::DataSetAdapter, te::sqlite::FwDataSet, and te::gdal::DataSet.

virtual float te::da::DataSet::getFloat ( std::size_t i ) const

pure virtual

Method for retrieving a float attribute value.

Parameters

i	The attribute index.

Returns: The float attribute value in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual float te::da::DataSet::getFloat ( const std::string & name ) const

virtual

Method for retrieving a float attribute value.

Parameters

name	The attribute name.

Returns: The float attribute value with the given name.

Reimplemented in te::gdal::DataSet.

virtual std::auto_ptr<te::gm::Geometry> te::da::DataSet::getGeometry ( std::size_t i ) const

pure virtual

Method for retrieving a geometric attribute value.

Parameters

i	The attribute index.

Returns: The geometric attribute value in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::auto_ptr<te::gm::Geometry> te::da::DataSet::getGeometry ( const std::string & name ) const

virtual

Method for retrieving a geometric attribute value.

Parameters

name	The attribute name.

Returns: The geometric attribute value with the given name.

Reimplemented in te::gdal::DataSet.

virtual boost::int16_t te::da::DataSet::getInt16 ( std::size_t i ) const

pure virtual

Method for retrieving a 16-bit integer attribute value (2 bytes long).

Parameters

i	The attribute index.

Returns: The 16-bit integer attribute value (2 bytes long) in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual boost::int16_t te::da::DataSet::getInt16 ( const std::string & name ) const

virtual

Method for retrieving a 16-bit integer attribute value (2 bytes long).

Parameters

name	The attribute name.

Returns: The 16-bit integer attribute value (2 bytes long) with the given name.

Reimplemented in te::gdal::DataSet.

virtual boost::int32_t te::da::DataSet::getInt32 ( std::size_t i ) const

pure virtual

Method for retrieving a 32-bit integer attribute value (4 bytes long).

Parameters

i	The attribute index.

Returns: The 32-bit integer attribute value in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual boost::int32_t te::da::DataSet::getInt32 ( const std::string & name ) const

virtual

Method for retrieving a 32-bit integer attribute value (4 bytes long).

Parameters

name	The attribute name.

Returns: The 32-bit integer attribute value with the given name.

Reimplemented in te::gdal::DataSet.

virtual boost::int64_t te::da::DataSet::getInt64 ( std::size_t i ) const

pure virtual

Method for retrieving a 64-bit integer attribute value (8 bytes long).

Parameters

i	The attribute index.

Returns: The 64-bit integer attribute value in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual boost::int64_t te::da::DataSet::getInt64 ( const std::string & name ) const

virtual

Method for retrieving a 64-bit integer attribute value (8 bytes long).

Parameters

name	The attribute name.

Returns: The 64-bit integer attribute value with the given name.

Reimplemented in te::gdal::DataSet.

virtual std::string te::da::DataSet::getNumeric ( std::size_t i ) const

pure virtual

Method for retrieving a numeric attribute value.

Parameters

i	The attribute index.

Returns: The numeric attribute value in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::string te::da::DataSet::getNumeric ( const std::string & name ) const

virtual

Method for retrieving a numeric attribute value.

Parameters

name	The attribute name.

Returns: The numeric attribute value with the given name.

Reimplemented in te::gdal::DataSet.

virtual std::size_t te::da::DataSet::getNumProperties ( ) const

pure virtual

It returns the number of properties that composes an item of the dataset.

Returns: The number of properties that composes an item of the dataset.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::da::DataSetAdapter, te::ogr::DataSet, te::gpkg::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual te::common::CharEncoding te::da::DataSet::getPropertyCharEncoding ( std::size_t i ) const

pure virtual

It returns the property character encoding at position pos.

Parameters

i	The property the position of interest.

Returns: The property character encoding.

Note: The property at position pos must be a textual property.

Exceptions

Exception It throws an exception if the property at position pos is not a textual property.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::da::DataSetAdapter, te::ogr::DataSet, te::gpkg::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, and terralib4::RasterDataSet.

virtual int te::da::DataSet::getPropertyDataType ( std::size_t i ) const

pure virtual

It returns the underlying data type of the property at position pos.

Parameters

i	The property position of interest.

Returns: The underlying data type of the property at position pos.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::da::DataSetAdapter, te::ogr::DataSet, te::gpkg::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::string te::da::DataSet::getPropertyName ( std::size_t i ) const

pure virtual

It returns the property name at position pos.

Parameters

i	The property name at the position of interest.

Returns: The property name at position pos.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::da::DataSetAdapter, te::ogr::DataSet, te::gpkg::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::auto_ptr<te::rst::Raster> te::da::DataSet::getRaster ( std::size_t i ) const

pure virtual

Method for retrieving a raster attribute value.

Parameters

i	The attribute index.

Returns: The raster attribute value in the given position.

Exceptions

Exception

It can throw an exception if:

something goes wrong during the data retrieval
the maximum number of simultaneous accesses has been reached

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::gdal::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::auto_ptr<te::rst::Raster> te::da::DataSet::getRaster ( const std::string & name ) const

virtual

Method for retrieving a raster attribute value.

Parameters

name	The attribute name.

Returns: The raster attribute value with the given name.

Exceptions

Exception

It can throw an exception if:

something goes wrong during the data retrieval
the maximum number of simultaneous accesses has been reached

Reimplemented in te::gdal::DataSet.

virtual std::string te::da::DataSet::getString ( std::size_t i ) const

pure virtual

Method for retrieving a string value attribute.

Parameters

i	The attribute index.

Returns: The string attribute value in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual std::string te::da::DataSet::getString ( const std::string & name ) const

virtual

Method for retrieving a string attribute value.

Parameters

name	The attribute name.

Returns: The string attribute value with the given name.

Reimplemented in te::gdal::DataSet.

virtual te::common::TraverseType te::da::DataSet::getTraverseType ( ) const

pure virtual

It returns the traverse type associated to the dataset.

Returns: The traverse type associated to the dataset.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual unsigned char te::da::DataSet::getUChar ( std::size_t i ) const

pure virtual

Method for retrieving an unsigned character attribute value (1 byte long).

Parameters

i	The attribute index.

Returns: The unsigned character attribute value (1 byte long) in the given position.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual unsigned char te::da::DataSet::getUChar ( const std::string & name ) const

virtual

Method for retrieving an unsigned character attribute value (1 byte long).

Parameters

name	The attribute name.

Returns: The unsigned character attribute value (1 byte long) with the given name.

Reimplemented in te::gdal::DataSet.

virtual std::auto_ptr<te::dt::AbstractData> te::da::DataSet::getValue ( std::size_t i ) const

virtual

Method for retrieving any other type of data value stored in the data source.

This method can be use for extensible datatypes.

Parameters

i	The attribute index.

Returns: A pointer to the data value.

Reimplemented in te::stmem::DataSet, te::mem::DataSet, and te::gdal::DataSet.

virtual std::auto_ptr<te::dt::AbstractData> te::da::DataSet::getValue ( const std::string & name ) const

virtual

Method for retrieving any other type of data value stored in the data source.

This method can be use for extensible datatypes.

Parameters

name	The attribute name.

Returns: A pointer to the data value.

Reimplemented in te::gdal::DataSet.

virtual bool te::da::DataSet::isAfterEnd ( ) const

pure virtual

It tells if the dataset internal pointer is on the sentinel position after the last element of the collection or not.

Returns: True, if the dataset internal pointer is on the sentinel position after the last element otherwise it returns false.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::isAtBegin ( ) const

pure virtual

It tells if the dataset internal pointer is on the first element of the collection or not.

Returns: True if the dataset internal pointer is on the first element otherwise it returns false.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::isAtEnd ( ) const

pure virtual

It tells if the dataset internal pointer is on the last element of the collection.

Returns: True, if the dataset internal pointer is on the last element otherwise it returns false.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::isBeforeBegin ( ) const

pure virtual

It tells if the dataset internal pointer is in a position before the first element of the collection or not.

Returns: True, if the dataset internal pointer is in a position before the first element otherwise it returns false.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::isConnected ( ) const

pure virtual

It returns true if the dataset is connected and false if it is disconnected. A dataset can be connected or disconnected. A connected dataset, after its creation through the data source transactor, continues to depend on the connection given by its associated data source. Differently, a disconnected dataset, after its creation, no more depends of the connection given by the data source, and it continues to live after the connection has been released to the data source.

Returns: True, if the dataset is connected, or false if it is disconnected.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::gdal::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::da::DataSetAdapter, te::ogr::DataSet, te::gpkg::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::isEmpty ( ) const

pure virtual

It returns true if the collection is empty.

Returns: True, if the collection is empty.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::da::DataSetAdapter, te::ogr::DataSet, te::gpkg::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::isNull ( std::size_t i ) const

pure virtual

It checks if the attribute value is NULL.

Parameters

i	The attribute index.

Returns: True if the attribute value is NULL.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::gdal::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::isNull ( const std::string & name ) const

virtual

It checks if the attribute value is NULL.

Parameters

name	The attribute name.

Returns: True if the attribute value is NULL.

Reimplemented in te::gdal::DataSet.

virtual bool te::da::DataSet::move ( std::size_t i )

pure virtual

It moves the dataset internal pointer to a given position.

Parameters

i	The position the dataset internal pointer must be set up.

Returns: True, if it was possible to move the dataset reading to the given position.

Note: The first item in the collection starts at address 0.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::moveBeforeFirst ( )

pure virtual

It moves the internal pointer to a position before the first item in the collection.

Returns: True, if it was possible to move to a sentinel position before the first item in the collection.

Note: This method is not supported by FORWARDONLY datasets.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::moveFirst ( )

pure virtual

It moves the internal pointer to the first item in the collection.

Returns: True, if it was possible to move to the first item in the collection.

Note: This method is not supported by FORWARDONLY datasets.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::moveLast ( )

pure virtual

It sets the dataset internal pointer to the last item in the collection.

Returns: True, if it was possible to move to the last item in the collection.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::moveNext ( )

pure virtual

It moves the internal pointer to the next item of the collection.

You always has to call this method in order to move the internal pointer to the first item in the collection. This method can be used to traverse a dataset.

Returns: True if the internal pointer is on a valid item, or false otherwise.

Note: All dataset types support this method: FORWARDONLY, BIDIRECTIONAL and RANDOM.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

virtual bool te::da::DataSet::movePrevious ( )

pure virtual

It moves the internal pointer to the previous item of the collection.

Returns: True, if the internal pointer (cursor position) is on a valid item, or false otherwise.

Note: This method is not supported by FORWARDONLY datasets.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::ogr::DataSet, te::gpkg::DataSet, te::da::DataSetAdapter, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, terralib4::RasterDataSet, te::gdal::DataSet, and te::sqlite::FwDataSet.

virtual std::size_t te::da::DataSet::size ( ) const

pure virtual

It returns the collection size, if it is known.

It may return std::string::npos if the size is not known, or it would be too costly to compute it.

Returns: The size of the collection, if it is known.

Implemented in te::stmem::DataSet, te::mem::DataSet, te::da::FilteredDataSet, te::pgis::DataSet, te::da::DataSetAdapter, te::ogr::DataSet, te::gpkg::DataSet, te::ado::DataSet, terralib4::TableDataSet, terralib4::VectorDataSet, te::gdal::DataSet, terralib4::RasterDataSet, and te::sqlite::FwDataSet.

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

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/dataaccess/dataset/DataSet.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation