midgard/query_builder.h

/*
 * Copyright (c) 2005 Jukka Zitting <jz@yukatan.fi>
 * Copyright (c) 2005 Piotr Pokora <piotr.pokora@infoglob.pl>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser 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 MIDGARD_QUERY_BUILDER_H
#define MIDGARD_QUERY_BUILDER_H

#include "midgard/midgard_connection.h"

/* convention macros */
#define MIDGARD_TYPE_QUERY_BUILDER (midgard_query_builder_get_type())
#define MIDGARD_QUERY_BUILDER(object)  \
        (G_TYPE_CHECK_INSTANCE_CAST ((object),MIDGARD_TYPE_QUERY_BUILDER, MidgardQueryBuilder))
#define MIDGARD_QUERY_BUILDER_CLASS(klass)  \
        (G_TYPE_CHECK_CLASS_CAST ((klass), MIDGARD_TYPE_QUERY_BUILDER, MidgardQueryBuilderClass))
#define MIDGARD_IS_QUERY_BUILDER(object)   \
        (G_TYPE_CHECK_INSTANCE_TYPE ((object), MIDGARD_QUERY_BUILDER))
#define MIDGARD_IS_QUERY_BUILDER_CLASS(klass) \
        (G_TYPE_CHECK_CLASS_TYPE ((klass), MIDGARD_TYPE_QUERY_BUILDER))
#define MIDGARD_QUERY_BUILDER_GET_CLASS(obj) \
        (G_TYPE_INSTANCE_GET_CLASS ((obj), MIDGARD_TYPE_QUERY_BUILDER, MidgardQueryBuilderClass))

typedef struct MidgardQueryBuilder MidgardQueryBuilder;

/* FIXME! Implement MidgardQueryBuilderPrivate! */
struct MidgardQueryBuilder {
        GObject parent;
        midgard *mgd;
        GType parent_type; /* parent for metadata, attachment, parameter */
        GType ext_type; /* metadata, attachment, parameter */
        GType type;
        GList *types;
        MgdSchemaTypeAttr *schema;
        GSList *stack;
        GArray *orders;
        guint offset;
        guint limit;
        gint lang;
        gint default_lang;
        gboolean unset_lang;
        gboolean include_deleted;
        gchar *tables;
        const gchar *link;
        GString *join;
        gint error;
};

typedef struct MidgardQueryBuilderClass MidgardQueryBuilderClass;

struct MidgardQueryBuilderClass{
        GObjectClass parent;

        void (*set_lang) (
                MidgardQueryBuilder *builder, gint lang);

        void (*unset_languages) (
                MidgardQueryBuilder *builder);
        
        gboolean (*add_constraint) (
                MidgardQueryBuilder *builder,
                const gchar *name, const gchar *op, const GValue *value);
        
        gboolean (*begin_group) (
                MidgardQueryBuilder *builder, const gchar *type);

        gboolean (*end_group) (
                MidgardQueryBuilder *builder);

        gboolean (*add_order) (
                MidgardQueryBuilder *builder, 
                const gchar *name, const gchar *dir);

        void (*set_offset) (
                MidgardQueryBuilder *builder, guint offset);

        void (*set_limit) (
                MidgardQueryBuilder *builder, guint limit);

        GObject **(*execute) (
                MidgardQueryBuilder *builder, guint *n_objects);

        guint (*count) (
                MidgardQueryBuilder *builder);
};

extern GType midgard_query_builder_get_type(void);

extern MidgardQueryBuilder *midgard_query_builder_new(
        midgard *mgd, const gchar *classname);

extern void midgard_query_builder_free(MidgardQueryBuilder *builder);

extern void midgard_query_builder_set_lang(
        MidgardQueryBuilder *builder, gint lang);

extern void midgard_query_builder_unset_languages(
        MidgardQueryBuilder *builder);

extern gboolean midgard_query_builder_add_constraint(
        MidgardQueryBuilder *builder,
        const gchar *name, const gchar *op, const GValue *value);

extern gboolean midgard_query_builder_begin_group(
        MidgardQueryBuilder *builder, const gchar *type);

extern gboolean midgard_query_builder_end_group(MidgardQueryBuilder *builder);

extern gboolean midgard_query_builder_add_order(
        MidgardQueryBuilder *builder, const gchar *name, const gchar *dir);

extern void midgard_query_builder_set_offset(
        MidgardQueryBuilder *builder, guint offset);

extern void midgard_query_builder_set_limit(
        MidgardQueryBuilder *builder, guint limit);

extern GObject **midgard_query_builder_execute(
        MidgardQueryBuilder *builder, guint *n_objects);

extern guint midgard_query_builder_count(MidgardQueryBuilder *builder); 


gboolean midgard_query_builder_join(
                MidgardQueryBuilder *builder, const gchar *prop,
                const gchar *jobject, const gchar *jprop);
GList *midgard_query_builder_get_guid(MidgardQueryBuilder *builder);

const gchar *midgard_query_builder_get_type_name(MidgardQueryBuilder *builder);

extern void midgard_query_builder_include_deleted(MidgardQueryBuilder *builder);

#endif

---