te::da::Select Class Reference

A Select models a query to be used when retrieving data from a DataSource. More...

#include <Select.h>

Inheritance diagram for te::da::Select:

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...
Query *	clone () const
	It creates a new copy of this query. More...
Select &	CrossJoin (FromItem *d2)
Select &	CrossJoin (const FromItem &d2)
Select &	distinct (Expression *e)
Select &	distinct (const Expression &e)
Select &	distinct (const std::string &propertyName)
Select &	distinct (Distinct *d)
Select &	distinct (const Distinct &rhs)
Distinct &	distinct ()
const Distinct &	distinct () const
Select &	fields (const Fields &f)
Select &	fields (Fields *f)
Fields &	fields ()
const Fields &	fields () const
Select &	from (const FromItem &item)
Select &	from (FromItem *item)
Select &	from (const FromItem &i1, const FromItem &i2)
Select &	from (FromItem *i1, FromItem *i2)
Select &	from (const FromItem &i1, const FromItem &i2, const FromItem &i3)
Select &	from (FromItem *i1, FromItem *i2, FromItem *i3)
Select &	from (const std::string &datasetName)
Select &	from (From *f)
Select &	from (const From &rhs)
From &	from ()
const From &	from () const
Select &	FullOuterJoin (FromItem *d2, JoinCondition *c)
Select &	FullOuterJoin (const FromItem &d2, const JoinCondition &c)
const Distinct *	getDistinct () const
	It returns the Distinct modifier. More...
const Fields *	getFields () const
	It returns the list of output expressions used to form the result set. More...
const From *	getFrom () const
	It returns the list of source information to be used by the query. More...
const GroupBy *	getGroupBy () const
	It returns the list of expressions used to condense the result set. More...
const Having *	getHaving () const
	It returns the list of expressions used to eliminate group row that doesn't satisfy the condition. More...
std::size_t	getLimit () const
	It tells the maximum number of rows to return. More...
std::size_t	getOffset () const
	It tells the number of rows to skip before starting to return rows. More...
const OrderBy *	getOrderBy () const
	It returns the list of expressions used to sort the output result. More...
Where *	getWhere () const
	It returns the filter condition. More...
Select &	groupBy (const GroupByItem &item)
Select &	groupBy (GroupByItem *item)
Select &	groupBy (const Expression &e)
Select &	groupBy (const std::string &propertyName)
Select &	groupBy (GroupBy *gb)
Select &	groupBy (const GroupBy &rhs)
GroupBy &	groupBy ()
const GroupBy &	groupBy () const
Select &	having (Expression *e)
Select &	having (const Expression &e)
Select &	having (Having *h)
Select &	having (const Having &rhs)
Having &	having ()
const Having &	having () const
Select &	InnerJoin (FromItem *d2, JoinCondition *c)
Select &	InnerJoin (const FromItem &d2, const JoinCondition &c)
Select &	Join (FromItem *d2, JoinType t, JoinCondition *c)
Select &	Join (const FromItem &d2, JoinType t, const JoinCondition &c)
Select &	LeftJoin (FromItem *d2, JoinCondition *c)
Select &	LeftJoin (const FromItem &d2, const JoinCondition &c)
Select &	limit (std::size_t l)
Select &	NaturalJoin (FromItem *d2, JoinType t)
Select &	NaturalJoin (const FromItem &d2, JoinType t)
Select &	offset (std::size_t i)
Select &	operator() (const Field &f)
Select &	operator() (Field *f)
Select &	operator() (const std::string &propertyName)
Select &	operator() (const std::string &propertyName, const std::string &alias)
Select &	operator+ (const te::da::From &f)
Select &	operator+ (te::da::From *f)
Select &	operator+ (const te::da::Where &w)
Select &	operator+ (te::da::Where *w)
Select &	operator+ (const te::da::GroupBy &g)
Select &	operator+ (te::da::GroupBy *g)
Select &	operator+ (const te::da::Having &h)
Select &	operator+ (te::da::Having *h)
Select &	operator+ (const te::da::OrderBy &o)
Select &	operator+ (te::da::OrderBy *o)
Select &	operator= (const Select &rhs)
Select &	orderBy (const OrderByItem &item)
Select &	orderBy (OrderByItem *item)
Select &	orderBy (const Expression &e, SortOrder o=ASC)
Select &	orderBy (const std::string &propertyName, SortOrder o=ASC)
Select &	orderBy (OrderBy *o)
Select &	orderBy (const OrderBy &rhs)
OrderBy &	orderBy ()
const OrderBy &	orderBy () const
Select &	RightJoin (FromItem *d2, JoinCondition *c)
Select &	RightJoin (const FromItem &d2, const JoinCondition &c)
TE_DEFINE_VISITABLE	Select ()
	Default constructor. More...
	Select (Fields *fds, From *f=0, Where *w=0, OrderBy *o=0)
	Select (const Fields &fds)
	Select (const Fields &fds, const From &f)
	Select (const Fields &fds, const From &f, const Where &w)
	Select (const Fields &fds, const From &f, const Where &w, const OrderBy &o)
	Select (Fields *fds, From *f, OrderBy *o)
	Select (const Fields &fds, const From &f, const OrderBy &o)
	Select (Fields *fds, From *f, Where *w, GroupBy *gb, OrderBy *o=0)
	Select (const Fields &fds, const From &f, const Where &w, const GroupBy &gb)
	Select (const Fields &fds, const From &f, const Where &w, const GroupBy &gb, const OrderBy &o)
	Select (Fields *fds, From *f, GroupBy *gb, OrderBy *o=0)
	Select (const Fields &fds, const From &f, const GroupBy &gb)
	Select (const Fields &fds, const From &f, const GroupBy &gb, const OrderBy &o)
	Select (Fields *fds, From *f, Where *w, GroupBy *gb, Having *h, OrderBy *o=0)
	Select (const Fields &fds, const From &f, const Where &w, const GroupBy &gb, const Having &h)
	Select (const Fields &fds, const From &f, const Where &w, const GroupBy &gb, const Having &h, const OrderBy &o)
	Select (Field *f)
	Select (const Field &f)
	Select (const std::string &propertyName)
	Select (const std::string &propertyName, const std::string &alias)
	Select (const Select &rhs)
	Select (const Select *rhs)
