| <!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: core/Analysis/Analyzer.cs Source File</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><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><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="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File 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="dir_1efe588324fc547683bba4a3f1bac847.html">core</a></li><li class="navelem"><a class="el" href="dir_6336841c10663a412729e336c4986ba5.html">Analysis</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">Analyzer.cs</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="_analyzer_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* </span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * </span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * </span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">using</span> System;</div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">using</span> Lucene.Net.Documents;</div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">using</span> Lucene.Net.Store;</div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">using</span> Lucene.Net.Util;</div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span>Lucene.Net.Analysis</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html"> 32</a></span>  <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html" title="An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index...">Analyzer</a> : IDisposable</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  {</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span> <span class="keyword">abstract</span> <a class="code" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">TokenStream</a> <a class="code" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a>(String fieldName, System.IO.TextReader reader);</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div> |
| <div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#a38359e51b263c3a5dc8774651c35b8cd"> 47</a></span>  <span class="keyword">public</span> <span class="keyword">virtual</span> TokenStream ReusableTokenStream(String fieldName, System.IO.TextReader reader)</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  {</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">return</span> <a class="code" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a>(fieldName, reader);</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">private</span> <a class="code" href="class_lucene_1_1_net_1_1_util_1_1_closeable_thread_local.html" title="Java's builtin ThreadLocal has a serious flaw: it can take an arbitrarily long amount of time to dere...">CloseableThreadLocal<Object></a> tokenStreams = <span class="keyword">new</span> <a class="code" href="class_lucene_1_1_net_1_1_util_1_1_closeable_thread_local.html" title="Java's builtin ThreadLocal has a serious flaw: it can take an arbitrarily long amount of time to dere...">CloseableThreadLocal<Object></a>();</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">private</span> <span class="keywordtype">bool</span> isDisposed;</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keyword">virtual</span> <span class="keywordtype">object</span> PreviousTokenStream</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">get</span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">if</span> (tokenStreams == null)</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="_documents_writer_8cs.html#a3bd6418bcbeb676f7dad24a00a2d6903">AlreadyClosedException</a>(<span class="stringliteral">"this Analyzer is closed"</span>);</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordflow">return</span> tokenStreams.Get();</div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  }</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">set</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  {</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">if</span> (tokenStreams == null)</div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  {</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="_documents_writer_8cs.html#a3bd6418bcbeb676f7dad24a00a2d6903">AlreadyClosedException</a>(<span class="stringliteral">"this Analyzer is closed"</span>);</div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  tokenStreams.Set(value);</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  [Obsolete()]</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keywordtype">bool</span> overridesTokenStreamMethod = <span class="keyword">false</span>;</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  [Obsolete(<span class="stringliteral">"This is only present to preserve back-compat of classes that subclass a core analyzer and override tokenStream but not reusableTokenStream "</span>)]</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetOverridesTokenStreamMethod<TClass>()</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  where TClass : <a class="code" href="_more_like_this_8cs.html#a7f807a855319cb4e1efa0e1fcd2a537f">Analyzer</a></div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  {</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">try</span></div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  {</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  System.Reflection.MethodInfo m = this.GetType().GetMethod(<span class="stringliteral">"TokenStream"</span>, <span class="keyword">new</span>[] { typeof(<span class="keywordtype">string</span>), typeof(System.IO.TextReader) });</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  overridesTokenStreamMethod = m.DeclaringType != typeof(TClass);</div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">catch</span> (MethodAccessException)</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  {</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="comment">// can't happen, as baseClass is subclass of Analyzer</span></div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  overridesTokenStreamMethod = <span class="keyword">false</span>;</div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div> |
| <div class="line"><a name="l00123"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#ace9d8916e2c0280b43369ffc119325c7"> 123</a></span>  <span class="keyword">public</span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetPositionIncrementGap(String fieldName)</div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  {</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordflow">return</span> 0;</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  }</div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  </div> |
| <div class="line"><a name="l00140"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#a333e181e02bf7f55a62f9a9dc828962e"> 140</a></span>  <span class="keyword">public</span> <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetOffsetGap(<a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> field)</div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  {</div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordflow">return</span> field.<a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a759bc03b5d9691321bda270434e381f0" title="True if the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are...">IsTokenized</a> ? 1 : 0;</div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  }</div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div> |
| <div class="line"><a name="l00146"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#aa1d893569bf85f78c973c1739386a0bb"> 146</a></span>  <span class="keyword">public</span> <span class="keywordtype">void</span> Close()</div> |
| <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  {</div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  Dispose();</div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  }</div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div> |
| <div class="line"><a name="l00151"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#a5d1c1073953da2696e12cb66b82eaa8a"> 151</a></span>  <span class="keyword">public</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Dispose()</div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  {</div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  Dispose(<span class="keyword">true</span>);</div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  }</div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div> |
| <div class="line"><a name="l00156"></a><span class="lineno"><a class="code" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html#acbe470079d1d35c819beb9820f72d536"> 156</a></span>  <span class="keyword">protected</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Dispose(<span class="keywordtype">bool</span> disposing)</div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  {</div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordflow">if</span> (isDisposed) <span class="keywordflow">return</span>;</div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordflow">if</span> (disposing)</div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  {</div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordflow">if</span> (tokenStreams != null)</div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  {</div> |
| <div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  tokenStreams.Close();</div> |
| <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  tokenStreams = null;</div> |
| <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  }</div> |
| <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  }</div> |
| <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  isDisposed = <span class="keyword">true</span>;</div> |
| <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  }</div> |
| <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  }</div> |
| <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> }</div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:44 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> |