<!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>Barry: Barry::ContactLdif 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.6.2-20100208 -->
<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="annotated.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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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" -->
<p>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.
<a href="#_details">More...</a></p>
<p><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">
<div class="center"><img src="classBarry_1_1ContactLdif__coll__graph.png" border="0" usemap="#Barry_1_1ContactLdif_coll__map" alt="Collaboration graph"/></div>
<map name="Barry_1_1ContactLdif_coll__map" id="Barry_1_1ContactLdif_coll__map">
<area shape="rect" id="node4" href="structBarry_1_1ContactLdif_1_1AccessPair.html" title="Barry::ContactLdif::AccessPair" alt="" coords="427,138,632,169"/><area shape="rect" id="node6" title="STL class." alt="" coords="227,218,307,249"/><area shape="rect" id="node10" href="structBarry_1_1ContactLdif_1_1LdifAttribute.html" title="Barry::ContactLdif::LdifAttribute" alt="" coords="427,218,632,249"/><area shape="rect" id="node18" href="structBarry_1_1ContactLdif_1_1NameToFunc.html" title="Used to create a List of supported Barry field names, including calculated names..." alt="" coords="663,354,881,385"/><area shape="rect" id="node8" title="STL class." alt="" coords="7,218,175,249"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classBarry_1_1ContactLdif-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structBarry_1_1ContactLdif_1_1AccessPair.html">AccessPair</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structBarry_1_1ContactLdif_1_1LdifAttribute.html">LdifAttribute</a></td></tr>
<tr><td class="memItemLeft" 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>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1ContactLdif.html#ada58a63d622b3a9c02140f86b2c8a143">SetDNAttr</a> (const <a class="el" href="structBarry_1_1ContactLdif_1_1LdifAttribute.html">LdifAttribute</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the LDIF attribute name to use when constructing the FQDN. <a href="#ada58a63d622b3a9c02140f86b2c8a143"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1ContactLdif.html#a3d84ec050090e7f7520f6770f756f1f9">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="#a3d84ec050090e7f7520f6770f756f1f9"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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>
<p>This class supports LDIF attribute mapping, and a heuristics mechanism for parsing LDIF fields that may not have consistent data.</p>
<p>To use this class, create an instance of it, then call <a class="el" href="classBarry_1_1ContactLdif.html#a3d84ec050090e7f7520f6770f756f1f9" 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>
<p>To override LDIF attribute mapping, call Map() or Unmap() as appropriate.</p>
<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#a3d84ec050090e7f7520f6770f756f1f9" title="Output contact data to os in LDAP LDIF format.">DumpLdif()</a>. </p>
<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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3d84ec050090e7f7520f6770f756f1f9"></a><!-- doxytag: member="Barry::ContactLdif::DumpLdif" ref="a3d84ec050090e7f7520f6770f756f1f9" 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>
</div>
</div>
<a class="anchor" id="ada58a63d622b3a9c02140f86b2c8a143"></a><!-- doxytag: member="Barry::ContactLdif::SetDNAttr" ref="ada58a63d622b3a9c02140f86b2c8a143" 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 <a class="el" href="structBarry_1_1ContactLdif_1_1LdifAttribute.html">LdifAttribute</a> & </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>
<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>
<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>
<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>
<li><a class="el" href="ldif_8cc_source.html">ldif.cc</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
