diff options
Diffstat (limited to 'translate-toolkit-1.5.1/translate/doc/api/translate.services.lookupservice.lookupServer-class.html')
| -rw-r--r-- | translate-toolkit-1.5.1/translate/doc/api/translate.services.lookupservice.lookupServer-class.html | 452 |
1 files changed, 452 insertions, 0 deletions
diff --git a/translate-toolkit-1.5.1/translate/doc/api/translate.services.lookupservice.lookupServer-class.html b/translate-toolkit-1.5.1/translate/doc/api/translate.services.lookupservice.lookupServer-class.html new file mode 100644 index 0000000..6aa3a3e --- /dev/null +++ b/translate-toolkit-1.5.1/translate/doc/api/translate.services.lookupservice.lookupServer-class.html @@ -0,0 +1,452 @@ +<?xml version="1.0" encoding="ascii"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>translate.services.lookupservice.lookupServer</title> + <link rel="stylesheet" href="epydoc.css" type="text/css" /> + <script type="text/javascript" src="epydoc.js"></script> +</head> + +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="translate-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + ><a class="navbar" target="_top" href="http://translate.sourceforge.net/wiki/toolkit/index">Translate Toolkit</a></th> + </tr></table></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <span class="breadcrumbs"> + <a href="translate-module.html">Package translate</a> :: + <a href="translate.services-module.html">Package services</a> :: + <a href="translate.services.lookupservice-module.html">Module lookupservice</a> :: + Class lookupServer + </span> + </td> + <td> + <table cellpadding="0" cellspacing="0"> + <!-- hide/show private --> + <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" + onclick="toggle_private();">hide private</a>]</span></td></tr> + <tr><td align="right"><span class="options" + >[<a href="frames.html" target="_top">frames</a + >] | <a href="translate.services.lookupservice.lookupServer-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class lookupServer</h1><p class="nomargin-top"><span class="codelink"><a href="translate.services.lookupservice-pysrc.html#lookupServer">source code</a></span></p> +<center> +<center> <map id="uml_class_diagram_for_translat_158" name="uml_class_diagram_for_translat_158"> +<area shape="rect" href="javascript:void(0);" title="SimpleXMLRPCServer.SimpleXMLRPCServer.allow_reuse_address" alt="" coords="176,415,448,434"/> +<area shape="rect" href="javascript:void(0);" title="Simple XML-RPC server." alt="" coords="175,398,449,443"/> +<area shape="rect" href="translate.services.lookupservice.lookupServer-class.html#__init__" title="Loads the initial tbx file from the given filename" alt="" coords="101,498,523,516"/> +<area shape="rect" href="translate.services.lookupservice.lookupServer-class.html#internal_lookup" title="Could perhaps include some intelligence in future, like case trying with different casing, etc." alt="" coords="101,516,523,535"/> +<area shape="rect" href="translate.services.lookupservice.lookupServer-class.html#public_lookup" title="Returns the source string of whatever was found." alt="" coords="101,535,523,554"/> +<area shape="rect" href="translate.services.lookupservice.lookupServer-class.html#public_translate" title="Translates the message from the storage and returns a plain string" alt="" coords="101,554,523,572"/> +<area shape="rect" href="translate.services.lookupservice.lookupServer-class.html#public_matches" title="Returns matches from the storage with the associated similarity" alt="" coords="101,572,523,591"/> +<area shape="rect" href="translate.services.lookupservice.lookupServer-class.html" title="translate.services.lookupservice.lookupServer" alt="" coords="100,472,524,592"/> +<area shape="rect" href="javascript:void(0);" title="SocketServer.TCPServer.address_family" alt="" coords="72,196,237,215"/> +<area shape="rect" href="javascript:void(0);" title="SocketServer.TCPServer.socket_type" alt="" coords="72,215,237,234"/> +<area shape="rect" href="javascript:void(0);" title="SocketServer.TCPServer.request_queue_size" alt="" coords="72,234,237,252"/> +<area shape="rect" href="javascript:void(0);" title="Called by constructor to bind the socket." alt="" coords="72,255,237,274"/> +<area shape="rect" href="javascript:void(0);" title="Called by constructor to activate the server." alt="" coords="72,274,237,292"/> +<area shape="rect" href="javascript:void(0);" title="Called to clean-up the server." alt="" coords="72,292,237,311"/> +<area shape="rect" href="javascript:void(0);" title="Return socket file number." alt="" coords="72,311,237,330"/> +<area shape="rect" href="javascript:void(0);" title="Get the request and client address from the socket." alt="" coords="72,330,237,348"/> +<area shape="rect" href="javascript:void(0);" title="Called to clean up an individual request." alt="" coords="72,348,237,367"/> +<area shape="rect" href="javascript:void(0);" title="Base class for various socket-based server classes." alt="" coords="71,179,239,368"/> +<area shape="rect" href="javascript:void(0);" title="Handle one request at a time until doomsday." alt="" coords="17,36,292,55"/> +<area shape="rect" href="javascript:void(0);" title="Handle one request, possibly blocking." alt="" coords="17,55,292,74"/> +<area shape="rect" href="javascript:void(0);" title="Verify the request." alt="" coords="17,74,292,92"/> +<area shape="rect" href="javascript:void(0);" title="Call finish_request." alt="" coords="17,92,292,111"/> +<area shape="rect" href="javascript:void(0);" title="Finish one request by instantiating RequestHandlerClass." alt="" coords="17,111,292,130"/> +<area shape="rect" href="javascript:void(0);" title="Handle an error gracefully." alt="" coords="17,130,292,148"/> +<area shape="rect" href="javascript:void(0);" title="Base class for server classes." alt="" coords="16,11,293,150"/> +<area shape="rect" href="javascript:void(0);" title="Registers an instance to respond to XML-RPC requests." alt="" coords="291,211,648,230"/> +<area shape="rect" href="javascript:void(0);" title="Registers a function to respond to XML-RPC requests." alt="" coords="291,230,648,248"/> +<area shape="rect" href="javascript:void(0);" title="Registers the XML-RPC introspection methods in the system namespace." alt="" coords="291,248,648,267"/> +<area shape="rect" href="javascript:void(0);" title="Registers the XML-RPC multicall method in the system namespace." alt="" coords="291,267,648,286"/> +<area shape="rect" href="javascript:void(0);" title="system.listMethods() => ['add', 'subtract', 'multiple']" alt="" coords="291,286,648,304"/> +<area shape="rect" href="javascript:void(0);" title="system.methodSignature('add') => [double, int, int]" alt="" coords="291,304,648,323"/> +<area shape="rect" href="javascript:void(0);" title="system.methodHelp('add') => "Adds two integers together"" alt="" coords="291,323,648,342"/> +<area shape="rect" href="javascript:void(0);" title="system.multicall([{'methodName': 'add', 'params': [2, 2]}, ...]) => [[4], ...]" alt="" coords="291,342,648,360"/> +<area shape="rect" href="javascript:void(0);" title="Mix-in class that dispatches XML-RPC requests." alt="" coords="289,186,649,362"/> +</map> + <img src="uml_class_diagram_for_translat_158.png" alt='' usemap="#uml_class_diagram_for_translat_158" ismap="ismap" class="graph-without-title" /> +</center> +</center> +<hr /> +<!-- ==================== INSTANCE METHODS ==================== --> +<a name="section-InstanceMethods"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Instance Methods</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-InstanceMethods" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="translate.services.lookupservice.lookupServer-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">addr</span>, + <span class="summary-sig-arg">storage</span>)</span><br /> + Loads the initial tbx file from the given filename</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.services.lookupservice-pysrc.html#lookupServer.__init__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="translate.services.lookupservice.lookupServer-class.html#_dispatch" class="summary-sig-name" onclick="show_private();">_dispatch</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">method</span>, + <span class="summary-sig-arg">params</span>)</span><br /> + Dispatches the XML-RPC method.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.services.lookupservice-pysrc.html#lookupServer._dispatch">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="internal_lookup"></a><span class="summary-sig-name">internal_lookup</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">message</span>)</span><br /> + Could perhaps include some intelligence in future, like case trying + with different casing, etc.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.services.lookupservice-pysrc.html#lookupServer.internal_lookup">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="translate.services.lookupservice.lookupServer-class.html#public_lookup" class="summary-sig-name">public_lookup</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">message</span>)</span><br /> + Returns the source string of whatever was found.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.services.lookupservice-pysrc.html#lookupServer.public_lookup">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="public_translate"></a><span class="summary-sig-name">public_translate</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">message</span>)</span><br /> + Translates the message from the storage and returns a plain string</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.services.lookupservice-pysrc.html#lookupServer.public_translate">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="public_matches"></a><span class="summary-sig-name">public_matches</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">message</span>, + <span class="summary-sig-arg">max_candidates</span>=<span class="summary-sig-default">15</span>, + <span class="summary-sig-arg">min_similarity</span>=<span class="summary-sig-default">50</span>)</span><br /> + Returns matches from the storage with the associated similarity</td> + <td align="right" valign="top"> + <span class="codelink"><a href="translate.services.lookupservice-pysrc.html#lookupServer.public_matches">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.TCPServer</code></b>: + <code>close_request</code>, + <code>fileno</code>, + <code>get_request</code>, + <code>server_activate</code>, + <code>server_bind</code>, + <code>server_close</code> + </p> + <p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.BaseServer</code></b>: + <code>finish_request</code>, + <code>handle_error</code>, + <code>handle_request</code>, + <code>process_request</code>, + <code>serve_forever</code>, + <code>verify_request</code> + </p> + <p class="indent-wrapped-lines"><b>Inherited from <code>SimpleXMLRPCServer.SimpleXMLRPCDispatcher</code></b>: + <code>register_function</code>, + <code>register_instance</code>, + <code>register_introspection_functions</code>, + <code>register_multicall_functions</code>, + <code>system_listMethods</code>, + <code>system_methodHelp</code>, + <code>system_methodSignature</code>, + <code>system_multicall</code> + </p> + <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>SimpleXMLRPCServer.SimpleXMLRPCDispatcher</code></b> (private): + <code>_marshaled_dispatch</code> + </p></div> + </td> + </tr> +</table> +<!-- ==================== CLASS VARIABLES ==================== --> +<a name="section-ClassVariables"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Class Variables</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-ClassVariables" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>SimpleXMLRPCServer.SimpleXMLRPCServer</code></b>: + <code>allow_reuse_address</code> + </p> + <p class="indent-wrapped-lines"><b>Inherited from <code>SocketServer.TCPServer</code></b>: + <code>address_family</code>, + <code>request_queue_size</code>, + <code>socket_type</code> + </p> + </td> + </tr> +</table> +<!-- ==================== METHOD DETAILS ==================== --> +<a name="section-MethodDetails"></a> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Method Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-MethodDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="__init__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">addr</span>, + <span class="sig-arg">storage</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.services.lookupservice-pysrc.html#lookupServer.__init__">source code</a></span> + </td> + </tr></table> + + <p>Loads the initial tbx file from the given filename</p> + <dl class="fields"> + <dt>Overrides: + SimpleXMLRPCServer.SimpleXMLRPCDispatcher.__init__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="_dispatch"></a> +<div class="private"> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">_dispatch</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">method</span>, + <span class="sig-arg">params</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.services.lookupservice-pysrc.html#lookupServer._dispatch">source code</a></span> + </td> + </tr></table> + + <p>Dispatches the XML-RPC method.</p> + <p>XML-RPC calls are forwarded to a registered function that matches the + called XML-RPC method name. If no such function exists then the call is + forwarded to the registered instance, if available.</p> + <p>If the registered instance has a _dispatch method then that method + will be called with the name of the XML-RPC method and its parameters as + a tuple e.g. instance._dispatch('add',(2,3))</p> + <p>If the registered instance does not have a _dispatch method then the + instance will be searched to find a matching method and, if found, will + be called.</p> + <p>Methods beginning with an '_' are considered private and will not be + called.</p> + <dl class="fields"> + <dt>Overrides: + SimpleXMLRPCServer.SimpleXMLRPCDispatcher._dispatch + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </dl> +</td></tr></table> +</div> +<a name="public_lookup"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">public_lookup</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">message</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="translate.services.lookupservice-pysrc.html#lookupServer.public_lookup">source code</a></span> + </td> + </tr></table> + + <p>Returns the source string of whatever was found. Keep in mind that + this might not be what you want.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="translate-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + ><a class="navbar" target="_top" href="http://translate.sourceforge.net/wiki/toolkit/index">Translate Toolkit</a></th> + </tr></table></th> + </tr> +</table> +<table border="0" cellpadding="0" cellspacing="0" width="100%%"> + <tr> + <td align="left" class="footer"> + Generated by Epydoc 3.0.1 on Wed Nov 25 17:17:52 2009 + </td> + <td align="right" class="footer"> + <a target="mainFrame" href="http://epydoc.sourceforge.net" + >http://epydoc.sourceforge.net</a> + </td> + </tr> +</table> + +<script type="text/javascript"> + <!-- + // Private objects are initially displayed (because if + // javascript is turned off then we want them to be + // visible); but by default, we want to hide them. So hide + // them unless we have a cookie that says to show them. + checkCookie(); + // --> +</script> +</body> +</html> |