FunctionNoArgsEncoder.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/dataaccess/query/FunctionNoArgsEncoder.h
22 
23  \brief A query encoder for functions with no arguments that is invoked just by its name.
24 */
25 
26 #ifndef __TERRALIB_DATAACCESS_INTERNAL_FUNCTIONNOARGSENCODERENCODER_H
27 #define __TERRALIB_DATAACCESS_INTERNAL_FUNCTIONNOARGSENCODERENCODER_H
28 
29 // TerraLib
30 #include "SQLFunctionEncoder.h"
31 
32 namespace te
33 {
34  namespace da
35  {
36  /*!
37  \class FunctionNoArgsEncoder
38 
39  \brief An SQL encoder for functions with no arguments that is invoked just by its name.
40 
41  It encodes a function using just its name, following this convention: function-name.
42 
43  \sa Function, TemplateEncoder, SQLFunctionEncoder, BinaryOpEncoder, UnaryOpEncoder, FunctionEncoder
44  */
46  {
47  public:
48 
49  /*!
50  \brief Constructor.
51 
52  \param name The function alias as understood by some data source implmentation.
53  */
54  FunctionNoArgsEncoder(const std::string& name) : SQLFunctionEncoder(name) {}
55 
56  /*! \brief Destructor. */
58 
59  /*!
60  \brief It encodes the function to a SQL notation.
61 
62  This method will encode the function in prefix unary operator notation: (op operand).
63  For example, the '-' function is encoded as: -A.
64 
65  \param f The function to be translated to a SQL notation.
66  \param buff The destination string buffer where the translation will be written.
67  \param v The SQL visitor that will be used to visit the arguments expression.
68  */
69  void toSQL(const Function& f,
70  std::string& buff,
71  SQLVisitor& v) const;
72  };
73 
74  } // end namespace da
75 } // end namespace te
76 
77 #endif // __TERRALIB_DATAACCESS_INTERNAL_FUNCTIONNOARGSENCODERENCODER_H
78 
A base class for encoders of SQL function expressions.
An SQL encoder for functions with no arguments that is invoked just by its name.
URI C++ Library.
A class that models a Function expression.
Definition: Function.h:47
FunctionNoArgsEncoder(const std::string &name)
Constructor.
A visitor for building an SQL statement from a given Query hierarchy.
Definition: SQLVisitor.h:58
#define TEDATAACCESSEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:97
A base class for encoders of SQL function expressions.