te::da::DataSetName Class Referenceabstract

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

#include <DataSetName.h>

Inheritance diagram for te::da::DataSetName:
te::da::FromItem te::common::BaseVisitable< QueryVisitor >

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...
 
FromItemclone () 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...
 
DataSetNameoperator= (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

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

Definition at line 58 of file BaseVisitable.h.

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters
nameThe dataset name.
aliasAn alias to the dataset.
te::da::DataSetName::DataSetName ( const DataSetName rhs)

Copy constructor.

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

Destructor.

Definition at line 61 of file DataSetName.h.

Member Function Documentation

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

It call the visit method from the guest object.

Parameters
guestThe guest or visitor.
Returns
Any valid value define by the template type R.
FromItem* te::da::DataSetName::clone ( ) const
virtual

It creates a new copy of this FromItem.

Implements te::da::FromItem.

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.
const std::string& te::da::DataSetName::getName ( ) const

It returns the dataset name.

Returns
The dataset name.
DataSetName& te::da::DataSetName::operator= ( const DataSetName rhs)

Assignment operator.

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

It sets the alias for a from source item.

Parameters
aliasThe alias for a from source item.
Note
The FromItem will take the ownership of the given alias.
void te::da::DataSetName::setName ( const std::string &  name)

It sets the dataset name.

Parameters
nameThe dataset name.

Member Data Documentation

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

An alias for the output name.

Definition at line 93 of file FromItem.h.

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: