Public Types | Public Member Functions | Protected Attributes | List of all members
te::da::Function Class Referenceabstract

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

#include <Function.h>

Inheritance diagram for te::da::Function:
te::da::Expression te::common::BaseVisitable< QueryVisitor > te::da::BinaryFunction te::da::GeometryType te::da::In te::da::Like te::da::ST_Area te::da::ST_Buffer te::da::ST_Centroid te::da::ST_ConvexHull te::da::ST_DistanceBuffer te::da::ST_Envelope te::da::ST_Extent te::da::ST_IsClosed te::da::ST_IsEmpty te::da::ST_IsValid te::da::ST_Length te::da::ST_MakeValid te::da::ST_Multi te::da::ST_NPoints te::da::ST_Perimeter te::da::ST_Relate te::da::ST_StartPoint te::da::ST_Transform te::da::Substring te::da::UnaryFunction

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 dataaccess/query/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
nameThe function name.
Note
See FunctionNames.h for a list of common names.

Definition at line 60 of file dataaccess/query/Function.h.

Referenced by clone().

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

Copy constructor.

Definition at line 33 of file dataaccess/query/Function.cpp.

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

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

Virtual Destructor.

Definition at line 39 of file dataaccess/query/Function.cpp.

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

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.
void te::da::Function::add ( Expression *  arg)

It adds the argument to the function list of arguments.

Parameters
argThe argument to be added.
Note
The Function will take the ownership of the given argument.

Definition at line 79 of file dataaccess/query/Function.cpp.

References m_args.

Referenced by te::map::QueryEncoder::getExpression(), te::da::ObjectIdSet::getExpressionByInClause(), te::da::ObjectIdSet::setExpressionByInClause(), 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::ST_Area, te::da::ST_IsEmpty, te::da::ST_IsValid, te::da::ST_Length, te::da::ST_NPoints, te::da::ST_Perimeter, te::da::In, te::da::ST_DistanceBuffer, te::da::ST_Relate, te::da::ST_Centroid, te::da::ST_ConvexHull, te::da::ST_Envelope, te::da::ST_StartPoint, te::da::ST_IsClosed, te::da::ST_MakeValid, te::da::ST_Multi, te::da::ST_Extent, te::da::GeometryType, 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_AddPoint, 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_SetSRID, 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_Boundary, te::da::ST_Collect, te::da::ST_Dump, te::da::ST_DumpRings, te::da::ST_MakePolygon, te::da::ST_NumGeometries, 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 dataaccess/query/Function.cpp.

References Function().

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
iThe argument position.
Returns
The it-th function argument.

Definition at line 67 of file dataaccess/query/Function.cpp.

References m_args.

Referenced by te::qt::widgets::DataSetTableView::changeColumnData(), 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 dataaccess/query/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(), te::ogr::SQLVisitor::visit(), te::gpkg::SQLVisitor::visit(), te::da::SQLVisitor::visit(), and te::ado::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 dataaccess/query/Function.cpp.

References m_args.

Referenced by te::qt::widgets::DataSetTableView::changeColumnData(), te::da::ObjectIdSet::getExpressionByInClause(), te::da::SpatialRestrictionVisitor::getGeometryRestriction(), te::da::SpatialRestrictionVisitor::getPropertyName(), te::da::SpatialRestrictionVisitor::isFromEnvelope(), te::serialize::xml::Save(), te::da::ObjectIdSet::setExpressionByInClause(), te::da::FunctionNoArgsEncoder::toSQL(), te::da::UnaryOpEncoder::toSQL(), te::da::BinaryOpEncoder::toSQL(), te::da::FunctionEncoder::toSQL(), te::da::TemplateEncoder::toSQL(), te::ogr::SQLVisitor::visit(), te::gpkg::SQLVisitor::visit(), 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 dataaccess/query/Function.cpp.

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

Referenced by te::da::Like::operator=(), te::da::GeometryType::operator=(), te::da::ST_DistanceBuffer::operator=(), and te::da::In::operator=().

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

It returns the i-th function argument.

Parameters
iThe argument position.
Returns
The it-th function argument.

Definition at line 73 of file dataaccess/query/Function.cpp.

References m_args.

Member Data Documentation

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

The list of arguments.

Definition at line 118 of file dataaccess/query/Function.h.

Referenced by add(), te::da::BinaryFunction::BinaryFunction(), Function(), te::da::GeometryType::GeometryType(), getArg(), te::da::UnaryFunction::getArgument(), te::da::BinaryFunction::getFirst(), te::da::Substring::getLength(), getNumArgs(), te::da::BinaryFunction::getSecond(), te::da::Substring::getStartPosition(), te::da::Substring::getString(), te::da::Like::getString(), te::da::Like::Like(), operator=(), operator[](), te::da::UnaryFunction::setArgument(), te::da::BinaryFunction::setFirst(), te::da::Substring::setLength(), te::da::BinaryFunction::setSecond(), te::da::Substring::setStartPosition(), te::da::Substring::setString(), te::da::Like::setString(), te::da::ST_Area::ST_Area(), te::da::ST_Buffer::ST_Buffer(), te::da::ST_Centroid::ST_Centroid(), te::da::ST_ConvexHull::ST_ConvexHull(), te::da::ST_DistanceBuffer::ST_DistanceBuffer(), te::da::ST_Envelope::ST_Envelope(), te::da::ST_Extent::ST_Extent(), te::da::ST_IsClosed::ST_IsClosed(), te::da::ST_IsEmpty::ST_IsEmpty(), te::da::ST_IsValid::ST_IsValid(), te::da::ST_Length::ST_Length(), te::da::ST_MakeValid::ST_MakeValid(), te::da::ST_Multi::ST_Multi(), te::da::ST_NPoints::ST_NPoints(), te::da::ST_Perimeter::ST_Perimeter(), te::da::ST_Relate::ST_Relate(), te::da::ST_StartPoint::ST_StartPoint(), te::da::ST_Transform::ST_Transform(), te::da::Substring::Substring(), te::da::UnaryFunction::UnaryFunction(), and ~Function().

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 dataaccess/query/Function.h.

Referenced by operator=().

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