GdaQueryFieldField

GdaQueryFieldField — Represents one field of an entity (through a GdaQueryTarget object)

Functions

Properties

gchar * entry-plugin Read / Write
GdaEntityField * field Read / Write
gchar * field-id Write
gchar * field-name Read / Write
GdaQuery * query Read / Write / Construct Only
GdaQueryTarget * target Read / Write
gchar * target-id Write
gchar * target-name Write
GdaQueryField * value-provider Read / Write
gchar * value-provider-xml-id Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── GdaObject
        ╰── GdaQueryObject
            ╰── GdaQueryField
                ╰── GdaQueryFieldField

Implemented Interfaces

GdaQueryFieldField implements GdaXmlStorage, GdaEntityField, GdaRenderer and GdaReferer.

Description

Functions

gda_query_field_field_new ()

GdaQueryField *
gda_query_field_field_new (GdaQuery *query,
                           const gchar *field);

Creates a new GdaQueryFieldField object which represents a given field. field can be among the following forms:

  • field_name

  • table_name.field_name

Parameters

query

a GdaQuery in which the new object will be

 

field

the name of the field to represent

 

Returns

the new object


gda_query_field_field_get_ref_field_name ()

gchar *
gda_query_field_field_get_ref_field_name
                               (GdaQueryFieldField *field);

Get the real name of the represented field. The returned name can be in either forms:

  • field_name

  • table_name.field_name

Parameters

field

a GdaQueryFieldField object

 

Returns

represented field name (free the memory after usage)


gda_query_field_field_get_ref_field ()

GdaEntityField *
gda_query_field_field_get_ref_field (GdaQueryFieldField *field);

Get the real GdaEntityField object (well, the object which implements that interface) referenced by field

Parameters

field

a GdaQueryFieldField object

 

Returns

the GdaEntityField object, or NULL if field is not active


gda_query_field_field_get_target ()

GdaQueryTarget *
gda_query_field_field_get_target (GdaQueryFieldField *field);

Get the GdaQueryTarget object field 'belongs' to

Parameters

field

a GdaQueryFieldField object

 

Returns

the GdaQueryTarget object

Types and Values

GdaQueryFieldField

typedef struct _GdaQueryFieldField GdaQueryFieldField;

Property Details

The “entry-plugin” property

  “entry-plugin”             gchar *

Flags: Read / Write

Default value: NULL


The “field” property

  “field”                    GdaEntityField *

Flags: Read / Write


The “field-id” property

  “field-id”                 gchar *

Flags: Write

Default value: NULL


The “field-name” property

  “field-name”               gchar *

Flags: Read / Write

Default value: NULL


The “query” property

  “query”                    GdaQuery *

Flags: Read / Write / Construct Only


The “target” property

  “target”                   GdaQueryTarget *

Flags: Read / Write


The “target-id” property

  “target-id”                gchar *

Flags: Write

Default value: NULL


The “target-name” property

  “target-name”              gchar *

Flags: Write

Default value: NULL


The “value-provider” property

  “value-provider”           GdaQueryField *

Flags: Read / Write


The “value-provider-xml-id” property

  “value-provider-xml-id”    gchar *

Flags: Read / Write

Default value: NULL