summaryrefslogtreecommitdiffstats
path: root/qlparser/qtoperation.hh
blob: eab3d7e0be8d2b4301ad2ea90f966257eb5319a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
#ifndef _QTOPERATION_
#define _QTOPERATION_

#ifndef CPPSTDLIB
#include <ospace/string.h> // STL<ToolKit>
#else
#include <string>
#endif

#include "qlparser/qtnode.hh"

class QtData;  // forward declaration of a subclass of QtOperation

#include <iostream>

/*
* This file is part of rasdaman community.
*
* Rasdaman community is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Rasdaman community is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with rasdaman community.  If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009 Peter Baumann /
rasdaman GmbH.
*
* For more information please see <http://www.rasdaman.org>
* or contact Peter Baumann via <baumann@rasdaman.com>.
*/
/*************************************************************
 *
 *
 * COMMENTS:
 *
 ************************************************************/

//@ManMemo: Module: {\bf qlparser}

/*@Doc:

QtOperation defines a method {\tt evaluate()} getting a tupel of {\tt QtData} and returning
a {\tt QtData} element. Every subclass has to redefine this method to compute its specific
operation. Therefore, it takes its inputs which are also of type {\tt QtOperation}, and
invokes the {\tt evaluate()} method again. The results are used as operands and the
computed value is returned.

*/

class QtOperation : public QtNode
{
  public:
    /// default constructor
    QtOperation();

    /// constructor getting a pointer to the parent
    QtOperation( QtNode* parent );

    ///for associative law
    virtual QtOperation* getUniqueOrder( const QtNode::QtNodeType ID );

    /**
      The method gives back a node that has the same QtNodeType and has the lowest
      Spelling of all nodes in the subtree with the same QtNodeType.
    */

    /// method for evaluating the node
    virtual QtData* evaluate( QtDataList* inputList );

    /**
      The method takes the {\tt inputList} to compute the result of the node which is returned in the end.
      The semantics is that elements of the {\tt inputList} are not allowed to be used as a result because
      the {\tt inputList} is freed by the caller. If this is needed, they have to be copied.
    */

    /// optimizing load access
    virtual void optimizeLoad( QtTrimList* trimList );

    /// type checking of the subtree
    virtual const QtTypeElement& checkType( QtTypeTuple* typeTuple = NULL );
    /**
      The method triggers type checking of the node's subtree. If an error occurs, an exception
      is raised. 
    */

    //@Man: Read/Write methods
    //@{
    ///
      /// 
      inline void                 setDataStreamType( const QtTypeElement& type );
      ///
      inline const QtTypeElement& getDataStreamType() const;
    ///
    //@}

    void printTree( int tab, std::ostream& s, QtChildType mode=QT_ALL_NODES );
    
    void printAlgebraicExpression( std::ostream& s );

  protected:
    /// result type of the node
    QtTypeElement dataStreamType;

  private:
	/// atribute for indetification of nodes
	static const QtNodeType nodeType;	
};

#include "qlparser/qtoperation.icc"

#endif