QueryGraphBuilder.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 QueryGraphBuilder.h
22 
23  \brief This class defines the Query strategy to build a graph having
24  a exist graph as input parameters.
25 
26  The query must be defined using only the terralib Query module
27  elements.
28 */
29 
30 #ifndef __TERRALIB_GRAPH_INTERNAL_QUERYGRAPHBUILDER_H
31 #define __TERRALIB_GRAPH_INTERNAL_QUERYGRAPHBUILDER_H
32 
33 // Terralib Includes
34 #include "../Config.h"
35 #include "AbstractGraphBuilder.h"
36 
37 // STL Includes
38 #include <vector>
39 #include <map>
40 
41 namespace te
42 {
43  // Forward declarations
44  namespace da { class Expression; }
45 
46  namespace graph
47  {
48 
49  /*!
50  \class QueryGraphBuilder
51 
52  \brief This class defines the Query strategy to build a graph having
53  a exist graph as input parameters.
54 
55  The query must be defined using only the terralib Query module
56  elements.
57 
58  \sa AbstractGraphBuilder
59  */
60 
62  {
63  public:
64 
65  /*! \brief Default constructor. */
67 
68  /*! \brief Virtual destructor. */
69  virtual ~QueryGraphBuilder();
70 
71 
72  /** @name Methods
73  * Methods used by this builder
74  */
75  //@{
76 
77 
78  /*!
79  \brief Function used to generated the vertex id based on raster coordenate
80 
81  \param g Inpput graph
82  \param e Expression tha defines a query
83  \param dsInfo Container with data source information
84  \param graphType Attribute used to define the output graph type
85  \param gInfo Container with graph generation parameters
86 
87  \return True if the graph was correctly generated and false in other case.
88 
89  */
90  bool build(te::graph::AbstractGraph* g, te::da::Expression* eEdge, te::da::Expression* eVertex, const std::map<std::string, std::string>& dsInfo, const std::string& graphType, const std::map<std::string, std::string>& gInfo);
91 
92  //@}
93  };
94  } // end namespace graph
95 } // end namespace te
96 
97 #endif // __TERRALIB_GRAPH_INTERNAL_QUERYGRAPHBUILDER_H
#define TEGRAPHEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:178
This is an abstract class that models a query expression.
Definition: Expression.h:47
This abstract class provides the common functions for graph builder classes. Each builder strategy ha...
Abstract class used to define the main functions of graph struct. All graph implementations must used...
Definition: AbstractGraph.h:55
URI C++ Library.
This abstract class provides the common functions for graph builder classes. Each builder strategy ha...
This class defines the Query strategy to build a graph having a exist graph as input parameters...