A class that models a Function expression. More...

#include <Function.h>

Inheritance diagram for te::da::Function:

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

void	add (Expression *arg)
	It adds the argument to the function list of arguments. More...

Expression *	clone () const
	It creates a new copy of this expression. More...

TE_DEFINE_VISITABLE	Function (const std::string &name)
	Constructor. More...

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

Expression *	getArg (std::size_t i) const
	It returns the i-th function argument. More...

const std::string &	getName () const
	It returns the function name. More...

std::size_t	getNumArgs () const
	It returns the number of arguments informed to the function. More...

Function &	operator= (const Function &rhs)

Expression *	operator[] (std::size_t i) const
	It returns the i-th function argument. More...

virtual	~Function ()
	Virtual Destructor. More...

Protected Attributes
std::vector< Expression * >	m_args
	The list of arguments. More...

std::string	m_name
	The function name. May be an operator symbol or just a regular name like ST_Intersects. More...

Detailed Description

A class that models a Function expression.

See Also: Expression

Definition at line 47 of file Function.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::Function::Function ( const std::string & name )

inline

Constructor.

Parameters

name	The function name.

Note: See FunctionNames.h for a list of common names.

Definition at line 60 of file Function.h.

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

Copy constructor.

Definition at line 33 of file Function.cpp.

References te::common::Clone(), and m_args.

te::da::Function::~Function ( )

virtual

Virtual Destructor.

Definition at line 39 of file Function.cpp.

References te::common::FreeContents().

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.

void te::da::Function::add ( Expression * arg )

It adds the argument to the function list of arguments.

Parameters

arg	The argument to be added.

Note: The Function will take the ownership of the given argument.

Definition at line 79 of file Function.cpp.

Referenced by te::map::QueryEncoder::getExpression(), te::da::ObjectIdSet::getExpression(), and te::map::QueryEncoder::visit().

te::da::Expression * te::da::Function::clone ( ) const

virtual

It creates a new copy of this expression.

Implements te::da::Expression.

Reimplemented in te::da::ST_Buffer, te::da::In, te::da::ST_DistanceBuffer, te::da::ST_Relate, te::da::LessThanOrEqualTo, te::da::ST_Contains, te::da::ST_Beyond, te::da::ST_DWithin, te::da::GreaterThan, te::da::GreaterThanOrEqualTo, te::da::LessThan, te::da::Mul, te::da::Not, te::da::NotEqualTo, te::da::Or, te::da::ST_Crosses, te::da::ST_Difference, te::da::ST_Disjoint, te::da::ST_EnvelopeIntersects, te::da::ST_Equals, te::da::ST_Intersection, te::da::ST_Intersects, te::da::ST_Overlaps, te::da::ST_Touches, te::da::ST_Transform, te::da::ST_Within, te::da::Sub, te::da::IsNull, te::da::Max, te::da::Min, te::da::ST_Union, te::da::StdDev, te::da::Sum, te::da::Variance, te::da::Like, te::da::UnaryFunction, te::da::UnaryOp, and te::da::Substring.

Definition at line 57 of file Function.cpp.

Referenced by te::da::FromFunctionCall::FromFunctionCall().

te::da::Expression * te::da::Function::getArg ( std::size_t i ) const

It returns the i-th function argument.

Parameters

i	The argument position.

Returns: The it-th function argument.

Definition at line 67 of file Function.cpp.

Referenced by te::da::SpatialRestrictionVisitor::getGeometryRestriction(), te::da::SpatialRestrictionVisitor::getPropertyName(), te::da::SpatialRestrictionVisitor::isFromEnvelope(), and te::serialize::xml::Save().

const std::string& te::da::Function::getName ( ) const

inline

It returns the function name.

Returns: The function name.

Definition at line 79 of file Function.h.

Referenced by te::da::AttributeRestrictionVisitor::getOperator(), te::da::SpatialRestrictionVisitor::getSpatialRelation(), te::da::AttributeRestrictionVisitor::isAttributeRestrictionFunction(), te::da::SpatialRestrictionVisitor::isSpatialRestrictionFunction(), te::serialize::xml::Save(), te::da::SpatialQueryProcessor::supportsSpatialTopologicOperatos(), and te::da::SQLVisitor::visit().

std::size_t te::da::Function::getNumArgs ( ) const

It returns the number of arguments informed to the function.

Returns: The number of parameters.

Definition at line 62 of file Function.cpp.

Referenced by te::da::SpatialRestrictionVisitor::getGeometryRestriction(), te::da::SpatialRestrictionVisitor::getPropertyName(), te::da::SpatialRestrictionVisitor::isFromEnvelope(), te::serialize::xml::Save(), te::da::FunctionNoArgsEncoder::toSQL(), te::da::BinaryOpEncoder::toSQL(), te::da::UnaryOpEncoder::toSQL(), te::da::FunctionEncoder::toSQL(), te::da::TemplateEncoder::toSQL(), te::da::AttributeRestrictionVisitor::visit(), te::da::SpatialRestrictionVisitor::visit(), and te::da::SQLVisitor::visit().

te::da::Function & te::da::Function::operator= ( const Function & rhs )

Assignment operator.

Definition at line 44 of file Function.cpp.

References te::common::Clone(), te::common::FreeContents(), m_args, and m_name.

Referenced by te::da::Substring::operator=(), te::da::Like::operator=(), te::da::UnaryFunction::operator=(), te::da::BinaryFunction::operator=(), te::da::ST_Transform::operator=(), te::da::ST_Relate::operator=(), te::da::ST_DistanceBuffer::operator=(), te::da::In::operator=(), and te::da::ST_Buffer::operator=().

te::da::Expression * te::da::Function::operator[] ( std::size_t i ) const

It returns the i-th function argument.

Parameters

i	The argument position.

Returns: The it-th function argument.

Definition at line 73 of file Function.cpp.

Member Data Documentation

std::vector<Expression*> te::da::Function::m_args

protected

The list of arguments.

Definition at line 118 of file Function.h.

Referenced by te::da::BinaryFunction::BinaryFunction(), Function(), te::da::Like::Like(), operator=(), te::da::ST_Buffer::ST_Buffer(), te::da::ST_DistanceBuffer::ST_DistanceBuffer(), te::da::ST_Relate::ST_Relate(), te::da::ST_Transform::ST_Transform(), te::da::Substring::Substring(), and te::da::UnaryFunction::UnaryFunction().

std::string te::da::Function::m_name

protected

The function name. May be an operator symbol or just a regular name like ST_Intersects.

Definition at line 117 of file Function.h.

Referenced by operator=().

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

/home/castejon/castejon_files/develop/terralib5/git/src/terralib/dataaccess/query/Function.h
/home/castejon/castejon_files/develop/terralib5/git/src/terralib/dataaccess/query/Function.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation