doc/api/python/archive.mappers-module.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>archive.mappers</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         <a href="archive-module.html">Package&nbsp;archive</a> ::
       
    38         Module&nbsp;mappers
       
    39       </span>
       
    40     </td>
       
    41     <td>
       
    42       <table cellpadding="0" cellspacing="0">
       
    43         <!-- hide/show private -->
       
    44         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    45     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    46         <tr><td align="right"><span class="options"
       
    47             >[<a href="frames.html" target="_top">frames</a
       
    48             >]&nbsp;|&nbsp;<a href="archive.mappers-module.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <!-- ==================== MODULE DESCRIPTION ==================== -->
       
    55 <h1 class="epydoc">Module mappers</h1><span class="codelink"><a href="archive.mappers-pysrc.html">source&nbsp;code</a></span><br /><br />
       
    56 Archive mappers that map how the input files are divided into archives.<br /><br />
       
    57 
       
    58 <!-- ==================== CLASSES ==================== -->
       
    59 <a name="section-Classes"></a>
       
    60 <table class="summary" border="1" cellpadding="3"
       
    61        cellspacing="0" width="100%" bgcolor="white">
       
    62 <tr bgcolor="#70b0f0" class="table-header">
       
    63   <td colspan="2" class="table-header">
       
    64     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    65       <tr valign="top">
       
    66         <td align="left"><span class="table-header">Classes</span></td>
       
    67         <td align="right" valign="top"
       
    68          ><span class="options">[<a href="#section-Classes"
       
    69          class="privatelink" onclick="toggle_private();"
       
    70          >hide private</a>]</span></td>
       
    71       </tr>
       
    72     </table>
       
    73   </td>
       
    74 </tr>
       
    75 <tr>
       
    76     <td width="15%" align="right" valign="top" class="summary">
       
    77       <span class="summary-type">&nbsp;</span>
       
    78     </td><td class="summary">
       
    79         <a href="archive.mappers.Mapper-class.html" class="summary-name">Mapper</a><br />
       
    80       Mapper Abstract class.
       
    81     </td>
       
    82   </tr>
       
    83 <tr>
       
    84     <td width="15%" align="right" valign="top" class="summary">
       
    85       <span class="summary-type">&nbsp;</span>
       
    86     </td><td class="summary">
       
    87         <a href="archive.mappers.DefaultMapper-class.html" class="summary-name">DefaultMapper</a><br />
       
    88       The default mapper.
       
    89     </td>
       
    90   </tr>
       
    91 <tr>
       
    92     <td width="15%" align="right" valign="top" class="summary">
       
    93       <span class="summary-type">&nbsp;</span>
       
    94     </td><td class="summary">
       
    95         <a href="archive.mappers.PolicyMapper-class.html" class="summary-name">PolicyMapper</a><br />
       
    96       Implements a policy content mapper.
       
    97     </td>
       
    98   </tr>
       
    99 <tr>
       
   100     <td width="15%" align="right" valign="top" class="summary">
       
   101       <span class="summary-type">&nbsp;</span>
       
   102     </td><td class="summary">
       
   103         <a href="archive.mappers.PolicyRemoverMapper-class.html" class="summary-name">PolicyRemoverMapper</a><br />
       
   104       This class implements a variant of the policy mapper.
       
   105     </td>
       
   106   </tr>
       
   107 <tr>
       
   108     <td width="15%" align="right" valign="top" class="summary">
       
   109       <span class="summary-type">&nbsp;</span>
       
   110     </td><td class="summary">
       
   111         <a href="archive.mappers.SFPolicyRemoverMapper-class.html" class="summary-name">SFPolicyRemoverMapper</a><br />
       
   112       Implement an SFL column based policy remover.
       
   113     </td>
       
   114   </tr>
       
   115 <tr>
       
   116     <td width="15%" align="right" valign="top" class="summary">
       
   117       <span class="summary-type">&nbsp;</span>
       
   118     </td><td class="summary">
       
   119         <a href="archive.mappers.EPLPolicyRemoverMapper-class.html" class="summary-name">EPLPolicyRemoverMapper</a><br />
       
   120       Implement an EPL column based policy remover.
       
   121     </td>
       
   122   </tr>
       
   123 </table>
       
   124 <!-- ==================== FUNCTIONS ==================== -->
       
   125 <a name="section-Functions"></a>
       
   126 <table class="summary" border="1" cellpadding="3"
       
   127        cellspacing="0" width="100%" bgcolor="white">
       
   128 <tr bgcolor="#70b0f0" class="table-header">
       
   129   <td colspan="2" class="table-header">
       
   130     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   131       <tr valign="top">
       
   132         <td align="left"><span class="table-header">Functions</span></td>
       
   133         <td align="right" valign="top"
       
   134          ><span class="options">[<a href="#section-Functions"
       
   135          class="privatelink" onclick="toggle_private();"
       
   136          >hide private</a>]</span></td>
       
   137       </tr>
       
   138     </table>
       
   139   </td>
       
   140 </tr>
       
   141 <tr>
       
   142     <td width="15%" align="right" valign="top" class="summary">
       
   143       <span class="summary-type">&nbsp;</span>
       
   144     </td><td class="summary">
       
   145       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   146         <tr>
       
   147           <td><span class="summary-sig"><a name="get_mapper"></a><span class="summary-sig-name">get_mapper</span>(<span class="summary-sig-arg">name</span>,
       
   148         <span class="summary-sig-arg">config</span>,
       
   149         <span class="summary-sig-arg">archiver</span>)</span><br />
       
   150       Get mapper instance from its string id.</td>
       
   151           <td align="right" valign="top">
       
   152             <span class="codelink"><a href="archive.mappers-pysrc.html#get_mapper">source&nbsp;code</a></span>
       
   153             
       
   154           </td>
       
   155         </tr>
       
   156       </table>
       
   157       
       
   158     </td>
       
   159   </tr>
       
   160 </table>
       
   161 <!-- ==================== VARIABLES ==================== -->
       
   162 <a name="section-Variables"></a>
       
   163 <table class="summary" border="1" cellpadding="3"
       
   164        cellspacing="0" width="100%" bgcolor="white">
       
   165 <tr bgcolor="#70b0f0" class="table-header">
       
   166   <td colspan="2" class="table-header">
       
   167     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   168       <tr valign="top">
       
   169         <td align="left"><span class="table-header">Variables</span></td>
       
   170         <td align="right" valign="top"
       
   171          ><span class="options">[<a href="#section-Variables"
       
   172          class="privatelink" onclick="toggle_private();"
       
   173          >hide private</a>]</span></td>
       
   174       </tr>
       
   175     </table>
       
   176   </td>
       
   177 </tr>
       
   178 <tr class="private">
       
   179     <td width="15%" align="right" valign="top" class="summary">
       
   180       <span class="summary-type">&nbsp;</span>
       
   181     </td><td class="summary">
       
   182         <a name="_logger"></a><span class="summary-name">_logger</span> = <code title="logging.getLogger('logger.mappers')">logging.getLogger('logger.mappers')</code>
       
   183     </td>
       
   184   </tr>
       
   185 <tr>
       
   186     <td width="15%" align="right" valign="top" class="summary">
       
   187       <span class="summary-type">&nbsp;</span>
       
   188     </td><td class="summary">
       
   189         <a name="MISSING_POLICY"></a><span class="summary-name">MISSING_POLICY</span> = <code title="&quot;9999&quot;">&quot;9999&quot;</code>
       
   190     </td>
       
   191   </tr>
       
   192 <tr>
       
   193     <td width="15%" align="right" valign="top" class="summary">
       
   194       <span class="summary-type">&nbsp;</span>
       
   195     </td><td class="summary">
       
   196         <a href="archive.mappers-module.html#MAPPERS" class="summary-name">MAPPERS</a> = <code title="{'default': DefaultMapper, 'policy': PolicyMapper, 'policy.remover': P\
       
   197 olicyRemoverMapper, 'sfl.policy.remover': SFPolicyRemoverMapper, 'epl.\
       
   198 policy.remover': EPLPolicyRemoverMapper,}">{'default': DefaultMapper, 'policy': PolicyMapper, '<code class="variable-ellipsis">...</code></code>
       
   199     </td>
       
   200   </tr>
       
   201 </table>
       
   202 <!-- ==================== VARIABLES DETAILS ==================== -->
       
   203 <a name="section-VariablesDetails"></a>
       
   204 <table class="details" border="1" cellpadding="3"
       
   205        cellspacing="0" width="100%" bgcolor="white">
       
   206 <tr bgcolor="#70b0f0" class="table-header">
       
   207   <td colspan="2" class="table-header">
       
   208     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   209       <tr valign="top">
       
   210         <td align="left"><span class="table-header">Variables Details</span></td>
       
   211         <td align="right" valign="top"
       
   212          ><span class="options">[<a href="#section-VariablesDetails"
       
   213          class="privatelink" onclick="toggle_private();"
       
   214          >hide private</a>]</span></td>
       
   215       </tr>
       
   216     </table>
       
   217   </td>
       
   218 </tr>
       
   219 </table>
       
   220 <a name="MAPPERS"></a>
       
   221 <div>
       
   222 <table class="details" border="1" cellpadding="3"
       
   223        cellspacing="0" width="100%" bgcolor="white">
       
   224 <tr><td>
       
   225   <h3 class="epydoc">MAPPERS</h3>
       
   226   
       
   227   <dl class="fields">
       
   228   </dl>
       
   229   <dl class="fields">
       
   230     <dt>Value:</dt>
       
   231       <dd><table><tr><td><pre class="variable">
       
   232 {'default': DefaultMapper, 'policy': PolicyMapper, 'policy.remover': P<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
       
   233 olicyRemoverMapper, 'sfl.policy.remover': SFPolicyRemoverMapper, 'epl.<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
       
   234 policy.remover': EPLPolicyRemoverMapper,}
       
   235 </pre></td></tr></table>
       
   236 </dd>
       
   237   </dl>
       
   238 </td></tr></table>
       
   239 </div>
       
   240 <br />
       
   241 <!-- ==================== NAVIGATION BAR ==================== -->
       
   242 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   243        bgcolor="#a0c0ff" cellspacing="0">
       
   244   <tr valign="middle">
       
   245 
       
   246   <!-- Tree link -->
       
   247       <th>&nbsp;&nbsp;&nbsp;<a
       
   248         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   249 
       
   250   <!-- Index link -->
       
   251       <th>&nbsp;&nbsp;&nbsp;<a
       
   252         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   253 
       
   254   <!-- Help link -->
       
   255       <th>&nbsp;&nbsp;&nbsp;<a
       
   256         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   257 
       
   258       <th class="navbar" width="100%"></th>
       
   259   </tr>
       
   260 </table>
       
   261 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   262   <tr>
       
   263     <td align="left" class="footer">
       
   264     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:15 2009
       
   265     </td>
       
   266     <td align="right" class="footer">
       
   267       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   268     </td>
       
   269   </tr>
       
   270 </table>
       
   271 
       
   272 <script type="text/javascript">
       
   273   <!--
       
   274   // Private objects are initially displayed (because if
       
   275   // javascript is turned off then we want them to be
       
   276   // visible); but by default, we want to hide them.  So hide
       
   277   // them unless we have a cookie that says to show them.
       
   278   checkCookie()
       
   279   // -->
       
   280 </script>
       
   281   
       
   282 </body>
       
   283 </html>