<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Barry: Barry::ContactLdif Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceBarry.html">Barry</a>::<a class="el" href="classBarry_1_1ContactLdif.html">ContactLdif</a>
</div>
</div>
<div class="contents">
<h1>Barry::ContactLdif Class Reference</h1><!-- doxytag: class="Barry::ContactLdif" --><code>#include <<a class="el" href="ldif_8h-source.html">ldif.h</a>></code>
<p>
<div class="dynheader">
Collaboration diagram for Barry::ContactLdif:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1ContactLdif__coll__graph.png" border="0" usemap="#Barry_1_1ContactLdif__coll__map" alt="Collaboration graph"></center>
<map name="Barry_1_1ContactLdif__coll__map">
<area shape="rect" title="STL class." alt="" coords="224,127,304,153"><area shape="rect" href="structBarry_1_1ContactLdif_1_1NameToFunc.html" title="Used to create a List of supported Barry field names, including calculated names..." alt="" coords="431,204,641,231"><area shape="rect" title="STL class." alt="" coords="7,127,172,153"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classBarry_1_1ContactLdif-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Class for generating LDIF output based on a <a class="el" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> record object.
<p>
This class supports LDIF attribute mapping, and a heuristics mechanism for parsing LDIF fields that may not have consistent data.<p>
To use this class, create an instance of it, then call <a class="el" href="classBarry_1_1ContactLdif.html#3d84ec050090e7f7520f6770f756f1f9" title="Output contact data to os in LDAP LDIF format.">DumpLdif()</a>, passing the <a class="el" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Contact</a> record object to base the work on. Output will be written to the stream you provide. ReadLdif() goes in the other direction.<p>
To override LDIF attribute mapping, call Map() or Unmap() as appropriate.<p>
To get a list of supported <a class="el" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> field names, call GetFieldNames(). This function returns a pointer to an array of <a class="el" href="structBarry_1_1ContactLdif_1_1NameToFunc.html" title="Used to create a List of supported Barry field names, including calculated names...">ContactLdif::NameToFunc</a> structures, ending with NameToFunc::name as null. You can cycle through the array with code like this:<p>
<pre>
for( <a class="el" href="structBarry_1_1ContactLdif_1_1NameToFunc.html" title="Used to create a List of supported Barry field names, including calculated names...">ContactLdif::NameToFunc</a> *n = o.GetFieldNames(); n->name; n++ ) {
...
}
</pre><p>
Note that all Get/Set functions used in attribute mapping are virtual, and can be overridden by a derived class. This includes the heuristics functions, which are called by <a class="el" href="classBarry_1_1ContactLdif.html#3d84ec050090e7f7520f6770f756f1f9" title="Output contact data to os in LDAP LDIF format.">DumpLdif()</a>.
<p>Definition at line <a class="el" href="ldif_8h-source.html#l00064">64</a> of file <a class="el" href="ldif_8h-source.html">ldif.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1ContactLdif.html#da58a63d622b3a9c02140f86b2c8a143">SetDNAttr</a> (const LdifAttribute &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the LDIF attribute name to use when constructing the FQDN. <a href="#da58a63d622b3a9c02140f86b2c8a143"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1ContactLdif.html#3d84ec050090e7f7520f6770f756f1f9">DumpLdif</a> (std::ostream &os, const <a class="el" href="classBarry_1_1Contact.html">Barry::Contact</a> &contact) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Output contact data to os in LDAP LDIF format. <a href="#3d84ec050090e7f7520f6770f756f1f9"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>AccessPair</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>LdifAttribute</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structBarry_1_1ContactLdif_1_1NameToFunc.html">NameToFunc</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to create a List of supported <a class="el" href="namespaceBarry.html" title="Project namespace, containing all related functions and classes.">Barry</a> field names, including calculated names, such as full postal address. <a href="structBarry_1_1ContactLdif_1_1NameToFunc.html#_details">More...</a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="da58a63d622b3a9c02140f86b2c8a143"></a><!-- doxytag: member="Barry::ContactLdif::SetDNAttr" ref="da58a63d622b3a9c02140f86b2c8a143" args="(const LdifAttribute &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Barry::ContactLdif::SetDNAttr </td>
<td>(</td>
<td class="paramtype">const LdifAttribute & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the LDIF attribute name to use when constructing the FQDN.
<p>
The FQDN field will take this name, and combine it with the baseDN from the constructor to produce a FQDN for the record.
<p>Definition at line <a class="el" href="ldif_8cc-source.html#l00254">254</a> of file <a class="el" href="ldif_8cc-source.html">ldif.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="3d84ec050090e7f7520f6770f756f1f9"></a><!-- doxytag: member="Barry::ContactLdif::DumpLdif" ref="3d84ec050090e7f7520f6770f756f1f9" args="(std::ostream &os, const Barry::Contact &contact) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Barry::ContactLdif::DumpLdif </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classBarry_1_1Contact.html">Barry::Contact</a> & </td>
<td class="paramname"> <em>contact</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Output contact data to os in LDAP LDIF format.
<p>
<p>Definition at line <a class="el" href="ldif_8cc-source.html#l00652">652</a> of file <a class="el" href="ldif_8cc-source.html">ldif.cc</a>.</p>
<p>References <a class="el" href="r__contact_8h-source.html#l00145">Barry::Contact::GetID()</a>.</p>
<p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1ContactLdif_3d84ec050090e7f7520f6770f756f1f9_cgraph.png" border="0" usemap="#classBarry_1_1ContactLdif_3d84ec050090e7f7520f6770f756f1f9_cgraph_map" alt=""></center>
<map name="classBarry_1_1ContactLdif_3d84ec050090e7f7520f6770f756f1f9_cgraph_map">
<area shape="rect" href="classBarry_1_1Contact.html#5375b45b098ac190b38a650d27abb04e" title="Barry::Contact::GetID" alt="" coords="244,5,391,32"></map>
</div>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ldif_8h-source.html">ldif.h</a><li><a class="el" href="ldif_8cc-source.html">ldif.cc</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:58 2011 for Barry by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
