blob: 7664309b55f38d0f439aa83b11a0b69c953c63e0 [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: Lucene.Net.Analysis.Hunspell.HunspellDictionary 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_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_analysis.html">Analysis</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_analysis_1_1_hunspell.html">Hunspell</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</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_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Analysis.Hunspell.HunspellDictionary Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a834e80ab2f4396cc43a66b98315d5c93"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html#a834e80ab2f4396cc43a66b98315d5c93">HunspellDictionary</a> (Stream affix, Stream dictionary)</td></tr>
<tr class="memdesc:a834e80ab2f4396cc43a66b98315d5c93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a> containing the information read from the provided streams to hunspell affix and dictionary file. <a href="#a834e80ab2f4396cc43a66b98315d5c93"></a><br/></td></tr>
<tr class="separator:a834e80ab2f4396cc43a66b98315d5c93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae69d3a16eeaddf71866e3524df037ca8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html#ae69d3a16eeaddf71866e3524df037ca8">HunspellDictionary</a> (Stream affix, IEnumerable&lt; Stream &gt; dictionaries)</td></tr>
<tr class="memdesc:ae69d3a16eeaddf71866e3524df037ca8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a> containing the information read from the provided streams to hunspell affix and dictionary files. <a href="#ae69d3a16eeaddf71866e3524df037ca8"></a><br/></td></tr>
<tr class="separator:ae69d3a16eeaddf71866e3524df037ca8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afaa34eddb83bde2c9609cfc2d2511237"><td class="memItemLeft" align="right" valign="top">IEnumerable&lt; <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_word.html">HunspellWord</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html#afaa34eddb83bde2c9609cfc2d2511237">LookupWord</a> (String word)</td></tr>
<tr class="memdesc:afaa34eddb83bde2c9609cfc2d2511237"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks up HunspellWords that match the String created from the given char array, offset and length. <a href="#afaa34eddb83bde2c9609cfc2d2511237"></a><br/></td></tr>
<tr class="separator:afaa34eddb83bde2c9609cfc2d2511237"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6a6b5cfae51af01df4d4eb14228db87"><td class="memItemLeft" align="right" valign="top">IEnumerable&lt; <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html">HunspellAffix</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html#af6a6b5cfae51af01df4d4eb14228db87">LookupPrefix</a> (char[] word, int offset, int length)</td></tr>
<tr class="memdesc:af6a6b5cfae51af01df4d4eb14228db87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks up <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html" title="Wrapper class representing a hunspell affix. ">HunspellAffix</a> prefixes that have an append that matches the String created from the given char array, offset and length. <a href="#af6a6b5cfae51af01df4d4eb14228db87"></a><br/></td></tr>
<tr class="separator:af6a6b5cfae51af01df4d4eb14228db87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa114cdff30bb9cdec7b4177deee2da9"><td class="memItemLeft" align="right" valign="top">IEnumerable&lt; <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html">HunspellAffix</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html#aaa114cdff30bb9cdec7b4177deee2da9">LookupSuffix</a> (char[] word, int offset, int length)</td></tr>
<tr class="memdesc:aaa114cdff30bb9cdec7b4177deee2da9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks up <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html" title="Wrapper class representing a hunspell affix. ">HunspellAffix</a> suffixes that have an append that matches the String created from the given char array, offset and length. <a href="#aaa114cdff30bb9cdec7b4177deee2da9"></a><br/></td></tr>
<tr class="separator:aaa114cdff30bb9cdec7b4177deee2da9"><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>Definition at line <a class="el" href="_hunspell_dictionary_8cs_source.html#l00026">26</a> of file <a class="el" href="_hunspell_dictionary_8cs_source.html">HunspellDictionary.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a834e80ab2f4396cc43a66b98315d5c93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Analysis.Hunspell.HunspellDictionary.HunspellDictionary </td>
<td>(</td>
<td class="paramtype">Stream&#160;</td>
<td class="paramname"><em>affix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Stream&#160;</td>
<td class="paramname"><em>dictionary</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a> containing the information read from the provided streams to hunspell affix and dictionary file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">affix</td><td>Stream for reading the hunspell affix file.</td></tr>
<tr><td class="paramname">dictionary</td><td>Stream for reading the hunspell dictionary file.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">IOException</td><td>Can be thrown while reading from the streams.</td></tr>
<tr><td class="paramname">InvalidDataException</td><td>Can be thrown if the content of the files does not meet expected formats.</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_hunspell_dictionary_8cs_source.html#l00054">54</a> of file <a class="el" href="_hunspell_dictionary_8cs_source.html">HunspellDictionary.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae69d3a16eeaddf71866e3524df037ca8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Analysis.Hunspell.HunspellDictionary.HunspellDictionary </td>
<td>(</td>
<td class="paramtype">Stream&#160;</td>
<td class="paramname"><em>affix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">IEnumerable&lt; Stream &gt;&#160;</td>
<td class="paramname"><em>dictionaries</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_dictionary.html">HunspellDictionary</a> containing the information read from the provided streams to hunspell affix and dictionary files. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">affix</td><td>Stream for reading the hunspell affix file.</td></tr>
<tr><td class="paramname">dictionaries</td><td>Streams for reading the hunspell dictionary file.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">IOException</td><td>Can be thrown while reading from the streams.</td></tr>
<tr><td class="paramname">InvalidDataException</td><td>Can be thrown if the content of the files does not meet expected formats.</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_hunspell_dictionary_8cs_source.html#l00065">65</a> of file <a class="el" href="_hunspell_dictionary_8cs_source.html">HunspellDictionary.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af6a6b5cfae51af01df4d4eb14228db87"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IEnumerable&lt;<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html">HunspellAffix</a>&gt; Lucene.Net.Analysis.Hunspell.HunspellDictionary.LookupPrefix </td>
<td>(</td>
<td class="paramtype">char[]&#160;</td>
<td class="paramname"><em>word</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks up <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html" title="Wrapper class representing a hunspell affix. ">HunspellAffix</a> prefixes that have an append that matches the String created from the given char array, offset and length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">word</td><td>Char array to generate the String from.</td></tr>
<tr><td class="paramname">offset</td><td>Offset in the char array that the String starts at.</td></tr>
<tr><td class="paramname">length</td><td>Length from the offset that the String is.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>List of <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html" title="Wrapper class representing a hunspell affix. ">HunspellAffix</a> prefixes with an append that matches the String, or <code>null</code> if none are found.</dd></dl>
<p>Definition at line <a class="el" href="_hunspell_dictionary_8cs_source.html#l00097">97</a> of file <a class="el" href="_hunspell_dictionary_8cs_source.html">HunspellDictionary.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aaa114cdff30bb9cdec7b4177deee2da9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IEnumerable&lt;<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html">HunspellAffix</a>&gt; Lucene.Net.Analysis.Hunspell.HunspellDictionary.LookupSuffix </td>
<td>(</td>
<td class="paramtype">char[]&#160;</td>
<td class="paramname"><em>word</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks up <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html" title="Wrapper class representing a hunspell affix. ">HunspellAffix</a> suffixes that have an append that matches the String created from the given char array, offset and length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">word</td><td>Char array to generate the String from.</td></tr>
<tr><td class="paramname">offset</td><td>Offset in the char array that the String starts at.</td></tr>
<tr><td class="paramname">length</td><td>Length from the offset that the String is.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>List of <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_affix.html" title="Wrapper class representing a hunspell affix. ">HunspellAffix</a> suffixes with an append that matches the String, or <code>null</code> if none are found</dd></dl>
<p>Definition at line <a class="el" href="_hunspell_dictionary_8cs_source.html#l00115">115</a> of file <a class="el" href="_hunspell_dictionary_8cs_source.html">HunspellDictionary.cs</a>.</p>
</div>
</div>
<a class="anchor" id="afaa34eddb83bde2c9609cfc2d2511237"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IEnumerable&lt;<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_hunspell_1_1_hunspell_word.html">HunspellWord</a>&gt; Lucene.Net.Analysis.Hunspell.HunspellDictionary.LookupWord </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>word</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks up HunspellWords that match the String created from the given char array, offset and length. </p>
<p>Definition at line <a class="el" href="_hunspell_dictionary_8cs_source.html#l00080">80</a> of file <a class="el" href="_hunspell_dictionary_8cs_source.html">HunspellDictionary.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Analyzers/Hunspell/<a class="el" href="_hunspell_dictionary_8cs_source.html">HunspellDictionary.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:48 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>