QueryLayer.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/maptools/QueryLayer.h
22 
23  \brief A layer resulting from a query.
24 */
25 
26 #ifndef __TERRALIB_MAPTOOLS_INTERNAL_QUERYLAYER_H
27 #define __TERRALIB_MAPTOOLS_INTERNAL_QUERYLAYER_H
28 
29 // TerraLib
30 #include "AbstractLayer.h"
31 
32 namespace te
33 {
34 // Forward declaration
35  namespace da { class Select; }
36 
37  namespace map
38  {
39  /*!
40  \class QueryLayer
41 
42  \brief A layer resulting from a query.
43 
44  A QueryLayer is a reference to a dataset that will result from a query to a data source.
45 
46  \ingroup map
47 
48  \sa AbstractLayer, DataSetLayer, RasterLayer, FolderLayer
49  */
51  {
52  public:
53 
54  /*!
55  \brief It initializes a new layer.
56 
57  \param parent The parent layer (NULL if it has no parent).
58  */
59  QueryLayer(AbstractLayer* parent = 0);
60 
61  /*!
62  \brief It initializes a new layer.
63 
64  \param id The layer id.
65  \param parent The parent layer (NULL if it has no parent).
66  */
67  QueryLayer(const std::string& id, AbstractLayer* parent = 0);
68 
69  /*!
70  \brief It initializes a new layer.
71 
72  \param id The layer id.
73  \param title The title is a brief description about the layer.
74  \param parent The parent layer (NULL if it has no parent).
75  */
76  QueryLayer(const std::string& id, const std::string& title, AbstractLayer* parent = 0);
77 
78  /*! \brief Destructor. */
79  ~QueryLayer();
80 
81  std::auto_ptr<LayerSchema> getSchema() const;
82 
83  std::auto_ptr<te::da::DataSet> getData(te::common::TraverseType travType = te::common::FORWARDONLY,
84  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
85 
86  std::auto_ptr<te::da::DataSet> getData(const std::string& propertyName,
87  const te::gm::Envelope* e,
90  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
91 
92  std::auto_ptr<te::da::DataSet> getData(const std::string& propertyName,
93  const te::gm::Geometry* g,
96  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
97 
98  std::auto_ptr<te::da::DataSet> getData(te::da::Expression* restriction,
100  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
101 
102  std::auto_ptr<te::da::DataSet> getData(const te::da::ObjectIdSet* oids,
104  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
105 
106  bool isValid() const;
107 
108  void draw(Canvas* canvas, const te::gm::Envelope& bbox, int srid, const double& scale);
109 
110  /*!
111  \brief It returns the layer type: QUERY_LAYER.
112 
113  \return The layer type: QUERY_LAYER.
114  */
115  const std::string& getType() const;
116 
117  /*!
118  \brief
119 
120  \return
121  */
122  te::da::Select* getQuery() const;
123 
124  /*!
125  \brief
126 
127  \return
128  */
129  std::string getQueryAsString() const;
130 
131  /*!
132  \brief
133 
134  \param name
135  */
136  void setQuery(te::da::Select* s);
137 
138  /*!
139  \brief
140 
141  \return
142  */
143  const std::string& getRendererType() const;
144 
145  /*!
146  \brief
147 
148  \param t
149  */
150  void setRendererType(const std::string& t);
151 
152  void computeExtent();
153 
154  private:
155 
156  std::auto_ptr<te::da::DataSet> getData(te::da::Select* query,
158  const te::common::AccessPolicy accessPolicy = te::common::RAccess) const;
159 
160  private:
161 
162  std::string m_rendererType; //!< A pointer to the internal renderer used to paint this layer.
163  te::da::Select* m_query; //!< The dataset name where we will retrieve the layer objects.
164 
165  static const std::string sm_type; //!< A static data member used in the implementation of getType method.
166  };
167 
168  typedef boost::intrusive_ptr<QueryLayer> QueryLayerPtr;
169 
170  } // end namespace map
171 } // end namespace te
172 
173 #endif // __TERRALIB_MAPTOOLS_INTERNAL_QUERYLAYER_H
te::da::Select * m_query
The dataset name where we will retrieve the layer objects.
Definition: QueryLayer.h:163
This is the base class for layers.
Definition: AbstractLayer.h:76
This is the base class for Layers.
SpatialRelation
Spatial relations between geometric objects.
Definition: Enums.h:127
A layer resulting from a query.
Definition: QueryLayer.h:50
This is an abstract class that models a query expression.
Definition: Expression.h:47
AccessPolicy
Supported data access policies (can be used as bitfield).
Definition: Enums.h:40
TraverseType
A dataset can be traversed in two ways:
Definition: Enums.h:53
An Envelope defines a 2D rectangular region.
Definition: Envelope.h:51
This class represents a set of unique ids created in the same context. i.e. from the same data set...
Definition: ObjectIdSet.h:55
URI C++ Library.
#define TEMAPEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:60
Geometry is the root class of the geometries hierarchy, it follows OGC and ISO standards.
Definition: Geometry.h:73
A Select models a query to be used when retrieving data from a DataSource.
Definition: Select.h:65
A canvas is an abstraction of a drawing area.
Definition: Canvas.h:92
std::string m_rendererType
A pointer to the internal renderer used to paint this layer.
Definition: QueryLayer.h:162
boost::intrusive_ptr< QueryLayer > QueryLayerPtr
Definition: QueryLayer.h:168
static const std::string sm_type
A static data member used in the implementation of getType method.
Definition: QueryLayer.h:165