void	setDistinct (Distinct *d)
	If Distinct is specified, all duplicate rows are removed from the result set (one row is kept from each group of duplicates). More...
void	setFields (Fields *f)
	It sets the list of output expressions used to form the result set. More...
void	setFrom (From *f)
	It sets the list of source information. More...
void	setGroupBy (GroupBy *g)
	It sets the list of expressions used to condense the result set. More...
void	setHaving (Having *h)
	It sets the list of expressions used to eliminate group row that doesn't satisfy the condition. More...
void	setLimit (std::size_t m)
	It specifies the maximum number of rows to return. More...
void	setOffset (std::size_t o)
	It specifies the number of rows to skip before starting to return rows. More...
void	setOrderBy (OrderBy *o)
	It sets the list of expressions used to sort the output result. More...
void	setWhere (Where *w)
	It sets the filter codition. More...
Select &	where (Expression *e)
Select &	where (const Expression &e)
Select &	where (Where *w)
Select &	where (const Where &rhs)
Where &	where ()
const Where &	where () const
	~Select ()
	Destructor. More...

Private Attributes
std::auto_ptr< Distinct >	m_distinct
std::auto_ptr< Fields >	m_fields
std::auto_ptr< From >	m_from
std::auto_ptr< GroupBy >	m_groupBy
std::auto_ptr< Having >	m_having
std::size_t	m_limit
std::size_t	m_offset
std::auto_ptr< OrderBy >	m_orderBy
std::auto_ptr< Where >	m_where

Detailed Description

A Select models a query to be used when retrieving data from a DataSource.

See also

Query, Fields, From, Expression, GroupBy, Expression, OrderBy, Distinct

Definition at line 65 of file Select.h.

Member Typedef Documentation

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

inherited

Definition at line 58 of file BaseVisitable.h.

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

inherited

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

TE_DEFINE_VISITABLE te::da::Select::Select

(

)

Default constructor.

te::da::Select::Select	(	Fields *	fds,
		From *	f = 0,
		Where *	w = 0,
		OrderBy *	o = 0
	)

te::da::Select::Select

(

const Fields &

fds

)

te::da::Select::Select	(	const Fields &	fds,
		const From &	f
	)

