![]() |
![]() |
![]() |
GNOME Data Access manual | ![]() |
---|
GdaEntityGdaEntity — Interface to represent a generic entity (for tables, views or queries) |
GdaEntity; gboolean gda_entity_has_field (GdaEntity *iface, GdaEntityField *field); GSList* gda_entity_get_fields (GdaEntity *iface); gint gda_entity_get_n_fields (GdaEntity *iface); GdaEntityField* gda_entity_get_field_by_name (GdaEntity *iface, const gchar *name); GdaEntityField* gda_entity_get_field_by_xml_id (GdaEntity *iface, const gchar *xml_id); GdaEntityField* gda_entity_get_field_by_index (GdaEntity *iface, gint index); gint gda_entity_get_field_index (GdaEntity *iface, GdaEntityField *field); void gda_entity_add_field (GdaEntity *iface, GdaEntityField *field); void gda_entity_add_field_before (GdaEntity *iface, GdaEntityField *field, GdaEntityField *field_before); void gda_entity_swap_fields (GdaEntity *iface, GdaEntityField *field1, GdaEntityField *field2); void gda_entity_remove_field (GdaEntity *iface, GdaEntityField *field); gboolean gda_entity_is_writable (GdaEntity *iface); GSList* gda_entity_get_parameters (GdaEntity *iface); GdaParameterList* gda_entity_get_param_list (GdaEntity *iface);
"field-added" void user_function (GdaEntity *gdaentity, gpointer arg1, gpointer user_data); "field-removed" void user_function (GdaEntity *gdaentity, gpointer arg1, gpointer user_data); "field-updated" void user_function (GdaEntity *gdaentity, gpointer arg1, gpointer user_data); "fields-order-changed" void user_function (GdaEntity *gdaentity, gpointer user_data);
gboolean gda_entity_has_field (GdaEntity *iface, GdaEntityField *field);
Tells if field
belongs to the iface
entity
iface : |
an object implementing the GdaEntity interface |
field : |
an object implementing the GdaEntityField interface |
Returns : | TRUE if field belongs to the iface entity
|
GSList* gda_entity_get_fields (GdaEntity *iface);
Get a new list containing all the GdaEntityField objects held within the object implementing the GdaEntity interface.
The returned list nodes are in the order in which the fields are within the entity.
iface : |
an object implementing the GdaEntity interface |
Returns : | the new list. |
gint gda_entity_get_n_fields (GdaEntity *iface);
Get the number of fields in iface
iface : |
an object implementing the GdaEntity interface |
Returns : | the number of fields, or -1 if an error occured |
GdaEntityField* gda_entity_get_field_by_name (GdaEntity *iface, const gchar *name);
Get a GdaEntityField using its name. The notion of "field name" is the
string returned by gda_entity_field_get_name()
on each of the fields composing iface
.
However, if that definition does not return any field, then each particular
implementation of iface
may try to give an extra definition to the notion of
"field name".
For instance, in the case of the GdaQuery object, the gda_entity_field_get_name()
is used
as a first try to find a field, and if that fails, then the object tries to find
fields from their SQL naming.
In the case where there can be more than one field with the same name (depending on
iface
's implementation), then the returned value is NULL
.
iface : |
an object implementing the GdaEntity interface |
name : |
|
Returns : | the requested GdaEntityField or NULL if the field cannot be found, or if
more than one field has been found.
|
GdaEntityField* gda_entity_get_field_by_xml_id (GdaEntity *iface, const gchar *xml_id);
iface : |
an object implementing the GdaEntity interface |
xml_id : |
|
Returns : | the requested GdaEntityField |
GdaEntityField* gda_entity_get_field_by_index (GdaEntity *iface, gint index);
iface : |
an object implementing the GdaEntity interface |
index : |
|
Returns : | the requested GdaEntityField or NULL if the index is out of bounds |
gint gda_entity_get_field_index (GdaEntity *iface, GdaEntityField *field);
Get the position of the field in the given entity. Positions start at 0.
field
MUST be a visible field.
iface : |
an object implementing the GdaEntity interface |
field : |
an object implementing the GdaEntityField interface |
Returns : | the position or -1 if the field is not in the entity or is not visible |
void gda_entity_add_field (GdaEntity *iface, GdaEntityField *field);
Add field
to iface
's fields (at the end of the list)
iface : |
an object implementing the GdaEntity interface |
field : |
an object implementing the GdaEntityField interface to add |
void gda_entity_add_field_before (GdaEntity *iface, GdaEntityField *field, GdaEntityField *field_before);
Add field
to iface
's fields, before field_before
if it is not NULL
,
or at the end if field_before
is NULL
.
iface : |
an object implementing the GdaEntity interface |
field : |
an object implementing the GdaEntityField interface to add |
field_before : |
an object implementing the GdaEntityField interface before which field will be added, or NULL
|
void gda_entity_swap_fields (GdaEntity *iface, GdaEntityField *field1, GdaEntityField *field2);
iface : |
an object implementing the GdaEntity interface |
field1 : |
an object implementing the GdaEntityField interface |
field2 : |
an object implementing the GdaEntityField interface |
void gda_entity_remove_field (GdaEntity *iface, GdaEntityField *field);
iface : |
an object implementing the GdaEntity interface |
field : |
an object implementing the GdaEntityField interface to remove |
gboolean gda_entity_is_writable (GdaEntity *iface);
Tells if the real entity (the corresponding DBMS object) represented by iface
can be written to.
iface : |
an object implementing the GdaEntity interface |
Returns : | TRUE if it is possible to write to iface
|
GSList* gda_entity_get_parameters (GdaEntity *iface);
Get a list of parameters required before iface
can be used. Usualy this function is used with queries
to grab the required parameters before executing a query.
This function is usually not used directly, but rather through gda_entity_get_param_list()
.
iface : |
an object implementing the GdaEntity interface |
Returns : | a new list of GdaParameter objects. iface DOES NOT hold any reference to any of the listed parameter.
|
GdaParameterList* gda_entity_get_param_list (GdaEntity *iface);
Creates a new GdaParameterList object which contains all the parameters required to use iface
.
This function is similar to gda_entity_get_parameters()
except that it also creates a
GdaParameterList object to help manage all the parameters, and does nothing (and returns NULL) if
no parameter is required to use iface
.
iface : |
an object implementing the GdaEntity interface |
Returns : | a new GdaParameterList object, or NULL if no parameter is required
|
void user_function (GdaEntity *gdaentity, gpointer arg1, gpointer user_data);
dbentity : |
the object which received the signal. |
arg1 : |
|
user_data : |
user data set when the signal handler was connected. |
void user_function (GdaEntity *gdaentity, gpointer arg1, gpointer user_data);
dbentity : |
the object which received the signal. |
arg1 : |
|
user_data : |
user data set when the signal handler was connected. |
void user_function (GdaEntity *gdaentity, gpointer arg1, gpointer user_data);
dbentity : |
the object which received the signal. |
arg1 : |
|
user_data : |
user data set when the signal handler was connected. |
void user_function (GdaEntity *gdaentity, gpointer user_data);
dbentity : |
the object which received the signal. |
user_data : |
user data set when the signal handler was connected. |
<< List of lesser used interfaces | GdaEntityField >> |