| <!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"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.3"/> |
| <title>Lucene.Net: WorldNet.Net.Syns2Index Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="Index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Packages</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> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <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> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespace_world_net.html">WorldNet</a></li><li class="navelem"><a class="el" href="namespace_world_net_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="class_world_net_1_1_net_1_1_syns2_index.html">Syns2Index</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="class_world_net_1_1_net_1_1_syns2_index-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">WorldNet.Net.Syns2Index Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Convert the prolog file wn_s.pl from the <a href="http://www.cogsci.princeton.edu/2.0/WNprolog-2.0.tar.gz">WordNet prolog download</a> into a <a class="el" href="namespace_lucene.html">Lucene</a> index suitable for looking up synonyms and performing query expansion (<a class="el" href="class_world_net_1_1_net_1_1_syn_expand.html#aaeaab182949af969bd8edd56adbfef4a" title="Perform synonym expansion on a query. ">SynExpand.Expand</a>). |
| <a href="class_world_net_1_1_net_1_1_syns2_index.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a23b450320ac2d12079f35c044ca9ddae"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_world_net_1_1_net_1_1_syns2_index.html#a23b450320ac2d12079f35c044ca9ddae">Main</a> (System.String[] args)</td></tr> |
| <tr class="memdesc:a23b450320ac2d12079f35c044ca9ddae"><td class="mdescLeft"> </td><td class="mdescRight">Takes arg of prolog file name and index directory. <a href="#a23b450320ac2d12079f35c044ca9ddae"></a><br/></td></tr> |
| <tr class="separator:a23b450320ac2d12079f35c044ca9ddae"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:ab669f0b2f20ba12ff766a4489757a0a1"><td class="memItemLeft" align="right" valign="top">const System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_world_net_1_1_net_1_1_syns2_index.html#ab669f0b2f20ba12ff766a4489757a0a1">F_SYN</a> = "syn"</td></tr> |
| <tr class="memdesc:ab669f0b2f20ba12ff766a4489757a0a1"><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#ab669f0b2f20ba12ff766a4489757a0a1"></a><br/></td></tr> |
| <tr class="separator:ab669f0b2f20ba12ff766a4489757a0a1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ace3492e5e513cd380046b743f537f3d2"><td class="memItemLeft" align="right" valign="top">const System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_world_net_1_1_net_1_1_syns2_index.html#ace3492e5e513cd380046b743f537f3d2">F_WORD</a> = "word"</td></tr> |
| <tr class="memdesc:ace3492e5e513cd380046b743f537f3d2"><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#ace3492e5e513cd380046b743f537f3d2"></a><br/></td></tr> |
| <tr class="separator:ace3492e5e513cd380046b743f537f3d2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Convert the prolog file wn_s.pl from the <a href="http://www.cogsci.princeton.edu/2.0/WNprolog-2.0.tar.gz">WordNet prolog download</a> into a <a class="el" href="namespace_lucene.html">Lucene</a> index suitable for looking up synonyms and performing query expansion (<a class="el" href="class_world_net_1_1_net_1_1_syn_expand.html#aaeaab182949af969bd8edd56adbfef4a" title="Perform synonym expansion on a query. ">SynExpand.Expand</a>). </p> |
| <p>This has been tested with WordNet 2.0.</p> |
| <p>The index has fields named "word" (<a class="el" href="class_world_net_1_1_net_1_1_syns2_index.html#ace3492e5e513cd380046b743f537f3d2">F_WORD</a>) and "syn" (<a class="el" href="class_world_net_1_1_net_1_1_syns2_index.html#ab669f0b2f20ba12ff766a4489757a0a1">F_SYN</a>). </p> |
| <p>The source word (such as 'big') can be looked up in the "word" field, and if present there will be fields named "syn" for every synonym. What's tricky here is that there could be <b>multiple</b> fields with the same name, in the general case for words that have multiple synonyms. That's not a problem with <a class="el" href="namespace_lucene.html">Lucene</a>, you just use Document.GetValues </p> |
| <p>While the WordNet file distinguishes groups of synonyms with related meanings we don't do that here. </p> |
| <p>This can take 4 minutes to execute and build an index on a "fast" system and the index takes up almost 3 MB. </p> |
| <dl class="section see"><dt>See Also</dt><dd>http://www.cogsci.princeton.edu/~wn/</dd></dl> |
| <dl class="section see"><dt>See Also</dt><dd>http://www.cogsci.princeton.edu/~wn/man/prologdb.5WN.html</dd></dl> |
| <dl class="section see"><dt>See Also</dt><dd>http://www.hostmon.com/rfc/advanced.jsp</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_syns2_index_8cs_source.html#l00057">57</a> of file <a class="el" href="_syns2_index_8cs_source.html">Syns2Index.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a23b450320ac2d12079f35c044ca9ddae"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static void WorldNet.Net.Syns2Index.Main </td> |
| <td>(</td> |
| <td class="paramtype">System.String[] </td> |
| <td class="paramname"><em>args</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Takes arg of prolog file name and index directory. </p> |
| |
| <p>Definition at line <a class="el" href="_syns2_index_8cs_source.html#l00078">78</a> of file <a class="el" href="_syns2_index_8cs_source.html">Syns2Index.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="ab669f0b2f20ba12ff766a4489757a0a1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const System.String WorldNet.Net.Syns2Index.F_SYN = "syn"</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p></p> |
| |
| <p>Definition at line <a class="el" href="_syns2_index_8cs_source.html#l00066">66</a> of file <a class="el" href="_syns2_index_8cs_source.html">Syns2Index.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ace3492e5e513cd380046b743f537f3d2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const System.String WorldNet.Net.Syns2Index.F_WORD = "word"</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p></p> |
| |
| <p>Definition at line <a class="el" href="_syns2_index_8cs_source.html#l00069">69</a> of file <a class="el" href="_syns2_index_8cs_source.html">Syns2Index.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>contrib/WordNet/Syns2Index/<a class="el" href="_syns2_index_8cs_source.html">Syns2Index.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:59 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
