doc/www/doxygen/html/classBarry_1_1ContactLdif.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: Barry::ContactLdif Class Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li class="current"><a href="classes.html"><span>Classes</span></a></li>
  15       <li><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="tabs">
  20     <ul>
  21       <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
  22       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  23       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  24       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  25     </ul>
  26   </div>
  27   <div class="navpath"><a class="el" href="namespaceBarry.html">Barry</a>::<a class="el" href="classBarry_1_1ContactLdif.html">ContactLdif</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>Barry::ContactLdif Class Reference</h1><!-- doxytag: class="Barry::ContactLdif" --><code>#include &lt;<a class="el" href="ldif_8h-source.html">ldif.h</a>&gt;</code>
  32 <p>
  33 <div class="dynheader">
  34 Collaboration diagram for Barry::ContactLdif:</div>
  35 <div class="dynsection">
  36 <p><center><img src="classBarry_1_1ContactLdif__coll__graph.png" border="0" usemap="#Barry_1_1ContactLdif__coll__map" alt="Collaboration graph"></center>
  37 <map name="Barry_1_1ContactLdif__coll__map">
  38 <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>
  39 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  40
  41 <p>
  42 <a href="classBarry_1_1ContactLdif-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  43 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.
  44 <p>
  45 This class supports LDIF attribute mapping, and a heuristics mechanism for parsing LDIF fields that may not have consistent data.<p>
  46 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>
  47 To override LDIF attribute mapping, call Map() or Unmap() as appropriate.<p>
  48 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>
  49 <pre>
  50         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-&gt;name; n++ ) {
  51                 ...
  52         }
  53     </pre><p>
  54 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>.
  55 <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>
  56 <table border="0" cellpadding="0" cellspacing="0">
  57 <tr><td></td></tr>
  58 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  59 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1ContactLdif.html#da58a63d622b3a9c02140f86b2c8a143">SetDNAttr</a> (const LdifAttribute &amp;name)</td></tr>
  60
  61 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the LDIF attribute name to use when constructing the FQDN.  <a href="#da58a63d622b3a9c02140f86b2c8a143"></a><br></td></tr>
  62 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1ContactLdif.html#3d84ec050090e7f7520f6770f756f1f9">DumpLdif</a> (std::ostream &amp;os, const <a class="el" href="classBarry_1_1Contact.html">Barry::Contact</a> &amp;contact) const </td></tr>
  63
  64 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output contact data to os in LDAP LDIF format.  <a href="#3d84ec050090e7f7520f6770f756f1f9"></a><br></td></tr>
  65 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  66 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><b>AccessPair</b></td></tr>
  67
  68 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><b>LdifAttribute</b></td></tr>
  69
  70 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structBarry_1_1ContactLdif_1_1NameToFunc.html">NameToFunc</a></td></tr>
  71
  72 <tr><td class="mdescLeft">&nbsp;</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>
  73 </table>
  74 <hr><h2>Member Function Documentation</h2>
  75 <a class="anchor" name="da58a63d622b3a9c02140f86b2c8a143"></a><!-- doxytag: member="Barry::ContactLdif::SetDNAttr" ref="da58a63d622b3a9c02140f86b2c8a143" args="(const LdifAttribute &amp;name)" -->
  76 <div class="memitem">
  77 <div class="memproto">
  78       <table class="memname">
  79         <tr>
  80           <td class="memname">bool Barry::ContactLdif::SetDNAttr           </td>
  81           <td>(</td>
  82           <td class="paramtype">const LdifAttribute &amp;&nbsp;</td>
  83           <td class="paramname"> <em>name</em>          </td>
  84           <td>&nbsp;)&nbsp;</td>
  85           <td></td>
  86         </tr>
  87       </table>
  88 </div>
  89 <div class="memdoc">
  90
  91 <p>
  92 Sets the LDIF attribute name to use when constructing the FQDN.
  93 <p>
  94 The FQDN field will take this name, and combine it with the baseDN from the constructor to produce a FQDN for the record.
  95 <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>
  96
  97 </div>
  98 </div><p>
  99 <a class="anchor" name="3d84ec050090e7f7520f6770f756f1f9"></a><!-- doxytag: member="Barry::ContactLdif::DumpLdif" ref="3d84ec050090e7f7520f6770f756f1f9" args="(std::ostream &amp;os, const Barry::Contact &amp;contact) const " -->
 100 <div class="memitem">
 101 <div class="memproto">
 102       <table class="memname">
 103         <tr>
 104           <td class="memname">void Barry::ContactLdif::DumpLdif           </td>
 105           <td>(</td>
 106           <td class="paramtype">std::ostream &amp;&nbsp;</td>
 107           <td class="paramname"> <em>os</em>, </td>
 108         </tr>
 109         <tr>
 110           <td class="paramkey"></td>
 111           <td></td>
 112           <td class="paramtype">const <a class="el" href="classBarry_1_1Contact.html">Barry::Contact</a> &amp;&nbsp;</td>
 113           <td class="paramname"> <em>contact</em></td><td>&nbsp;</td>
 114         </tr>
 115         <tr>
 116           <td></td>
 117           <td>)</td>
 118           <td></td><td></td><td> const</td>
 119         </tr>
 120       </table>
 121 </div>
 122 <div class="memdoc">
 123
 124 <p>
 125 Output contact data to os in LDAP LDIF format.
 126 <p>
 127
 128 <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>
 129
 130 <p>References <a class="el" href="r__contact_8h-source.html#l00145">Barry::Contact::GetID()</a>.</p>
 131
 132 <p>
 133 <div class="dynheader">
 134 Here is the call graph for this function:</div>
 135 <div class="dynsection">
 136 <p><center><img src="classBarry_1_1ContactLdif_3d84ec050090e7f7520f6770f756f1f9_cgraph.png" border="0" usemap="#classBarry_1_1ContactLdif_3d84ec050090e7f7520f6770f756f1f9_cgraph_map" alt=""></center>
 137 <map name="classBarry_1_1ContactLdif_3d84ec050090e7f7520f6770f756f1f9_cgraph_map">
 138 <area shape="rect" href="classBarry_1_1Contact.html#5375b45b098ac190b38a650d27abb04e" title="Barry::Contact::GetID" alt="" coords="244,5,391,32"></map>
 139 </div>
 140
 141 </div>
 142 </div><p>
 143 <hr>The documentation for this class was generated from the following files:<ul>
 144 <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>
 145 </div>
 146 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:14:38 2011 for Barry by&nbsp;
 147 <a href="http://www.doxygen.org/index.html">
 148 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 149 </body>
 150 </html>