A Join clause combines two FromItems. More...

#include <Join.h>

Inheritance diagram for te::da::Join:

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...

const std::string &	getAlias () const
	It returns the alias associated to the source item. More...

JoinCondition *	getCondition () const
	It returns the join condition. More...

FromItem *	getFirst () const
	It returns the first from item involved in the join. More...

FromItem *	getSecond () const
	It returns the second item involved in the join. More...

JoinType	getType () const
	It returns the join type. More...

bool	isNatural () const
	It tells if the join is Natural. More...

	Join (const FromItem &first, const FromItem &second, JoinType t, const JoinCondition &c)
	Constructor. More...

	Join (const Join &rhs)
	Copy constructor. More...

TE_DEFINE_VISITABLE	Join (FromItem first, FromItem second, JoinType t, JoinCondition *c)
	Constructor. More...

Join &	operator= (const Join &rhs)

void	setAlias (const std::string &alias)
	It sets the alias for a from source item. More...

void	setCondition (JoinCondition *c)
	It sets the join condition. More...

void	setFirst (FromItem *item)
	It sets first item involved in the join. More...

void	setNatural (bool n)
	It marks if the join is a natural join. More...

void	setSecond (FromItem *item)
	It sets second item involved in the join. More...

void	setType (JoinType t)
	It sets join type. More...

	~Join ()
	Destructor. More...

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

Private Attributes
std::unique_ptr< JoinCondition >	m_condition
	The join condition. More...

std::unique_ptr< FromItem >	m_first
	The first item involved in the join. More...

bool	m_isNatural
	Natural is a shorthand for a JoinConditionUsing list that mentions all columns in the two tables that have the same names. More...

std::unique_ptr< FromItem >	m_second
	The first item involved in the join. More...

JoinType	m_type
	The join type. More...

Detailed Description

A Join clause combines two FromItems.

See also: FromItem, DataSetName, FromFunctionCall, SubSelect

Definition at line 50 of file Join.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

◆ Join() [1/3]

TE_DEFINE_VISITABLE te::da::Join::Join	(	FromItem *	first,
		FromItem *	second,
		JoinType	t,
		JoinCondition *	c
	)

Constructor.

Parameters

first	The first FromItem to be combined.
second	The second FromItem to be combined.
t	The join type.
c	The join condition.

Note: The Join will take the ownership of the First, Second and JoinCondition.

◆ Join() [2/3]

te::da::Join::Join	(	const FromItem &	first,
		const FromItem &	second,
		JoinType	t,
		const JoinCondition &	c
	)

Constructor.

Parameters

first	The first FromItem to be combined.
second	The second FromItem to be combined.
t	The join type.
c	The join condition.

◆ Join() [3/3]

te::da::Join::Join ( const Join & rhs )

Copy constructor.

◆ ~Join()

te::da::Join::~Join ( )

Destructor.

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::Join::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.

◆ getCondition()

JoinCondition * te::da::Join::getCondition ( ) const

It returns the join condition.

Returns: The join condition.

◆ getFirst()

FromItem * te::da::Join::getFirst ( ) const

It returns the first from item involved in the join.

Returns: The first item involved in the join.

◆ getSecond()

FromItem * te::da::Join::getSecond ( ) const

It returns the second item involved in the join.

Returns: The second item involved in the join.

◆ getType()

JoinType te::da::Join::getType ( ) const

It returns the join type.

Returns: The join type.

◆ isNatural()

bool te::da::Join::isNatural ( ) const

inline

It tells if the join is Natural.

Returns: True if it is a Natural join, otherwise, false.

Definition at line 141 of file Join.h.

◆ operator=()

Join & te::da::Join::operator= ( const Join & 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.

◆ setCondition()

void te::da::Join::setCondition ( JoinCondition * c )

It sets the join condition.

Parameters

c	The join condition.

Note: The Join will take the ownership of the given condition.

◆ setFirst()

void te::da::Join::setFirst ( FromItem * item )

It sets first item involved in the join.

Parameters

item	The first item involved in the join.

Note: The Join will take the ownership of the given item.

◆ setNatural()

void te::da::Join::setNatural ( bool n )

inline

It marks if the join is a natural join.

Parameters

n	If true this will be a natural join.

Definition at line 148 of file Join.h.

◆ setSecond()

void te::da::Join::setSecond ( FromItem * item )

It sets second item involved in the join.

Parameters

item	The second item involved in the join.

Note: The Join will take the ownership of the given item.

◆ setType()

void te::da::Join::setType ( JoinType t )

It sets join type.

Parameters

t	The join type.

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_condition

std::unique_ptr<JoinCondition> te::da::Join::m_condition

private

The join condition.

Definition at line 170 of file Join.h.

◆ m_first

std::unique_ptr<FromItem> te::da::Join::m_first

private

The first item involved in the join.

Definition at line 168 of file Join.h.

◆ m_isNatural

bool te::da::Join::m_isNatural

private

Natural is a shorthand for a JoinConditionUsing list that mentions all columns in the two tables that have the same names.

Definition at line 172 of file Join.h.

◆ m_second

std::unique_ptr<FromItem> te::da::Join::m_second

private

The first item involved in the join.

Definition at line 169 of file Join.h.

◆ m_type

JoinType te::da::Join::m_type

private

The join type.

Definition at line 171 of file Join.h.

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

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

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ReturnType

◆ VisitorType

Constructor & Destructor Documentation

◆ Join() [1/3]

◆ Join() [2/3]

◆ Join() [3/3]

◆ ~Join()

Member Function Documentation

◆ accept()

◆ clone()

◆ getAlias()

◆ getCondition()

◆ getFirst()

◆ getSecond()

◆ getType()

◆ isNatural()

◆ operator=()

◆ setAlias()

◆ setCondition()

◆ setFirst()

◆ setNatural()

◆ setSecond()

◆ setType()

Member Data Documentation

◆ m_alias

◆ m_condition

◆ m_first

◆ m_isNatural

◆ m_second

◆ m_type