blob: 09ff0ac0abec3442f2316c301b7097cf81ae0f1f [file] [log] [blame]
<!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: SpellChecker.Net.Search.Spell.PlainTextDictionary 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
&#160;<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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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_spell_checker.html">SpellChecker</a></li><li class="navelem"><a class="el" href="namespace_spell_checker_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_spell_checker_1_1_net_1_1_search.html">Search</a></li><li class="navelem"><a class="el" href="namespace_spell_checker_1_1_net_1_1_search_1_1_spell.html">Spell</a></li><li class="navelem"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_plain_text_dictionary.html">PlainTextDictionary</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_plain_text_dictionary-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SpellChecker.Net.Search.Spell.PlainTextDictionary Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Dictionary represented by a file text. Format allowed: 1 word per line:<br/>
word1<br/>
word2<br/>
word3<br/>
<a href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_plain_text_dictionary.html#details">More...</a></p>
<p>Inherits <a class="el" href="interface_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_i_dictionary.html">SpellChecker.Net.Search.Spell.IDictionary</a>, and IEnumerable&lt; string &gt;.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><b>FileIterator</b></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a113b86fccc1b5d312310c9379a7130a3"><td class="memItemLeft" align="right" valign="top">virtual <br class="typebreak"/>
System.Collections.Generic.IEnumerator<br class="typebreak"/>
&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_plain_text_dictionary.html#a113b86fccc1b5d312310c9379a7130a3">GetWordsIterator</a> ()</td></tr>
<tr class="memdesc:a113b86fccc1b5d312310c9379a7130a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">return all the words present in the dictionary <a href="#a113b86fccc1b5d312310c9379a7130a3"></a><br/></td></tr>
<tr class="separator:a113b86fccc1b5d312310c9379a7130a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac469b99bc254dad4689bfd2b0ef82f28"><td class="memItemLeft" align="right" valign="top">System.Collections.Generic.IEnumerator<br class="typebreak"/>
&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_plain_text_dictionary.html#ac469b99bc254dad4689bfd2b0ef82f28">GetEnumerator</a> ()</td></tr>
<tr class="separator:ac469b99bc254dad4689bfd2b0ef82f28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a663bad2b8f33e9b557fc9f1b44cbcf1a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_plain_text_dictionary.html#a663bad2b8f33e9b557fc9f1b44cbcf1a">PlainTextDictionary</a> (System.IO.FileInfo file)</td></tr>
<tr class="separator:a663bad2b8f33e9b557fc9f1b44cbcf1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1a52c1f202fdcb4ae1fbbc42c2ee83f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_plain_text_dictionary.html#ae1a52c1f202fdcb4ae1fbbc42c2ee83f">PlainTextDictionary</a> (System.IO.Stream dictFile)</td></tr>
<tr class="separator:ae1a52c1f202fdcb4ae1fbbc42c2ee83f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Dictionary represented by a file text. </p>
<p>Format allowed: 1 word per line:<br/>
word1<br/>
word2<br/>
word3<br/>
</p>
<p>&lt;author&gt; Nicolas Maisonneuve &lt;/author&gt; </p>
<p>Definition at line <a class="el" href="_plain_text_dictionary_8cs_source.html#l00033">33</a> of file <a class="el" href="_plain_text_dictionary_8cs_source.html">PlainTextDictionary.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a663bad2b8f33e9b557fc9f1b44cbcf1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SpellChecker.Net.Search.Spell.PlainTextDictionary.PlainTextDictionary </td>
<td>(</td>
<td class="paramtype">System.IO.FileInfo&#160;</td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_plain_text_dictionary_8cs_source.html#l00054">54</a> of file <a class="el" href="_plain_text_dictionary_8cs_source.html">PlainTextDictionary.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae1a52c1f202fdcb4ae1fbbc42c2ee83f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SpellChecker.Net.Search.Spell.PlainTextDictionary.PlainTextDictionary </td>
<td>(</td>
<td class="paramtype">System.IO.Stream&#160;</td>
<td class="paramname"><em>dictFile</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_plain_text_dictionary_8cs_source.html#l00059">59</a> of file <a class="el" href="_plain_text_dictionary_8cs_source.html">PlainTextDictionary.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac469b99bc254dad4689bfd2b0ef82f28"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">System.Collections.Generic.IEnumerator&lt;string&gt; SpellChecker.Net.Search.Spell.PlainTextDictionary.GetEnumerator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_plain_text_dictionary_8cs_source.html#l00040">40</a> of file <a class="el" href="_plain_text_dictionary_8cs_source.html">PlainTextDictionary.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a113b86fccc1b5d312310c9379a7130a3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual System.Collections.Generic.IEnumerator&lt;string&gt; SpellChecker.Net.Search.Spell.PlainTextDictionary.GetWordsIterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return all the words present in the dictionary</p>
<dl class="section return"><dt>Returns</dt><dd>Iterator </dd></dl>
<p>Implements <a class="el" href="interface_spell_checker_1_1_net_1_1_search_1_1_spell_1_1_i_dictionary.html#af91020c4096ea415385f9e07ffd9ded3">SpellChecker.Net.Search.Spell.IDictionary</a>.</p>
<p>Definition at line <a class="el" href="_plain_text_dictionary_8cs_source.html#l00035">35</a> of file <a class="el" href="_plain_text_dictionary_8cs_source.html">PlainTextDictionary.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/SpellChecker/Spell/<a class="el" href="_plain_text_dictionary_8cs_source.html">PlainTextDictionary.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>