te::da::Select::Select	(	const Fields &	fds,
		const From &	f,
		const Where &	w
	)

te::da::Select::Select	(	const Fields &	fds,
		const From &	f,
		const Where &	w,
		const OrderBy &	o
	)

te::da::Select::Select	(	Fields *	fds,
		From *	f,
		OrderBy *	o
	)

te::da::Select::Select	(	const Fields &	fds,
		const From &	f,
		const OrderBy &	o
	)

te::da::Select::Select	(	Fields *	fds,
		From *	f,
		Where *	w,
		GroupBy *	gb,
		OrderBy *	o = 0
	)

te::da::Select::Select	(	const Fields &	fds,
		const From &	f,
		const Where &	w,
		const GroupBy &	gb
	)

te::da::Select::Select	(	const Fields &	fds,
		const From &	f,
		const Where &	w,
		const GroupBy &	gb,
		const OrderBy &	o
	)

te::da::Select::Select	(	Fields *	fds,
		From *	f,
		GroupBy *	gb,
		OrderBy *	o = 0
	)

te::da::Select::Select	(	const Fields &	fds,
		const From &	f,
		const GroupBy &	gb
	)

te::da::Select::Select	(	const Fields &	fds,
		const From &	f,
		const GroupBy &	gb,
		const OrderBy &	o
	)

te::da::Select::Select	(	Fields *	fds,
		From *	f,
		Where *	w,
		GroupBy *	gb,
		Having *	h,
		OrderBy *	o = 0
	)

te::da::Select::Select	(	const Fields &	fds,
		const From &	f,
		const Where &	w,
		const GroupBy &	gb,
		const Having &	h
	)

te::da::Select::Select	(	const Fields &	fds,
		const From &	f,
		const Where &	w,
		const GroupBy &	gb,
		const Having &	h,
		const OrderBy &	o
	)

te::da::Select::Select

(

Field *

f

)

te::da::Select::Select

(

const Field &

f

)

te::da::Select::Select

(

const std::string &

propertyName

)

te::da::Select::Select	(	const std::string &	propertyName,
		const std::string &	alias
	)

te::da::Select::Select

(

const Select &

rhs

)

te::da::Select::Select

(

const Select *

rhs

)

te::da::Select::~Select

(

)

Destructor.

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

guest

The guest or visitor.

Returns

Any valid value define by the template type R.

Query* te::da::Select::clone ( ) const

virtual

It creates a new copy of this query.

Implements te::da::Query.

Select& te::da::Select::CrossJoin

(

FromItem *

d2

)

Select& te::da::Select::CrossJoin

(

const FromItem &

d2

)

Select& te::da::Select::distinct

(

Expression *

e

)

Select& te::da::Select::distinct

(

const Expression &

e

)

Select& te::da::Select::distinct

(

const std::string &

propertyName

)

Select& te::da::Select::distinct

(

Distinct *

d

)

Select& te::da::Select::distinct

(

const Distinct &

rhs

)

Distinct& te::da::Select::distinct

(

)

const Distinct& te::da::Select::distinct

(

)

const

Select& te::da::Select::fields

(

const Fields &

f

)

Select& te::da::Select::fields

(

Fields *

f

)

Fields& te::da::Select::fields

(

)

const Fields& te::da::Select::fields

(

)

const

Select& te::da::Select::from

(

const FromItem &

item

)

Select& te::da::Select::from

(

FromItem *

item

)

Select& te::da::Select::from	(	const FromItem &	i1,
		const FromItem &	i2
	)

Select& te::da::Select::from	(	FromItem *	i1,
		FromItem *	i2
	)

Select& te::da::Select::from	(	const FromItem &	i1,
		const FromItem &	i2,
		const FromItem &	i3
	)

Select& te::da::Select::from	(	FromItem *	i1,
		FromItem *	i2,
		FromItem *	i3
	)

Select& te::da::Select::from

(

const std::string &

datasetName

)

Select& te::da::Select::from

(

From *

f

)

Select& te::da::Select::from

(

const From &

rhs

)

From& te::da::Select::from

(

)

const From& te::da::Select::from

(

)

const

Select& te::da::Select::FullOuterJoin	(	FromItem *	d2,
		JoinCondition *	c
	)

