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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/* mg-query.h
*
* Copyright (C) 2003 Vivien Malerba
*
* This program 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 2 of the
* License, or (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
#ifndef __MG_QUERY_H_
#define __MG_QUERY_H_
#include "mg-base.h"
#include "mg-defs.h"
#include <libgda/libgda.h>
G_BEGIN_DECLS
#define MG_QUERY_TYPE (mg_query_get_type())
#define MG_QUERY(obj) G_TYPE_CHECK_INSTANCE_CAST (obj, mg_query_get_type(), MgQuery)
#define MG_QUERY_CLASS(klass) G_TYPE_CHECK_CLASS_CAST (klass, mg_query_get_type (), MgQueryClass)
#define IS_MG_QUERY(obj) G_TYPE_CHECK_INSTANCE_TYPE (obj, mg_query_get_type ())
/* interfaces:
* MgEntity
* MgXmlStorage
* MgReferer
* MgRenderer
*/
/* error reporting */
extern GQuark mg_query_error_quark (void);
#define MG_QUERY_ERROR mg_query_error_quark ()
/* different possible types for a query */
typedef enum {
MG_QUERY_TYPE_SELECT,
MG_QUERY_TYPE_INSERT,
MG_QUERY_TYPE_UPDATE,
MG_QUERY_TYPE_DELETE,
MG_QUERY_TYPE_UNION,
MG_QUERY_TYPE_INTERSECT,
MG_QUERY_TYPE_EXCEPT,
MG_QUERY_TYPE_NON_PARSED_SQL
} MgQueryType;
enum
{
MG_QUERY_XML_LOAD_ERROR,
MG_QUERY_META_DATA_UPDATE,
MG_QUERY_FIELDS_ERROR,
MG_QUERY_TARGETS_ERROR,
MG_QUERY_RENDER_ERROR,
MG_QUERY_PARSE_ERROR,
MG_QUERY_SYNTAX_ERROR,
MG_QUERY_STRUCTURE_ERROR,
MG_QUERY_SQL_ANALYSE_ERROR
};
/* struct for the object's data */
struct _MgQuery
{
MgBase object;
MgQueryPrivate *priv;
};
/* struct for the object's class */
struct _MgQueryClass
{
MgBaseClass class;
/* signals */
void (*type_changed) (MgQuery *query);
void (*condition_changed) (MgQuery *query);
void (*target_added) (MgQuery *query, MgTarget *target);
void (*target_removed) (MgQuery *query, MgTarget *target);
void (*target_updated) (MgQuery *query, MgTarget *target);
void (*join_added) (MgQuery *query, MgJoin *join);
void (*join_removed) (MgQuery *query, MgJoin *join);
void (*join_updated) (MgQuery *query, MgJoin *join);
void (*sub_query_added) (MgQuery *query, MgQuery *sub_query);
void (*sub_query_removed) (MgQuery *query, MgQuery *sub_query);
void (*sub_query_updated) (MgQuery *query, MgQuery *sub_query);
};
guint mg_query_get_type (void);
GObject *mg_query_new (MgConf *conf);
GObject *mg_query_new_copy (MgQuery *orig, GHashTable *replacements);
GObject *mg_query_new_from_sql (MgConf *conf, const gchar *sql, GError **error);
void mg_query_set_query_type (MgQuery *query, MgQueryType type);
MgQueryType mg_query_get_query_type (MgQuery *query);
const gchar *mg_query_get_query_type_string (MgQuery *query);
gboolean mg_query_is_select_query (MgQuery *query);
gboolean mg_query_is_modif_query (MgQuery *query);
MgQuery *mg_query_get_parent_query (MgQuery *query);
gboolean mg_query_is_equal_to (MgQuery *query, MgQuery *compare_to);
/* if SQL queries */
void mg_query_set_sql_text (MgQuery *query, const gchar *sql, GError **error);
const gchar *mg_query_get_sql_text (MgQuery *query);
/* for other types of queries */
GSList *mg_query_get_sub_queries (MgQuery *query);
void mg_query_add_sub_query (MgQuery *query, MgQuery *sub_query);
void mg_query_del_sub_query (MgQuery *query, MgQuery *sub_query);
void mg_query_add_param_source (MgQuery *query, MgQuery *param_source);
void mg_query_del_param_source (MgQuery *query, MgQuery *param_source);
const GSList *mg_query_get_param_sources (MgQuery *query);
gboolean mg_query_add_target (MgQuery *query, MgTarget *target, GError **error);
void mg_query_del_target (MgQuery *query, MgTarget *target);
GSList *mg_query_get_targets (MgQuery *query);
MgTarget *mg_query_get_target_by_xml_id (MgQuery *query, const gchar *xml_id);
MgTarget *mg_query_get_target_by_alias (MgQuery *query, const gchar *alias_or_name);
GSList *mg_query_get_target_pkfields (MgQuery *query, MgTarget *target);
GSList *mg_query_get_joins (MgQuery *query);
MgJoin *mg_query_get_join_by_targets (MgQuery *query, MgTarget *target1, MgTarget *target2);
gboolean mg_query_add_join (MgQuery *query, MgJoin *join);
void mg_query_del_join (MgQuery *query, MgJoin *join);
void mg_query_set_condition (MgQuery *query, MgCondition *cond);
MgCondition *mg_query_get_condition (MgQuery *query);
GSList *mg_query_get_main_conditions (MgQuery *query);
void mg_query_set_order_by_field (MgQuery *query, MgQfield *field, gint order, gboolean ascendant);
gint mg_query_get_order_by_field (MgQuery *query, MgQfield *field, gboolean *ascendant);
/* utility functions */
MgQfield *mg_query_get_field_by_sql_naming (MgQuery *query, const gchar *sql_naming);
MgQfield *mg_query_get_visible_field_by_ref_field (MgQuery *query, MgTarget *target, MgField *ref_field);
MgQfield *mg_query_get_any_field_by_ref_field (MgQuery *query, MgTarget *target, MgField *ref_field);
GSList *mg_query_expand_all_field (MgQuery *query, MgTarget *target);
void mg_query_order_fields_using_join_conds (MgQuery *query);
GSList *mg_query_get_fields_by_target (MgQuery *query, MgTarget *target, gboolean visible_fields_only);
G_END_DECLS
#endif
|
