Back to Seed Clases

Midgard

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Midgard.QueryBuilder
Midgard.Collector

Class Midgard.Collector

Import line:	Midgard = imports.gi.Midgard;
GIR File:	Midgard-10.05.gir
C documentation:	MidgardCollector
Class :	Collector
Extends:	Midgard.QueryBuilder
	Show / Hide Inherited methods, properties and signals

Properties
Properties		Defined By
	parent : Midgard.QueryBuilder read only	Midgard.Collector
	priv : Midgard.CollectorPrivate read only	Midgard.Collector

Methods / Constructors
Method / Constructor		Defined By
	new Midgard.Collector (Object *properties) Create a new Midgard.Collector Create a new Midgard.Collector Parameters: Object properties*
	new Midgard.Collector.c_new (Connection *mgd, String typename, String domain, Value value) : Midgard.Collector Create a new Midgard.Collector Create a new Midgard.Collector Parameters: Midgard.Connection mgd* Required (not null) String typename Required (not null) String domain Required (not null) GObject.Value value Required (not null) Returns: Midgard.Collector
	add_constraint (String *name, String op, Value value) : Boolean Parameters: String name* Required (not null) String op Required (not null) GObject.Value value Required (not null) Returns: Boolean	Midgard.Collector
	add_constraint_with_property (String *property_a, String op, String property_b) : Boolean Parameters: String property_a* Required (not null) String op Required (not null) String property_b Required (not null) Returns: Boolean	Midgard.Collector
	add_order (String *name, String dir) : Boolean Parameters: String name* Required (not null) String dir Required (not null) Returns: Boolean	Midgard.Collector
	add_value_property (String *value) : Boolean Cases to return FALSE: Number of value properties added to Midgard Collector is limited by the number of properties registered for type which has been initialized for the given MidgardCollector* instance. Cases to return FALSE: Number of value properties added to Midgard Collector is limited by the number of properties registered for type which has been initialized for the given MidgardCollector instance. Parameters: String value Required (not null) Returns: Boolean	Midgard.Collector
	begin_group (String *type) : Boolean Parameters: String type* Required (not null) Returns: Boolean	Midgard.Collector
	count () : none Returns: none	Midgard.Collector
	end_group () : Boolean Returns: Boolean	Midgard.Collector
	execute () : Boolean Executes SQL query and set internal keys&values collection. Executes SQL query and set internal keys&values collection. Overwritten MidgardQueryBuilder execute method. Unlike QB's execute method this one returns boolean value. Resultset is stored inernally by MidgardCollector instance. Cases to return FALSE: No key is associated, midgard_collector_set_key_property() No value property is associated, midgard_collector_add_value_property() Database provider returned SQL query syntax error No record(s) matched Returns: Boolean	Midgard.Collector
	get (String *key) : GLib.Data GData keys ( collector's subkeys ) are inserted to GData as Quarks , so you must call g_quark_to_string if you need to get strings ( e.g. GData keys ( collector's subkeys ) are inserted to GData as Quarks , so you must call g_quark_to_string if you need to get strings ( e.g. implementing hash table for language bindings ). Parameters: String key* Required (not null) Returns: GLib.Data	Midgard.Collector
	get_subkey (String *key, String subkey) : GObject.Value Parameters: String key* Required (not null) String subkey Required (not null) Returns: GObject.Value	Midgard.Collector
	get_type_name () : String Returns type name of the type which is currently used by Query Builder. Returns type name of the type which is currently used by Query Builder. This function should be used on language binding level , when internal Query Builder's instance is already created and language binding object should be instanciated. Returned type name is a pointer and is owned by GLib system. Caller shouldn't free it. Returns: String	Midgard.QueryBuilder
	include_deleted () : Boolean Returns: Boolean	Midgard.Collector
	list_keys () : Array Returns: Array	Midgard.Collector
	merge (Collector mc, Boolean *overwrite) : Boolean If third overwrite parameter is set as TRUE then all keys which exists in self* and mc collector's instance will be oberwritten in self colection instance. If third overwrite parameter is set as TRUE then all keys which exists in self and mc collector's instance will be oberwritten in self colection instance. If set as FALSE , only those keys will be added, which do not exist in self collection and exist in mc collection. Cases to return FALSE: Second argument is not valid MidgardCollector Parameters: Midgard.Collector mc Required (not null) Boolean overwrite Required (not null) Returns: Boolean	Midgard.Collector
	remove_key (String *key) : Boolean Removes key and associated value from the given MidgardCollector* instance. Removes key and associated value from the given MidgardCollector instance. Parameters: String key Required (not null) Returns: Boolean has been removed from collection, FALSE otherwise	Midgard.Collector
	set (String *key, String subkey, Value value) : Boolean Cases to return FALSE: If the key is already added to MidgardCollector then its value (as subkey&value pair) is destroyed and new one is set. Cases to return FALSE: If the key is already added to MidgardCollector then its value (as subkey&value pair) is destroyed and new one is set. In other case new key and its subkey&value pair is added to collector. Key used in this function is a value returned ( or set ) for collector's key. Keys are collection of values returned from property fields. Subkey is an explicit property name. GValue value* argument is owned by MidgardCollector. If value should be reused, its copy should be passed as method argument. Parameters: String key Required (not null) String subkey Required (not null) GObject.Value value Required (not null) Returns: Boolean	Midgard.Collector
	set_key_property (String *key, Value value) : Boolean Parameters: String key* Required (not null) GObject.Value value Required (not null) Returns: Boolean	Midgard.Collector
	set_limit (Number *limit) : none Parameters: Number limit* Required (not null) Returns: none	Midgard.Collector
	set_offset (Number *offset) : none Parameters: Number offset* Required (not null) Returns: none	Midgard.Collector

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	execution_end (QueryBuilder *self) : none Parameters: Midgard.QueryBuilder self* Returns: {none}	Midgard.QueryBuilder
	execution_start (QueryBuilder *self) : none Parameters: Midgard.QueryBuilder self* Returns: {none}	Midgard.QueryBuilder

Un-official Seed Documentation

Midgard

Classes

Interfaces

Structs

Unions

Enums

Class Midgard.Collector