Select& te::da::Select::FullOuterJoin	(	const FromItem &	d2,
		const JoinCondition &	c
	)

const Distinct* te::da::Select::getDistinct

(

)

const

It returns the Distinct modifier.

Returns

The Distinct modifier.

const Fields* te::da::Select::getFields

(

)

const

It returns the list of output expressions used to form the result set.

Returns

The list of output expressions used to form the result set.

const From* te::da::Select::getFrom

(

)

const

It returns the list of source information to be used by the query.

Returns

The list of source information to be used by the query.

const GroupBy* te::da::Select::getGroupBy

(

)

const

It returns the list of expressions used to condense the result set.

Returns

The list of expressions used to condense the result set.

const Having* te::da::Select::getHaving

(

)

const

It returns the list of expressions used to eliminate group row that doesn't satisfy the condition.

Returns

The list of expressions used to eliminate group row that doesn't satisfy the condition.

std::size_t te::da::Select::getLimit

(

)

const

It tells the maximum number of rows to return.

Returns

The maximum number of rows to return.

std::size_t te::da::Select::getOffset

(

)

const

It tells the number of rows to skip before starting to return rows.

Returns

The number of rows to skip before starting to return rows.

const OrderBy* te::da::Select::getOrderBy

(

)

const

It returns the list of expressions used to sort the output result.

Returns

The list of expressions used to sort the output result.

Where* te::da::Select::getWhere

(

)

const

It returns the filter condition.

Returns

The filter condition.

Select& te::da::Select::groupBy

(

const GroupByItem &

item

)

Select& te::da::Select::groupBy

(

GroupByItem *

item

)

Select& te::da::Select::groupBy

(

const Expression &

e

)

Select& te::da::Select::groupBy

(

const std::string &

propertyName

)

Select& te::da::Select::groupBy

(

GroupBy *

gb

)

Select& te::da::Select::groupBy

(

const GroupBy &

rhs

)

GroupBy& te::da::Select::groupBy

(

)

const GroupBy& te::da::Select::groupBy

(

)

const

Select& te::da::Select::having

(

Expression *

e

)

Select& te::da::Select::having

(

const Expression &

e

)

Select& te::da::Select::having

(

Having *

h

)

Select& te::da::Select::having

(

const Having &

rhs

)

Having& te::da::Select::having

(

)

const Having& te::da::Select::having

(

)

const

Select& te::da::Select::InnerJoin	(	FromItem *	d2,
		JoinCondition *	c
	)

Select& te::da::Select::InnerJoin	(	const FromItem &	d2,
		const JoinCondition &	c
	)

Select& te::da::Select::Join	(	FromItem *	d2,
		JoinType	t,
		JoinCondition *	c
	)

Select& te::da::Select::Join	(	const FromItem &	d2,
		JoinType	t,
		const JoinCondition &	c
	)

Select& te::da::Select::LeftJoin	(	FromItem *	d2,
		JoinCondition *	c
	)

Select& te::da::Select::LeftJoin	(	const FromItem &	d2,
		const JoinCondition &	c
	)

Select& te::da::Select::limit

(

std::size_t

l

)

Select& te::da::Select::NaturalJoin	(	FromItem *	d2,
		JoinType	t
	)

Select& te::da::Select::NaturalJoin	(	const FromItem &	d2,
		JoinType	t
	)

Select& te::da::Select::offset

(

std::size_t

i

)

Select& te::da::Select::operator()

(

const Field &

f

)

Select& te::da::Select::operator()

(

Field *

f

)

Select& te::da::Select::operator()

(

const std::string &

propertyName

)

Select& te::da::Select::operator()	(	const std::string &	propertyName,
		const std::string &	alias
	)

Select& te::da::Select::operator+

(

const te::da::From &

f

)

Select& te::da::Select::operator+

(

te::da::From *

f

)

Select& te::da::Select::operator+

(

const te::da::Where &

w

)

Select& te::da::Select::operator+

(

te::da::Where *

w

)

Select& te::da::Select::operator+

(

const te::da::GroupBy &

g

)

Select& te::da::Select::operator+

(

te::da::GroupBy *

g

)

Select& te::da::Select::operator+

(

const te::da::Having &

h

)

Select& te::da::Select::operator+

(

te::da::Having *

h

)

Select& te::da::Select::operator+

