#include <FwDataSet.h>

Inheritance diagram for te::sqlite::FwDataSet:

Public Member Functions
	FwDataSet (sqlite3_stmt stmt, DataSourceTransactor t)

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

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

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

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

char	getChar (std::size_t i) const
	Method for retrieving a signed character attribute value (1 byte long). More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

te::common::TraverseType	getTraverseType () const
	It returns the traverse type associated to the dataset. More...

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

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

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

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

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

bool	isConnected () const
	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...

bool	isEmpty () const
	It returns true if the collection is empty. More...

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

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

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

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

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

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

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

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

	~FwDataSet ()

DataSet Methods
Methods for obtaining information about a given dataset.
virtual te::common::CharEncoding	getPropertyCharEncoding (std::size_t i) const =0
	It returns the property character encoding at position pos. 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 (const std::string &name) const
	Method for retrieving a signed 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 (const std::string &name) const
	Method for retrieving a 16-bit integer attribute value (2 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 (const std::string &name) const
	Method for retrieving a 64-bit integer attribute value (8 bytes long). More...

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

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

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

virtual std::string	getNumeric (const std::string &name) const
	Method for retrieving a numeric attribute value. 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 (const std::string &name) const
	Method for retrieving a byte array. 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 (const std::string &name) const
	Method for retrieving a raster 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 (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 (const std::string &name) const
	It checks if the attribute value is NULL. More...

Public Attributes
Impl *	m_pImpl

Detailed Description

Definition at line 44 of file FwDataSet.h.

Constructor & Destructor Documentation

te::sqlite::FwDataSet::FwDataSet	(	sqlite3_stmt *	stmt,
		DataSourceTransactor *	t
	)

te::sqlite::FwDataSet::~FwDataSet ( )

Member Function Documentation

te::common::AccessPolicy te::sqlite::FwDataSet::getAccessPolicy ( ) const

virtual

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

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

Implements te::da::DataSet.

std::auto_ptr<te::dt::Array> te::sqlite::FwDataSet::getArray ( std::size_t i ) const

virtual

Method for retrieving an array.

Parameters

i	The attribute index.

Implements te::da::DataSet.

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

virtualinherited

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

virtualinherited

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

virtualinherited

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.

bool te::sqlite::FwDataSet::getBool ( std::size_t i ) const

virtual

Method for retrieving a boolean attribute value.

Parameters

i	The attribute index.

Returns: The boolean attribute value in the given position.

Implements te::da::DataSet.

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

virtualinherited

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.

std::auto_ptr<te::dt::ByteArray> te::sqlite::FwDataSet::getByteArray ( std::size_t i ) const

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.

Implements te::da::DataSet.

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

virtualinherited

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.

char te::sqlite::FwDataSet::getChar ( std::size_t i ) const

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.

Implements te::da::DataSet.

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

virtualinherited

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.

std::string te::sqlite::FwDataSet::getDatasetNameOfProperty ( std::size_t i ) const

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.

Implements te::da::DataSet.

std::auto_ptr<te::dt::DateTime> te::sqlite::FwDataSet::getDateTime ( std::size_t i ) const

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.

Implements te::da::DataSet.

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

virtualinherited

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.

double te::sqlite::FwDataSet::getDouble ( std::size_t i ) const

virtual

Method for retrieving a double attribute value.

Parameters

i	The attribute index.

Returns: The double attribute value in the given position.

Implements te::da::DataSet.

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

virtualinherited

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.

std::auto_ptr<te::gm::Envelope> te::sqlite::FwDataSet::getExtent ( std::size_t i )

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.

Implements te::da::DataSet.

float te::sqlite::FwDataSet::getFloat ( std::size_t i ) const

virtual

Method for retrieving a float attribute value.

Parameters

i	The attribute index.

Returns: The float attribute value in the given position.

Implements te::da::DataSet.

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

virtualinherited

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.

std::auto_ptr<te::gm::Geometry> te::sqlite::FwDataSet::getGeometry ( std::size_t i ) const

virtual

Method for retrieving a geometric attribute value.

Parameters

i	The attribute index.

Returns: The geometric attribute value in the given position.

Implements te::da::DataSet.

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

virtualinherited

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.

boost::int16_t te::sqlite::FwDataSet::getInt16 ( std::size_t i ) const

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.

Implements te::da::DataSet.

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

virtualinherited

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.

boost::int32_t te::sqlite::FwDataSet::getInt32 ( std::size_t i ) const

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.

Implements te::da::DataSet.

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

virtualinherited

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.

boost::int64_t te::sqlite::FwDataSet::getInt64 ( std::size_t i ) const

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.

Implements te::da::DataSet.

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

virtualinherited

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.

std::string te::sqlite::FwDataSet::getNumeric ( std::size_t i ) const

virtual

Method for retrieving a numeric attribute value.

Parameters

i	The attribute index.

Returns: The numeric attribute value in the given position.

Implements te::da::DataSet.

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

virtualinherited

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.

std::size_t te::sqlite::FwDataSet::getNumProperties ( ) const

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.

Implements te::da::DataSet.

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

pure virtualinherited

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.

int te::sqlite::FwDataSet::getPropertyDataType ( std::size_t i ) const

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.

Implements te::da::DataSet.

std::string te::sqlite::FwDataSet::getPropertyName ( std::size_t i ) const

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.

Implements te::da::DataSet.

std::auto_ptr<te::rst::Raster> te::sqlite::FwDataSet::getRaster ( std::size_t i ) const

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

Implements te::da::DataSet.

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

virtualinherited

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.

std::string te::sqlite::FwDataSet::getString ( std::size_t i ) const

virtual

Method for retrieving a string value attribute.

Parameters

i	The attribute index.

Returns: The string attribute value in the given position.

Implements te::da::DataSet.

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

virtualinherited

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.

te::common::TraverseType te::sqlite::FwDataSet::getTraverseType ( ) const

virtual

It returns the traverse type associated to the dataset.

Returns: The traverse type associated to the dataset.

Implements te::da::DataSet.

unsigned char te::sqlite::FwDataSet::getUChar ( std::size_t i ) const

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.

Implements te::da::DataSet.

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

virtualinherited

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

virtualinherited

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

virtualinherited

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.

bool te::sqlite::FwDataSet::isAfterEnd ( ) const

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.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::isAtBegin ( ) const

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.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::isAtEnd ( ) const

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.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::isBeforeBegin ( ) const

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.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::isConnected ( ) const

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.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::isEmpty ( ) const

virtual

It returns true if the collection is empty.

Returns: True, if the collection is empty.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::isNull ( std::size_t i ) const

virtual

It checks if the attribute value is NULL.

Parameters

i	The attribute index.

Returns: True if the attribute value is NULL.

Implements te::da::DataSet.

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

virtualinherited

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.

bool te::sqlite::FwDataSet::move ( std::size_t i )

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.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::moveBeforeFirst ( )

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.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::moveFirst ( )

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.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::moveLast ( )

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.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::moveNext ( )

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.

Implements te::da::DataSet.

bool te::sqlite::FwDataSet::movePrevious ( )

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.

Implements te::da::DataSet.

std::size_t te::sqlite::FwDataSet::size ( ) const

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.

Implements te::da::DataSet.

Member Data Documentation

Impl* te::sqlite::FwDataSet::m_pImpl

Definition at line 124 of file FwDataSet.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/sqlite/FwDataSet.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation