<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libgdamm: Gnome::Gda::MetaStruct Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libgdamm <span id="projectnumber">4.1.3</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGnome.html">Gnome</a> </li>
<li class="navelem"><a class="el" href="namespaceGnome_1_1Gda.html">Gda</a> </li>
<li class="navelem"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html">MetaStruct</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Gnome::Gda::MetaStruct Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Gnome::Gda::MetaStruct" --><!-- doxytag: inherits="Glib::Object" -->
<p>In-memory representation of some database objects. <a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Gnome::Gda::MetaStruct:</div>
<div class="dyncontent">
<div class="center"><img src="classGnome_1_1Gda_1_1MetaStruct__inherit__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1MetaStruct_inherit__map" alt="Inheritance graph"/></div>
<map name="Gnome_1_1Gda_1_1MetaStruct_inherit__map" id="Gnome_1_1Gda_1_1MetaStruct_inherit__map">
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="44,166,135,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="29,86,149,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="36,6,143,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Gnome::Gda::MetaStruct:</div>
<div class="dyncontent">
<div class="center"><img src="classGnome_1_1Gda_1_1MetaStruct__coll__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1MetaStruct_coll__map" alt="Collaboration graph"/></div>
<map name="Gnome_1_1Gda_1_1MetaStruct_coll__map" id="Gnome_1_1Gda_1_1MetaStruct_coll__map">
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="44,166,135,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="29,86,149,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="36,6,143,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGnome_1_1Gda_1_1MetaStruct-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a59787fc011cda64de8b09a495b6db3da">~MetaStruct</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GdaMetaStruct* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a0d3d48ad3b583ee49c05fe4268868839">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a0d3d48ad3b583ee49c05fe4268868839"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GdaMetaStruct* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a6f74aaa10d88e5a6e41e860d9b217cb7">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a6f74aaa10d88e5a6e41e860d9b217cb7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GdaMetaStruct* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#ae356e8a84eff616e00197d9cefe0f4c4">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#ae356e8a84eff616e00197d9cefe0f4c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GdaMetaDbObject* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac">complement</a> (<a class="el" href="group__libgdammEnums.html#gabc8cfdadb9858da2ba0d869b7032dac8">MetaDbObjectType</a> <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01565.html#ga79d96b6335c46a5a2a7386970a91cd9b">type</a>, const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& catalog, const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& schema, const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new Gda::MetaDbObject structure in <em>mstruct</em> to represent the database object (of type <em>type</em>) which can be uniquely identified as <em>catalog</em>. <a href="#abcacd8d7d6b6318f872d254f2e4a35ac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#aec2673f024ff7982a59eae7c5585fa54">complement_schema</a> (const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& catalog, const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& schema)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is similar to <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac" title="Creates a new Gda::MetaDbObject structure in mstruct to represent the database object (of type type) ...">complement()</a> but creates Gda::MetaDbObject for all the database object which are in the <em>schema</em> schema (and in the <em>catalog</em> catalog). <a href="#aec2673f024ff7982a59eae7c5585fa54"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a8f6cf4f17b48973bea9aa1f295e47317">complement_default</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is similar to <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac" title="Creates a new Gda::MetaDbObject structure in mstruct to represent the database object (of type type) ...">complement()</a> and <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a5abb92eb8d5a1808999aada40babb9b0" title="This method is similar to complement() and complement_default() but creates Gda::MetaDbObject for all...">complement_all()</a> but creates Gda::MetaDbObject for all the database object which are usable using only their short name (that is which do not need to be prefixed by the schema in which they are to be used). <a href="#a8f6cf4f17b48973bea9aa1f295e47317"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a8e5b22c9af08ba84dc7f9450faf40dfb">sort_db_object</a> (<a class="el" href="group__libgdammEnums.html#ga9245327dfad017057e2a418e29e6d3b3">MetaSortType</a> sort_type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reorders the list of database objects within <em>mstruct</em> in a way specified by <em>sort_type</em>. <a href="#a8e5b22c9af08ba84dc7f9450faf40dfb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GdaMetaDbObject* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#adf118667000c7a449244dde9eeb44ba2">get_db_object</a> (const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& catalog, const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& schema, const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to locate the Gda::MetaDbObject structure representing the database object named after <em>catalog</em>, <em>schema</em> and <em>name</em>. <a href="#adf118667000c7a449244dde9eeb44ba2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GdaMetaTableColumn* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a8f9960b6d768dceab314517b3db889c6">get_table_column</a> (GdaMetaTable* table, const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& col_name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#aa2e870983a1e2c52589a7ace7fe4d938">dump_as_graph</a> (<a class="el" href="group__libgdammEnums.html#ga6a80b8a7f482510aef6747a0f475c951">MetaGraphInfo</a> info)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new graph (in the GraphViz syntax) representation of <em>mstruct</em>. <a href="#aa2e870983a1e2c52589a7ace7fe4d938"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a5abb92eb8d5a1808999aada40babb9b0">complement_all</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is similar to <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac" title="Creates a new Gda::MetaDbObject structure in mstruct to represent the database object (of type type) ...">complement()</a> and <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a8f6cf4f17b48973bea9aa1f295e47317" title="This method is similar to complement() and complement_all() but creates Gda::MetaDbObject for all the...">complement_default()</a> but creates Gda::MetaDbObject for all the database object. <a href="#a5abb92eb8d5a1808999aada40babb9b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GSList* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a180972e1cf18756b121a0dac758b9859">get_all_db_objects</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of all the Gda::MetaDbObject structures representing database objects in <em>mstruct</em>. <a href="#a180972e1cf18756b121a0dac758b9859"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/>
< guint > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a324dcf7e434dc94cadcc32f6f2a4f81f">property_features</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">You rarely need to use properties because there are get_ and set_ methods for almost all of them. <a href="#a324dcf7e434dc94cadcc32f6f2a4f81f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html">MetaStruct</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#aef9fb9b374fe83b8bcce7370705671cb">create</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1MetaStore.html">MetaStore</a> >& store, <a class="el" href="group__libgdammEnums.html#ga2fb8a6fe04eb92bef76005464d523c79">MetaStructFeature</a> features=META_STRUCT_FEATURE_ALL)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a371a6e2def014eade66fdcd43c918eda">MetaStruct</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1MetaStore.html">MetaStore</a> >& meta_store, <a class="el" href="group__libgdammEnums.html#ga2fb8a6fe04eb92bef76005464d523c79">MetaStructFeature</a> features)</td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
< <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html">Gnome::Gda::MetaStruct</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#af470e3244817822f7e3e63ff36907abf">wrap</a> (GdaMetaStruct* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#af470e3244817822f7e3e63ff36907abf"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>In-memory representation of some database objects. </p>
<p>The <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html" title="In-memory representation of some database objects.">Gda::MetaStruct</a> object reads data from a <a class="el" href="classGnome_1_1Gda_1_1MetaStore.html" title="Dictionary object.">Gda::MetaStore</a> object and creates an easy to use in memory representation for some database objects. For example one can easily analyse the columns of a table (or its foreign keys) using a <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html" title="In-memory representation of some database objects.">Gda::MetaStruct</a>.</p>
<p>When created, the new <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html" title="In-memory representation of some database objects.">Gda::MetaStruct</a> object is empty (it does not have any information about any database object). Information about database objects is computed upon request using the gda_meta_struct_complement() method. Information about individual database objects is represented by GdaMetaDbObject structures, which can be obtained using <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#adf118667000c7a449244dde9eeb44ba2" title="Tries to locate the Gda::MetaDbObject structure representing the database object named after catalog...">get_db_object()</a> or <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a180972e1cf18756b121a0dac758b9859" title="Get a list of all the Gda::MetaDbObject structures representing database objects in mstruct...">get_all_db_objects()</a>.</p>
<p>Note that the Gda::MetaDbObject structures may change or may be removed or replaced by others, so it not advised to keep pointers to these structures: pointers to these structures should be considered valid as long as <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac" title="Creates a new Gda::MetaDbObject structure in mstruct to represent the database object (of type type) ...">complement()</a> and other similar functions have not been called. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a59787fc011cda64de8b09a495b6db3da"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::~MetaStruct" ref="a59787fc011cda64de8b09a495b6db3da" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gnome::Gda::MetaStruct::~MetaStruct </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a371a6e2def014eade66fdcd43c918eda"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::MetaStruct" ref="a371a6e2def014eade66fdcd43c918eda" args="(const Glib::RefPtr< MetaStore > &meta_store, MetaStructFeature features)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gnome::Gda::MetaStruct::MetaStruct </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1MetaStore.html">MetaStore</a> >& </td>
<td class="paramname"><em>meta_store</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__libgdammEnums.html#ga2fb8a6fe04eb92bef76005464d523c79">MetaStructFeature</a> </td>
<td class="paramname"><em>features</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [explicit, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abcacd8d7d6b6318f872d254f2e4a35ac"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::complement" ref="abcacd8d7d6b6318f872d254f2e4a35ac" args="(MetaDbObjectType type, const Value &catalog, const Value &schema, const Value &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdaMetaDbObject* Gnome::Gda::MetaStruct::complement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libgdammEnums.html#gabc8cfdadb9858da2ba0d869b7032dac8">MetaDbObjectType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& </td>
<td class="paramname"><em>catalog</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& </td>
<td class="paramname"><em>schema</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new Gda::MetaDbObject structure in <em>mstruct</em> to represent the database object (of type <em>type</em>) which can be uniquely identified as <em>catalog</em>. </p>
<p><em>schema</em>. <em>name</em>.</p>
<p>If <em>catalog</em> is not <code>0</code>, then <em>schema</em> should not be <code>0</code>.</p>
<p>If both <em>catalog</em> and <em>schema</em> are <code>0</code>, then the database object will be the one which is "visible" by default (that is which can be accessed only by its short <em>name</em> name).</p>
<p>If <em>catalog</em> is <code>0</code> and <em>schema</em> is not <code>0</code>, then the database object will be the one which can be accessed by its <em>schema</em>. <em>name</em> name.</p>
<p>Important note: <em>catalog</em>, <em>schema</em> and <em>name</em> will be used using the following convention: <itemizedlist> <listitem>be surrounded by double quotes for a case sensitive search</listitem> <listitem>otherwise for case insensitive search</listitem> </itemizedlist></p>
<p>For more information, see the meta data section about SQL identifiers. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>The type of object to add (which can be GDA_META_DB_UNKNOWN). </td></tr>
<tr><td class="paramname">catalog</td><td>The catalog the object belongs to (as a G_TYPE_STRING GValue), or <code>0</code>. </td></tr>
<tr><td class="paramname">schema</td><td>The schema the object belongs to (as a G_TYPE_STRING GValue), or <code>0</code>. </td></tr>
<tr><td class="paramname">name</td><td>The object's name (as a G_TYPE_STRING GValue), not <code>0</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The Gda::MetaDbObject corresponding to the database object if no error occurred, or <code>0</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a5abb92eb8d5a1808999aada40babb9b0"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::complement_all" ref="a5abb92eb8d5a1808999aada40babb9b0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gnome::Gda::MetaStruct::complement_all </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is similar to <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac" title="Creates a new Gda::MetaDbObject structure in mstruct to represent the database object (of type type) ...">complement()</a> and <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a8f6cf4f17b48973bea9aa1f295e47317" title="This method is similar to complement() and complement_all() but creates Gda::MetaDbObject for all the...">complement_default()</a> but creates Gda::MetaDbObject for all the database object. </p>
<p>Please refer to <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac" title="Creates a new Gda::MetaDbObject structure in mstruct to represent the database object (of type type) ...">complement()</a> form more information. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if no error occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="a8f6cf4f17b48973bea9aa1f295e47317"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::complement_default" ref="a8f6cf4f17b48973bea9aa1f295e47317" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gnome::Gda::MetaStruct::complement_default </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is similar to <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac" title="Creates a new Gda::MetaDbObject structure in mstruct to represent the database object (of type type) ...">complement()</a> and <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#a5abb92eb8d5a1808999aada40babb9b0" title="This method is similar to complement() and complement_default() but creates Gda::MetaDbObject for all...">complement_all()</a> but creates Gda::MetaDbObject for all the database object which are usable using only their short name (that is which do not need to be prefixed by the schema in which they are to be used). </p>
<p>Please refer to <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac" title="Creates a new Gda::MetaDbObject structure in mstruct to represent the database object (of type type) ...">complement()</a> form more information. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if no error occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="aec2673f024ff7982a59eae7c5585fa54"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::complement_schema" ref="aec2673f024ff7982a59eae7c5585fa54" args="(const Value &catalog, const Value &schema)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gnome::Gda::MetaStruct::complement_schema </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& </td>
<td class="paramname"><em>catalog</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& </td>
<td class="paramname"><em>schema</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This method is similar to <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac" title="Creates a new Gda::MetaDbObject structure in mstruct to represent the database object (of type type) ...">complement()</a> but creates Gda::MetaDbObject for all the database object which are in the <em>schema</em> schema (and in the <em>catalog</em> catalog). </p>
<p>If <em>catalog</em> is <code>0</code>, then any catalog will be used, and if <em>schema</em> is <code>0</code> then any schema will be used (if <em>schema</em> is <code>0</code> then catalog must also be <code>0</code>).</p>
<p>Please refer to <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html#abcacd8d7d6b6318f872d254f2e4a35ac" title="Creates a new Gda::MetaDbObject structure in mstruct to represent the database object (of type type) ...">complement()</a> form more information. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">catalog</td><td>Name of a catalog, or <code>0</code>. </td></tr>
<tr><td class="paramname">schema</td><td>Name of a schema, or <code>0</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if no error occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="aef9fb9b374fe83b8bcce7370705671cb"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::create" ref="aef9fb9b374fe83b8bcce7370705671cb" args="(const Glib::RefPtr< MetaStore > &store, MetaStructFeature features=META_STRUCT_FEATURE_ALL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html">MetaStruct</a>> Gnome::Gda::MetaStruct::create </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1MetaStore.html">MetaStore</a> >& </td>
<td class="paramname"><em>store</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__libgdammEnums.html#ga2fb8a6fe04eb92bef76005464d523c79">MetaStructFeature</a> </td>
<td class="paramname"><em>features</em> = <code>META_STRUCT_FEATURE_ALL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa2e870983a1e2c52589a7ace7fe4d938"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::dump_as_graph" ref="aa2e870983a1e2c52589a7ace7fe4d938" args="(MetaGraphInfo info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> Gnome::Gda::MetaStruct::dump_as_graph </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libgdammEnums.html#ga6a80b8a7f482510aef6747a0f475c951">MetaGraphInfo</a> </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new graph (in the GraphViz syntax) representation of <em>mstruct</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>Informs what kind of information to show in the resulting graph. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new string, or <code>0</code> if an error occurred. </dd></dl>
</div>
</div>
<a class="anchor" id="a180972e1cf18756b121a0dac758b9859"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::get_all_db_objects" ref="a180972e1cf18756b121a0dac758b9859" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GSList* Gnome::Gda::MetaStruct::get_all_db_objects </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a list of all the Gda::MetaDbObject structures representing database objects in <em>mstruct</em>. </p>
<p>Note that no Gda::MetaDbObject structure must not be modified. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new SList list of pointers to Gda::MetaDbObject structures which must be destroyed after usage using Glib::slist_free(). The individual Gda::MetaDbObject must not be modified. </dd></dl>
</div>
</div>
<a class="anchor" id="adf118667000c7a449244dde9eeb44ba2"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::get_db_object" ref="adf118667000c7a449244dde9eeb44ba2" args="(const Value &catalog, const Value &schema, const Value &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdaMetaDbObject* Gnome::Gda::MetaStruct::get_db_object </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& </td>
<td class="paramname"><em>catalog</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& </td>
<td class="paramname"><em>schema</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tries to locate the Gda::MetaDbObject structure representing the database object named after <em>catalog</em>, <em>schema</em> and <em>name</em>. </p>
<p>If one or both of <em>catalog</em> and <em>schema</em> are <code>0</code>, and more than one database object matches the name, then the return value is also <code>0</code>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">catalog</td><td>The catalog the object belongs to (as a G_TYPE_STRING GValue), or <code>0</code>. </td></tr>
<tr><td class="paramname">schema</td><td>The schema the object belongs to (as a G_TYPE_STRING GValue), or <code>0</code>. </td></tr>
<tr><td class="paramname">name</td><td>The object's name (as a G_TYPE_STRING GValue), not <code>0</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The Gda::MetaDbObject or <code>0</code> if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="a8f9960b6d768dceab314517b3db889c6"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::get_table_column" ref="a8f9960b6d768dceab314517b3db889c6" args="(GdaMetaTable *table, const Value &col_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdaMetaTableColumn* Gnome::Gda::MetaStruct::get_table_column </td>
<td>(</td>
<td class="paramtype">GdaMetaTable * </td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classGnome_1_1Gda_1_1Value.html">Value</a>& </td>
<td class="paramname"><em>col_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0d3d48ad3b583ee49c05fe4268868839"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::gobj" ref="a0d3d48ad3b583ee49c05fe4268868839" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdaMetaStruct* Gnome::Gda::MetaStruct::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
</div>
</div>
<a class="anchor" id="a6f74aaa10d88e5a6e41e860d9b217cb7"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::gobj" ref="a6f74aaa10d88e5a6e41e860d9b217cb7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GdaMetaStruct* Gnome::Gda::MetaStruct::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
</div>
</div>
<a class="anchor" id="ae356e8a84eff616e00197d9cefe0f4c4"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::gobj_copy" ref="ae356e8a84eff616e00197d9cefe0f4c4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdaMetaStruct* Gnome::Gda::MetaStruct::gobj_copy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
</div>
</div>
<a class="anchor" id="a324dcf7e434dc94cadcc32f6f2a4f81f"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::property_features" ref="a324dcf7e434dc94cadcc32f6f2a4f81f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><guint> Gnome::Gda::MetaStruct::property_features </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a8e5b22c9af08ba84dc7f9450faf40dfb"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::sort_db_object" ref="a8e5b22c9af08ba84dc7f9450faf40dfb" args="(MetaSortType sort_type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gnome::Gda::MetaStruct::sort_db_object </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libgdammEnums.html#ga9245327dfad017057e2a418e29e6d3b3">MetaSortType</a> </td>
<td class="paramname"><em>sort_type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reorders the list of database objects within <em>mstruct</em> in a way specified by <em>sort_type</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sort_type</td><td>The kind of sorting requested. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if no error occurred. </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="af470e3244817822f7e3e63ff36907abf"></a><!-- doxytag: member="Gnome::Gda::MetaStruct::wrap" ref="af470e3244817822f7e3e63ff36907abf" args="(GdaMetaStruct *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1MetaStruct.html">Gnome::Gda::MetaStruct</a> > wrap </td>
<td>(</td>
<td class="paramtype">GdaMetaStruct * </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>libgdamm/metastruct.h</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Sep 22 2011 11:20:03 for libgdamm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