(

const te::da::OrderBy &

o

)

Select& te::da::Select::operator+

(

te::da::OrderBy *

o

)

Select& te::da::Select::operator=

(

const Select &

rhs

)

Assignment operator.

Select& te::da::Select::orderBy

(

const OrderByItem &

item

)

Select& te::da::Select::orderBy

(

OrderByItem *

item

)

Select& te::da::Select::orderBy	(	const Expression &	e,
		SortOrder	o = ASC
	)

Select& te::da::Select::orderBy	(	const std::string &	propertyName,
		SortOrder	o = ASC
	)

Select& te::da::Select::orderBy

(

OrderBy *

o

)

Select& te::da::Select::orderBy

(

const OrderBy &

rhs

)

OrderBy& te::da::Select::orderBy

(

)

const OrderBy& te::da::Select::orderBy

(

)

const

Select& te::da::Select::RightJoin	(	FromItem *	d2,
		JoinCondition *	c
	)

Select& te::da::Select::RightJoin	(	const FromItem &	d2,
		const JoinCondition &	c
	)

void te::da::Select::setDistinct

(

Distinct *

d

)

If Distinct is specified, all duplicate rows are removed from the result set (one row is kept from each group of duplicates).

Parameters

d	The Distinct modifier.

Note

Select will take the ownership of Distinct.

void te::da::Select::setFields

(

Fields *

f

)

It sets the list of output expressions used to form the result set.

Parameters

f	The list of output expressions used to form the result set.

Note

Select will take the ownership of Fields.

void te::da::Select::setFrom

(

From *

f

)

It sets the list of source information.

Parameters

f	The list of source information.

Note

Select will take the ownership of From.

void te::da::Select::setGroupBy

(

GroupBy *

g

)

It sets the list of expressions used to condense the result set.

Parameters

g	The list of expressions used to condense the result set.

Note

Select will take the ownership of GroupBy.

void te::da::Select::setHaving

(

Having *

h

)

It sets the list of expressions used to eliminate group row that doesn't satisfy the condition.

Parameters

h	The list of expressions used to eliminate group row that doesn't satisfy the condition.

Note

Select will take the ownership of Having.

void te::da::Select::setLimit

(

std::size_t

m

)

It specifies the maximum number of rows to return.

Parameters

m	The maximum number of rows to return.

void te::da::Select::setOffset

(

std::size_t

o

)

It specifies the number of rows to skip before starting to return rows.

Parameters

o	The number of rows to skip before starting to return rows.

void te::da::Select::setOrderBy

(

OrderBy *

o

)

It sets the list of expressions used to sort the output result.

Parameters

o	The list of expressions used to sort the output result.

Note

Select will take the ownership of OrderBy.

void te::da::Select::setWhere

(

Where *

w

)

It sets the filter codition.

Parameters

w	The filter condition.

Note

Select will take the ownership of Where.

Select& te::da::Select::where

(

Expression *

e

)

Select& te::da::Select::where

(

const Expression &

e

)

Select& te::da::Select::where

(

Where *

w

)

Select& te::da::Select::where

(

const Where &

rhs

)

Where& te::da::Select::where

(

)

const Where& te::da::Select::where

(

)

const

Member Data Documentation

std::auto_ptr<Distinct> te::da::Select::m_distinct

private

Definition at line 444 of file Select.h.

std::auto_ptr<Fields> te::da::Select::m_fields

private

Definition at line 438 of file Select.h.

std::auto_ptr<From> te::da::Select::m_from

private

Definition at line 439 of file Select.h.

std::auto_ptr<GroupBy> te::da::Select::m_groupBy

private

Definition at line 441 of file Select.h.

std::auto_ptr<Having> te::da::Select::m_having

private

Definition at line 442 of file Select.h.

std::size_t te::da::Select::m_limit

private

Definition at line 445 of file Select.h.

std::size_t te::da::Select::m_offset

private

Definition at line 446 of file Select.h.

std::auto_ptr<OrderBy> te::da::Select::m_orderBy

private

Definition at line 443 of file Select.h.

std::auto_ptr<Where> te::da::Select::m_where

private

Definition at line 440 of file Select.h.

---

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

• C:/CC_master/terralib5/src/terralib/dataaccess/query/Select.h