te::da::DataSetName Class Reference

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

#include <DataSetName.h>

Inheritance diagram for te::da::DataSetName:

Public Types
typedef void	ReturnType
typedef QueryVisitor	VisitorType

Public Member Functions
virtual ReturnType	accept (VisitorType &guest) const=0
	It call the visit method from the guest object. More...
FromItem *	clone () const
	It creates a new copy of this FromItem. More...
TE_DEFINE_VISITABLE	DataSetName (const std::string &name, const std::string &alias="")
	Constructor. More...
	DataSetName (const DataSetName &rhs)
	Copy constructor. More...
const std::string &	getAlias () const
	It returns the alias associated to the source item. More...
const std::string &	getName () const
	It returns the dataset name. More...
DataSetName &	operator= (const DataSetName &rhs)
void	setAlias (const std::string &alias)
	It sets the alias for a from source item. More...
void	setName (const std::string &name)
	It sets the dataset name. More...
	~DataSetName ()
	Destructor. More...

Protected Attributes
std::string	m_alias
	An alias for the output name. More...

Private Attributes
std::string	m_name
	The dataset name. More...

Detailed Description

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

See also

FromItem, SubSelect, FromFunctionCall, Join

Definition at line 43 of file DataSetName.h.

Member Typedef Documentation

ReturnType

typedef void te::common::BaseVisitable< QueryVisitor , void >::ReturnType

inherited

Definition at line 58 of file BaseVisitable.h.

VisitorType

typedef QueryVisitor te::common::BaseVisitable< QueryVisitor , void >::VisitorType

inherited

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

DataSetName() [1/2]

TE_DEFINE_VISITABLE te::da::DataSetName::DataSetName	(	const std::string &	name,
		const std::string &	alias = ""
	)

Constructor.

Parameters

name	The dataset name.
alias	An alias to the dataset.

DataSetName() [2/2]

te::da::DataSetName::DataSetName

(

const DataSetName &

rhs

)

Copy constructor.

~DataSetName()

te::da::DataSetName::~DataSetName ( )

inline

Destructor.

Definition at line 61 of file DataSetName.h.

Member Function Documentation

accept()

virtual ReturnType te::common::BaseVisitable< QueryVisitor , void >::accept ( VisitorType &  guest ) const

pure virtualinherited

It call the visit method from the guest object.

Parameters

guest

The guest or visitor.

Returns

Any valid value define by the template type R.

clone()

FromItem* te::da::DataSetName::clone ( ) const

virtual

It creates a new copy of this FromItem.

Implements te::da::FromItem.

getAlias()

const std::string& te::da::FromItem::getAlias ( ) const

inherited

It returns the alias associated to the source item.

Returns

The alias for the source item.

getName()

const std::string& te::da::DataSetName::getName

(

)

const

It returns the dataset name.

Returns

The dataset name.

operator=()

DataSetName& te::da::DataSetName::operator=

(

const DataSetName &

rhs

)

Assignment operator.

setAlias()

void te::da::FromItem::setAlias ( const std::string &  alias )

inherited

It sets the alias for a from source item.

Parameters

alias

The alias for a from source item.

Note

The FromItem will take the ownership of the given alias.

setName()

void te::da::DataSetName::setName

(

const std::string &

name

)

It sets the dataset name.

Parameters

name	The dataset name.

Member Data Documentation

m_alias

std::string te::da::FromItem::m_alias

protectedinherited

An alias for the output name.

Definition at line 93 of file FromItem.h.

m_name

std::string te::da::DataSetName::m_name

private

The dataset name.

Definition at line 85 of file DataSetName.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/dataaccess/query/DataSetName.h