| <!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.Shingle.ShingleMatrixFilter 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_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_shingle.html">Shingle</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html">ShingleMatrixFilter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Analysis.Shingle.ShingleMatrixFilter Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p> |
| <a href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">Lucene.Net.Analysis.TokenStream</a>.</p> |
| <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:aea72e4d6829fddd30e271965f80e7420"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#aea72e4d6829fddd30e271965f80e7420">ShingleMatrixFilter</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_matrix_1_1_matrix.html">Matrix.Matrix</a> matrix, int minimumShingleSize, int maximumShingleSize, Char spacerCharacter, bool ignoringSinglePrefixOrSuffixShingle, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html">TokenSettingsCodec</a> settingsCodec)</td></tr> |
| <tr class="memdesc:aea72e4d6829fddd30e271965f80e7420"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shingle filter based on a user defined matrix. <a href="#aea72e4d6829fddd30e271965f80e7420"></a><br/></td></tr> |
| <tr class="separator:aea72e4d6829fddd30e271965f80e7420"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5f78d3def785008c03e98a32cc527cf4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a5f78d3def785008c03e98a32cc527cf4">ShingleMatrixFilter</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> input, int minimumShingleSize, int maximumShingleSize)</td></tr> |
| <tr class="memdesc:a5f78d3def785008c03e98a32cc527cf4"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shingle filter using default settings. <a href="#a5f78d3def785008c03e98a32cc527cf4"></a><br/></td></tr> |
| <tr class="separator:a5f78d3def785008c03e98a32cc527cf4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a26d357e4c5d2420e5919e30f7e011e4d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a26d357e4c5d2420e5919e30f7e011e4d">ShingleMatrixFilter</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> input, int minimumShingleSize, int maximumShingleSize, Char?spacerCharacter)</td></tr> |
| <tr class="memdesc:a26d357e4c5d2420e5919e30f7e011e4d"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shingle filter using default settings. <a href="#a26d357e4c5d2420e5919e30f7e011e4d"></a><br/></td></tr> |
| <tr class="separator:a26d357e4c5d2420e5919e30f7e011e4d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3e4b19603d981084dc65609ccf598682"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a3e4b19603d981084dc65609ccf598682">ShingleMatrixFilter</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> input, int minimumShingleSize, int maximumShingleSize, Char?spacerCharacter, bool ignoringSinglePrefixOrSuffixShingle)</td></tr> |
| <tr class="memdesc:a3e4b19603d981084dc65609ccf598682"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shingle filter using the default TokenSettingsCodec. <a href="#a3e4b19603d981084dc65609ccf598682"></a><br/></td></tr> |
| <tr class="separator:a3e4b19603d981084dc65609ccf598682"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a93a71b35af8e53630737de4ce0c61889"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a93a71b35af8e53630737de4ce0c61889">ShingleMatrixFilter</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> input, int minimumShingleSize, int maximumShingleSize, Char?spacerCharacter, bool ignoringSinglePrefixOrSuffixShingle, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html">TokenSettingsCodec</a> settingsCodec)</td></tr> |
| <tr class="memdesc:a93a71b35af8e53630737de4ce0c61889"><td class="mdescLeft"> </td><td class="mdescRight">Creates a shingle filter with ad hoc parameter settings. <a href="#a93a71b35af8e53630737de4ce0c61889"></a><br/></td></tr> |
| <tr class="separator:a93a71b35af8e53630737de4ce0c61889"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a38d93cb7458afcbfae55dc3554e02e71"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a38d93cb7458afcbfae55dc3554e02e71">Reset</a> ()</td></tr> |
| <tr class="memdesc:a38d93cb7458afcbfae55dc3554e02e71"><td class="mdescLeft"> </td><td class="mdescRight">Resets this stream to the beginning. This is an optional operation, so subclasses may or may not implement this method. <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a38d93cb7458afcbfae55dc3554e02e71" title="Resets this stream to the beginning. This is an optional operation, so subclasses may or may not impl...">Reset()</a> is not needed for the standard indexing process. However, if the tokens of a <code><a class="el" 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></code> are intended to be consumed more than once, it is necessary to implement <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a38d93cb7458afcbfae55dc3554e02e71" title="Resets this stream to the beginning. This is an optional operation, so subclasses may or may not impl...">Reset()</a>. Note that if your <a class="el" 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> caches tokens and feeds them back again after a reset, it is imperative that you clone the tokens when you store them away (on the first pass) as well as when you return them (on future passes after <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a38d93cb7458afcbfae55dc3554e02e71" title="Resets this stream to the beginning. This is an optional operation, so subclasses may or may not impl...">Reset()</a>). <a href="#a38d93cb7458afcbfae55dc3554e02e71"></a><br/></td></tr> |
| <tr class="separator:a38d93cb7458afcbfae55dc3554e02e71"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae7bb9d5011b8527cf2571994d3492eae"><td class="memItemLeft" align="right" valign="top">override sealed bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#ae7bb9d5011b8527cf2571994d3492eae">IncrementToken</a> ()</td></tr> |
| <tr class="memdesc:ae7bb9d5011b8527cf2571994d3492eae"><td class="mdescLeft"> </td><td class="mdescRight">Consumers (i.e., <a class="el" href="_f_s_directory_8cs.html#a7d90824eac5b2433e714cc9faeb34d1b">IndexWriter</a>) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Util.Attribute</a>s with the attributes of the next token. <a href="#ae7bb9d5011b8527cf2571994d3492eae"></a><br/></td></tr> |
| <tr class="separator:ae7bb9d5011b8527cf2571994d3492eae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2df2953ae09d1779348232f7e7ea471e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a2df2953ae09d1779348232f7e7ea471e">UpdateToken</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> token, List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> > shingle, int currentPermutationStartOffset, List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_matrix_1_1_row.html">Row</a> > currentPermutationRows, List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> > currentPermuationTokens)</td></tr> |
| <tr class="memdesc:a2df2953ae09d1779348232f7e7ea471e"><td class="mdescLeft"> </td><td class="mdescRight">Final touch of a shingle token before it is passed on to the consumer from method <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#ae7bb9d5011b8527cf2571994d3492eae" title="Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate Util.Attributes with the attributes of the next token.">IncrementToken()</a>. <a href="#a2df2953ae09d1779348232f7e7ea471e"></a><br/></td></tr> |
| <tr class="separator:a2df2953ae09d1779348232f7e7ea471e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7dc744291b09100cca6b76e32a597bb3"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a7dc744291b09100cca6b76e32a597bb3">CalculateShingleWeight</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> shingleToken, List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> > shingle, int currentPermutationStartOffset, List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_matrix_1_1_row.html">Row</a> > currentPermutationRows, List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> > currentPermuationTokens)</td></tr> |
| <tr class="memdesc:a7dc744291b09100cca6b76e32a597bb3"><td class="mdescLeft"> </td><td class="mdescRight">Evaluates the new shingle token weight. <a href="#a7dc744291b09100cca6b76e32a597bb3"></a><br/></td></tr> |
| <tr class="separator:a7dc744291b09100cca6b76e32a597bb3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_token_stream"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_token_stream')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">Lucene.Net.Analysis.TokenStream</a></td></tr> |
| <tr class="memitem:a92b3c4eab12fbf83daa07b7684cfbcaf inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_token_stream"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html#a92b3c4eab12fbf83daa07b7684cfbcaf">End</a> ()</td></tr> |
| <tr class="memdesc:a92b3c4eab12fbf83daa07b7684cfbcaf inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_token_stream"><td class="mdescLeft"> </td><td class="mdescRight">This method is called by the consumer after the last token has been consumed, after <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html#a358a544108511440a57b134e722f6027" title="Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate Util.Attributes with the attributes of the next token.">IncrementToken</a> returned <code>false</code> (using the new <code><a class="el" 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></code> API). Streams implementing the old API should upgrade to use this feature. This method can be used to perform any end-of-stream operations, such as setting the final offset of a stream. The final offset of a stream might differ from the offset of the last token eg in case one or more whitespaces followed after the last token, but a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_whitespace_tokenizer.html" title="A WhitespaceTokenizer is a tokenizer that divides text at whitespace. Adjacent sequences of non-White...">WhitespaceTokenizer</a> was used. <a href="#a92b3c4eab12fbf83daa07b7684cfbcaf"></a><br/></td></tr> |
| <tr class="separator:a92b3c4eab12fbf83daa07b7684cfbcaf inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_token_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5f66ac4c37218611b4a13f81f98332cd inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_token_stream"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html#a5f66ac4c37218611b4a13f81f98332cd">Close</a> ()</td></tr> |
| <tr class="memdesc:a5f66ac4c37218611b4a13f81f98332cd inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_token_stream"><td class="mdescLeft"> </td><td class="mdescRight">Releases resources associated with this stream. <a href="#a5f66ac4c37218611b4a13f81f98332cd"></a><br/></td></tr> |
| <tr class="separator:a5f66ac4c37218611b4a13f81f98332cd inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_token_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aae80b4c03fb07780821b0bbecbf472b2 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_token_stream"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html#aae80b4c03fb07780821b0bbecbf472b2">Dispose</a> ()</td></tr> |
| <tr class="separator:aae80b4c03fb07780821b0bbecbf472b2 inherit pub_methods_class_lucene_1_1_net_1_1_analysis_1_1_token_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html">Lucene.Net.Util.AttributeSource</a></td></tr> |
| <tr class="memitem:af8654555ddde74d7e463266371f3508c inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#af8654555ddde74d7e463266371f3508c">AttributeSource</a> ()</td></tr> |
| <tr class="memdesc:af8654555ddde74d7e463266371f3508c inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">An <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> using the default attribute factory AttributeSource.AttributeFactory.DEFAULT_ATTRIBUTE_FACTORY. <a href="#af8654555ddde74d7e463266371f3508c"></a><br/></td></tr> |
| <tr class="separator:af8654555ddde74d7e463266371f3508c inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4657daf56cbc2d4510904a77d945997c inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a4657daf56cbc2d4510904a77d945997c">AttributeSource</a> (<a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html">AttributeSource</a> input)</td></tr> |
| <tr class="memdesc:a4657daf56cbc2d4510904a77d945997c inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">An <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> that uses the same attributes as the supplied one. <a href="#a4657daf56cbc2d4510904a77d945997c"></a><br/></td></tr> |
| <tr class="separator:a4657daf56cbc2d4510904a77d945997c inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4372366a8ca0b624dae66733e3553386 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a4372366a8ca0b624dae66733e3553386">AttributeSource</a> (<a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source_1_1_attribute_factory.html">AttributeFactory</a> factory)</td></tr> |
| <tr class="memdesc:a4372366a8ca0b624dae66733e3553386 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">An <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> using the supplied <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source_1_1_attribute_factory.html" title="An AttributeFactory creates instances of Attributes.">AttributeFactory</a> for creating new <a class="el" href="interface_lucene_1_1_net_1_1_util_1_1_i_attribute.html" title="Base interface for attributes.">IAttribute</a> instances. <a href="#a4372366a8ca0b624dae66733e3553386"></a><br/></td></tr> |
| <tr class="separator:a4372366a8ca0b624dae66733e3553386 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaca60de1d129a37ebe8e53c0a4998b9b inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">virtual IEnumerable< Type > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#aaca60de1d129a37ebe8e53c0a4998b9b">GetAttributeTypesIterator</a> ()</td></tr> |
| <tr class="memdesc:aaca60de1d129a37ebe8e53c0a4998b9b inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new iterator that iterates the attribute classes in the same order they were added in. Signature for Java 1.5: <code>public Iterator<Class<? extends <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a>>> getAttributeClassesIterator()</code> <a href="#aaca60de1d129a37ebe8e53c0a4998b9b"></a><br/></td></tr> |
| <tr class="separator:aaca60de1d129a37ebe8e53c0a4998b9b inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeac0f9d6ba00ffe0befc22c2f72d22f2 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">virtual IEnumerable< <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html">Attribute</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#aeac0f9d6ba00ffe0befc22c2f72d22f2">GetAttributeImplsIterator</a> ()</td></tr> |
| <tr class="memdesc:aeac0f9d6ba00ffe0befc22c2f72d22f2 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new iterator that iterates all unique <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a> implementations. This iterator may contain less entries that <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#aaca60de1d129a37ebe8e53c0a4998b9b" title="Returns a new iterator that iterates the attribute classes in the same order they were added in...">GetAttributeTypesIterator</a>, if one instance implements more than one <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a> interface. Signature for Java 1.5: <code>public Iterator<AttributeImpl> getAttributeImplsIterator()</code> <a href="#aeac0f9d6ba00ffe0befc22c2f72d22f2"></a><br/></td></tr> |
| <tr class="separator:aeac0f9d6ba00ffe0befc22c2f72d22f2 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa077979929068d17e3a5627fa5c1c180 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#aa077979929068d17e3a5627fa5c1c180">AddAttributeImpl</a> (<a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html">Attribute</a> att)</td></tr> |
| <tr class="memdesc:aa077979929068d17e3a5627fa5c1c180 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight"><b>Expert:</b> Adds a custom AttributeImpl instance with one or more <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a> interfaces. <a href="#aa077979929068d17e3a5627fa5c1c180"></a><br/></td></tr> |
| <tr class="separator:aa077979929068d17e3a5627fa5c1c180 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a024db4fdac7177bbec9ccf0a55947ac8 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">virtual T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a024db4fdac7177bbec9ccf0a55947ac8">AddAttribute< T ></a> ()</td></tr> |
| <tr class="memdesc:a024db4fdac7177bbec9ccf0a55947ac8 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">The caller must pass in a Class<? extends <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a>> value. This method first checks if an instance of that class is already in this <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> and returns it. Otherwise a new instance is created, added to this <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> and returned. <a href="#a024db4fdac7177bbec9ccf0a55947ac8"></a><br/></td></tr> |
| <tr class="separator:a024db4fdac7177bbec9ccf0a55947ac8 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a944174da417e353469198d70f71ab074 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a944174da417e353469198d70f71ab074">HasAttribute< T ></a> ()</td></tr> |
| <tr class="memdesc:a944174da417e353469198d70f71ab074 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">The caller must pass in a Class<? extends <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a>> value. Returns true, iff this <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> contains the passed-in <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a>. <a href="#a944174da417e353469198d70f71ab074"></a><br/></td></tr> |
| <tr class="separator:a944174da417e353469198d70f71ab074 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a13d275abdba07913cee5cd2ab139b545 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">virtual T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a13d275abdba07913cee5cd2ab139b545">GetAttribute< T ></a> ()</td></tr> |
| <tr class="memdesc:a13d275abdba07913cee5cd2ab139b545 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">The caller must pass in a Class<? extends <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a>> value. Returns the instance of the passed in <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a> contained in this <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> <a href="#a13d275abdba07913cee5cd2ab139b545"></a><br/></td></tr> |
| <tr class="separator:a13d275abdba07913cee5cd2ab139b545 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a10993674504f3065a2320a6c498c773e inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a10993674504f3065a2320a6c498c773e">ClearAttributes</a> ()</td></tr> |
| <tr class="memdesc:a10993674504f3065a2320a6c498c773e inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">Resets all Attributes in this <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> by calling <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html#ad9e96b3c91feb9bc6014150c8027884b" title="Clears the values in this AttributeImpl and resets it to its default value. If this implementation im...">Attribute.Clear()</a> on each <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a> implementation. <a href="#a10993674504f3065a2320a6c498c773e"></a><br/></td></tr> |
| <tr class="separator:a10993674504f3065a2320a6c498c773e inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab94ad5134881f56412343ef1eb1b601b inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source_1_1_state.html">State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#ab94ad5134881f56412343ef1eb1b601b">CaptureState</a> ()</td></tr> |
| <tr class="memdesc:ab94ad5134881f56412343ef1eb1b601b inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">Captures the state of all Attributes. The return value can be passed to <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a0a875f18e12c9c37c6447a6d9bb04e44" title="Restores this state by copying the values of all attribute implementations that this state contains i...">RestoreState</a> to restore the state of this or another <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a>. <a href="#ab94ad5134881f56412343ef1eb1b601b"></a><br/></td></tr> |
| <tr class="separator:ab94ad5134881f56412343ef1eb1b601b inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0a875f18e12c9c37c6447a6d9bb04e44 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a0a875f18e12c9c37c6447a6d9bb04e44">RestoreState</a> (<a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source_1_1_state.html">State</a> state)</td></tr> |
| <tr class="memdesc:a0a875f18e12c9c37c6447a6d9bb04e44 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">Restores this state by copying the values of all attribute implementations that this state contains into the attributes implementations of the targetStream. The targetStream must contain a corresponding instance for each argument contained in this state (e.g. it is not possible to restore the state of an <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> containing a TermAttribute into a <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> using a Token instance as implementation). <a href="#a0a875f18e12c9c37c6447a6d9bb04e44"></a><br/></td></tr> |
| <tr class="separator:a0a875f18e12c9c37c6447a6d9bb04e44 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5094d29f2eee8d0382599c92d4942c6b inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a5094d29f2eee8d0382599c92d4942c6b">GetHashCode</a> ()</td></tr> |
| <tr class="separator:a5094d29f2eee8d0382599c92d4942c6b inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8a964f3c705f0565903edfb4961d522d inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">override bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a8a964f3c705f0565903edfb4961d522d">Equals</a> (System.Object obj)</td></tr> |
| <tr class="separator:a8a964f3c705f0565903edfb4961d522d inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a40578cd0ceac27cc1c8107865af89b2a inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a40578cd0ceac27cc1c8107865af89b2a">ToString</a> ()</td></tr> |
| <tr class="separator:a40578cd0ceac27cc1c8107865af89b2a inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a63aa777fc3258cfe0ff89b879bddb376 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html">AttributeSource</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a63aa777fc3258cfe0ff89b879bddb376">CloneAttributes</a> ()</td></tr> |
| <tr class="memdesc:a63aa777fc3258cfe0ff89b879bddb376 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="mdescLeft"> </td><td class="mdescRight">Performs a clone of all <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Attribute</a> instances returned in a new <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html" title="An AttributeSource contains a list of different Attributes, and methods to add and get them...">AttributeSource</a> instance. This method can be used to e.g. create another TokenStream with exactly the same attributes (using <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute_source.html#a4657daf56cbc2d4510904a77d945997c" title="An AttributeSource that uses the same attributes as the supplied one.">AttributeSource(AttributeSource)</a>) <a href="#a63aa777fc3258cfe0ff89b879bddb376"></a><br/></td></tr> |
| <tr class="separator:a63aa777fc3258cfe0ff89b879bddb376 inherit pub_methods_class_lucene_1_1_net_1_1_util_1_1_attribute_source"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:a2deaf44ecf0cc7f94480533b1d7a79b0"><td class="memItemLeft" align="right" valign="top">static Char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a2deaf44ecf0cc7f94480533b1d7a79b0">DefaultSpacerCharacter</a> = '_'</td></tr> |
| <tr class="separator:a2deaf44ecf0cc7f94480533b1d7a79b0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aacaf6867e8f8ce97180ae242dce66e84"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html">TokenSettingsCodec</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#aacaf6867e8f8ce97180ae242dce66e84">DefaultSettingsCodec</a> = new <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_one_dimensional_non_weighted_token_settings_codec.html">OneDimensionalNonWeightedTokenSettingsCodec</a>()</td></tr> |
| <tr class="separator:aacaf6867e8f8ce97180ae242dce66e84"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:affcc6c28d33ed4f37664fcfebb8f785c"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#affcc6c28d33ed4f37664fcfebb8f785c">IgnoringSinglePrefixOrSuffixShingleByDefault</a></td></tr> |
| <tr class="separator:affcc6c28d33ed4f37664fcfebb8f785c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a78c40485f765e2b702cf2c6a130311ba"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a78c40485f765e2b702cf2c6a130311ba">Dispose</a> (bool disposing)</td></tr> |
| <tr class="separator:a78c40485f765e2b702cf2c6a130311ba"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a424dba19bb5eeca1a76a0c0ab2795b74"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a424dba19bb5eeca1a76a0c0ab2795b74">MinimumShingleSize</a><code> [get, set]</code></td></tr> |
| <tr class="separator:a424dba19bb5eeca1a76a0c0ab2795b74"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a85cc8643cd71bd5348971d3113ebcbcc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a85cc8643cd71bd5348971d3113ebcbcc">MaximumShingleSize</a><code> [get, set]</code></td></tr> |
| <tr class="separator:a85cc8643cd71bd5348971d3113ebcbcc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a408182346270e41b52722538d77d1d85"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_matrix_1_1_matrix.html">Matrix.Matrix</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a408182346270e41b52722538d77d1d85">Matrix</a><code> [get, set]</code></td></tr> |
| <tr class="separator:a408182346270e41b52722538d77d1d85"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a759eeced2e5ffc9900e4dc0844bf1cfe"><td class="memItemLeft" align="right" valign="top">Char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a759eeced2e5ffc9900e4dc0844bf1cfe">SpacerCharacter</a><code> [get, set]</code></td></tr> |
| <tr class="separator:a759eeced2e5ffc9900e4dc0844bf1cfe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae5927e0811018481f2cea8b64b740942"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#ae5927e0811018481f2cea8b64b740942">IsIgnoringSinglePrefixOrSuffixShingle</a><code> [get, set]</code></td></tr> |
| <tr class="separator:ae5927e0811018481f2cea8b64b740942"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html">ShingleMatrixFilter</a> constructs shingles (token n-grams) from a token stream. In other words, it creates combinations of tokens as a single token.</p> |
| <p>For example, the sentence "please divide this sentence into shingles" might be tokenized into shingles "please divide", "divide this", "this sentence", "sentence into", and "into shingles".</p> |
| <p>Using a shingle filter at index and query time can in some instances be used to replace phrase queries, especially them with 0 slop.</p> |
| <p>Without a spacer character it can be used to handle composition and decomposition of words such as searching for "multi dimensional" instead of "multidimensional". It is a rather common human problem at query time in several languages, notably the northern Germanic branch.</p> |
| <p>Shingles are amongst many things also known to solve problems in spell checking, language detection and document clustering.</p> |
| <p>This filter is backed by a three dimensional column oriented matrix used to create permutations of the second dimension, the rows, and leaves the third, the z-axis, for for multi token synonyms.</p> |
| <p>In order to use this filter you need to define a way of positioning the input stream tokens in the matrix. This is done using a ShingleMatrixFilter.TokenSettingsCodec. There are three simple implementations for demonstrational purposes, see ShingleMatrixFilter.OneDimensionalNonWeightedTokenSettingsCodec, ShingleMatrixFilter.TwoDimensionalNonWeightedSynonymTokenSettingsCodec and ShingleMatrixFilter.SimpleThreeDimensionalTokenSettingsCodec.</p> |
| <p>Consider this token matrix:</p> |
| <pre> |
| <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html" title="A Token is an occurrence of a term from the text of a field. It consists of a term's text...">Token</a>[column][row][z-axis]{ |
| {{hello}, {greetings, and, salutations}}, |
| {{world}, {earth}, {tellus}} |
| }; |
| </pre><p>It would produce the following 2-3 gram sized shingles:</p> |
| <pre> |
| "hello_world" |
| "greetings_and" |
| "greetings_and_salutations" |
| "and_salutations" |
| "and_salutations_world" |
| "salutations_world" |
| "hello_earth" |
| "and_salutations_earth" |
| "salutations_earth" |
| "hello_tellus" |
| "and_salutations_tellus" |
| "salutations_tellus" |
| </pre><p>This implementation can be rather heap demanding if (maximum shingle size - minimum shingle size) is a great number and the stream contains many columns, or if each column contains a great number of rows.</p> |
| <p>The problem is that in order avoid producing duplicates the filter needs to keep track of any shingle already produced and returned to the consumer.</p> |
| <p>There is a bit of resource management to handle this but it would of course be much better if the filter was written so it never created the same shingle more than once in the first place.</p> |
| <p>The filter also has basic support for calculating weights for the shingles based on the weights of the tokens from the input stream, output shingle size, etc. See CalculateShingleWeight. </p> |
| <p><b>NOTE:</b> This filter might not behave correctly if used with custom Attributes, i.e. Attributes other than the ones located in org.apache.lucene.analysis.tokenattributes.</p> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00105">105</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="aea72e4d6829fddd30e271965f80e7420"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.ShingleMatrixFilter </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_matrix_1_1_matrix.html">Matrix.Matrix</a> </td> |
| <td class="paramname"><em>matrix</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>minimumShingleSize</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>maximumShingleSize</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Char </td> |
| <td class="paramname"><em>spacerCharacter</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>ignoringSinglePrefixOrSuffixShingle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html">TokenSettingsCodec</a> </td> |
| <td class="paramname"><em>settingsCodec</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a shingle filter based on a user defined matrix. </p> |
| <p>The filter /will/ delete columns from the input matrix! You will not be able to reset the filter if you used this constructor. todo: don't touch the matrix! use a bool, set the input stream to null or something, and keep track of where in the matrix we are at.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">matrix</td><td>the input based for creating shingles. Does not need to contain any information until <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#ae7bb9d5011b8527cf2571994d3492eae" title="Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate Util.Attributes with the attributes of the next token.">ShingleMatrixFilter.IncrementToken()</a> is called the first time.</td></tr> |
| <tr><td class="paramname">minimumShingleSize</td><td>minimum number of tokens in any shingle.</td></tr> |
| <tr><td class="paramname">maximumShingleSize</td><td>maximum number of tokens in any shingle.</td></tr> |
| <tr><td class="paramname">spacerCharacter</td><td>character to use between texts of the token parts in a shingle. null for none.</td></tr> |
| <tr><td class="paramname">ignoringSinglePrefixOrSuffixShingle</td><td>if true, shingles that only contains permutation of the first of the last column will not be produced as shingles. Useful when adding boundary marker tokens such as '^' and '$'.</td></tr> |
| <tr><td class="paramname">settingsCodec</td><td>codec used to read input token weight and matrix positioning.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00166">166</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5f78d3def785008c03e98a32cc527cf4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.ShingleMatrixFilter </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td> |
| <td class="paramname"><em>input</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>minimumShingleSize</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>maximumShingleSize</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a shingle filter using default settings. </p> |
| <p>See <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a2deaf44ecf0cc7f94480533b1d7a79b0">ShingleMatrixFilter.DefaultSpacerCharacter</a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#affcc6c28d33ed4f37664fcfebb8f785c">ShingleMatrixFilter.IgnoringSinglePrefixOrSuffixShingleByDefault</a>, and <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#aacaf6867e8f8ce97180ae242dce66e84">ShingleMatrixFilter.DefaultSettingsCodec</a> </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">input</td><td>stream from which to construct the matrix</td></tr> |
| <tr><td class="paramname">minimumShingleSize</td><td>minimum number of tokens in any shingle.</td></tr> |
| <tr><td class="paramname">maximumShingleSize</td><td>maximum number of tokens in any shingle.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00205">205</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a26d357e4c5d2420e5919e30f7e011e4d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.ShingleMatrixFilter </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td> |
| <td class="paramname"><em>input</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>minimumShingleSize</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>maximumShingleSize</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Char? </td> |
| <td class="paramname"><em>spacerCharacter</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a shingle filter using default settings. </p> |
| <p>See IgnoringSinglePrefixOrSuffixShingleByDefault, and DefaultSettingsCodec </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">input</td><td>stream from which to construct the matrix</td></tr> |
| <tr><td class="paramname">minimumShingleSize</td><td>minimum number of tokens in any shingle.</td></tr> |
| <tr><td class="paramname">maximumShingleSize</td><td>maximum number of tokens in any shingle.</td></tr> |
| <tr><td class="paramname">spacerCharacter</td><td>character to use between texts of the token parts in a shingle. null for none. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00217">217</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3e4b19603d981084dc65609ccf598682"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.ShingleMatrixFilter </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td> |
| <td class="paramname"><em>input</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>minimumShingleSize</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>maximumShingleSize</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Char? </td> |
| <td class="paramname"><em>spacerCharacter</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>ignoringSinglePrefixOrSuffixShingle</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a shingle filter using the default TokenSettingsCodec. </p> |
| <p>See DefaultSettingsCodec </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">input</td><td>stream from which to construct the matrix</td></tr> |
| <tr><td class="paramname">minimumShingleSize</td><td>minimum number of tokens in any shingle.</td></tr> |
| <tr><td class="paramname">maximumShingleSize</td><td>maximum number of tokens in any shingle.</td></tr> |
| <tr><td class="paramname">spacerCharacter</td><td>character to use between texts of the token parts in a shingle. null for none.</td></tr> |
| <tr><td class="paramname">ignoringSinglePrefixOrSuffixShingle</td><td>if true, shingles that only contains permutation of the first of the last column will not be produced as shingles. Useful when adding boundary marker tokens such as '^' and '$'.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00230">230</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a93a71b35af8e53630737de4ce0c61889"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.ShingleMatrixFilter </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td> |
| <td class="paramname"><em>input</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>minimumShingleSize</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>maximumShingleSize</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Char? </td> |
| <td class="paramname"><em>spacerCharacter</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>ignoringSinglePrefixOrSuffixShingle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html">TokenSettingsCodec</a> </td> |
| <td class="paramname"><em>settingsCodec</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a shingle filter with ad hoc parameter settings. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">input</td><td>stream from which to construct the matrix</td></tr> |
| <tr><td class="paramname">minimumShingleSize</td><td>minimum number of tokens in any shingle.</td></tr> |
| <tr><td class="paramname">maximumShingleSize</td><td>maximum number of tokens in any shingle.</td></tr> |
| <tr><td class="paramname">spacerCharacter</td><td>character to use between texts of the token parts in a shingle. null for none.</td></tr> |
| <tr><td class="paramname">ignoringSinglePrefixOrSuffixShingle</td><td>if true, shingles that only contains permutation of the first of the last column will not be produced as shingles. Useful when adding boundary marker tokens such as '^' and '$'.</td></tr> |
| <tr><td class="paramname">settingsCodec</td><td>codec used to read input token weight and matrix positioning.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00242">242</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a7dc744291b09100cca6b76e32a597bb3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">float Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.CalculateShingleWeight </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> </td> |
| <td class="paramname"><em>shingleToken</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> > </td> |
| <td class="paramname"><em>shingle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>currentPermutationStartOffset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_matrix_1_1_row.html">Row</a> > </td> |
| <td class="paramname"><em>currentPermutationRows</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> > </td> |
| <td class="paramname"><em>currentPermuationTokens</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Evaluates the new shingle token weight. </p> |
| <p>for (shingle part token in shingle) weight += shingle part token weight * (1 / sqrt(all shingle part token weights summed))</p> |
| <p>This algorithm gives a slightly greater score for longer shingles and is rather penalising to great shingle token part weights. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">shingleToken</td><td>token returned to consumer</td></tr> |
| <tr><td class="paramname">shingle</td><td>tokens the tokens used to produce the shingle token.</td></tr> |
| <tr><td class="paramname">currentPermutationStartOffset</td><td>start offset in parameter currentPermutationRows and currentPermutationTokens.</td></tr> |
| <tr><td class="paramname">currentPermutationRows</td><td>an index to what matrix row a token in parameter currentPermutationTokens exist.</td></tr> |
| <tr><td class="paramname">currentPermuationTokens</td><td>all tokens in the current row permutation of the matrix. A sub list (parameter offset, parameter shingle.size) equals parameter shingle.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>weight to be set for parameter shingleToken </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00557">557</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a78c40485f765e2b702cf2c6a130311ba"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override void Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.Dispose </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>disposing</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html#a508c67675f1fa1e9c7b229452945e24a">Lucene.Net.Analysis.TokenStream</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00285">285</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae7bb9d5011b8527cf2571994d3492eae"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override sealed bool Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.IncrementToken </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>Consumers (i.e., <a class="el" href="_f_s_directory_8cs.html#a7d90824eac5b2433e714cc9faeb34d1b">IndexWriter</a>) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Util.Attribute</a>s with the attributes of the next token. </p> |
| <p>The producer must make no assumptions about the attributes after the method has been returned: the caller may arbitrarily change it. If the producer needs to preserve the state for subsequent calls, it can use AttributeSource.CaptureState to create a copy of the current attribute state.</p> |
| <p>This method is called for every token of a document, so an efficient implementation is crucial for good performance. To avoid calls to AttributeSource.AddAttribute{T}() and AttributeSource.GetAttribute{T}(), references to all <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html" title="Base class for Attributes that can be added to a Lucene.Net.Util.AttributeSource. Attributes are used...">Util.Attribute</a>s that this stream uses should be retrieved during instantiation.</p> |
| <p>To ensure that filters and consumers know which attributes are available, the attributes must be added during instantiation. Filters and consumers are not required to check for availability of attributes in <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#ae7bb9d5011b8527cf2571994d3492eae" title="Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate Util.Attributes with the attributes of the next token.">IncrementToken()</a>.</p> |
| <dl class="section return"><dt>Returns</dt><dd>false for end of stream; true otherwise</dd></dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html#a358a544108511440a57b134e722f6027">Lucene.Net.Analysis.TokenStream</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00290">290</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a38d93cb7458afcbfae55dc3554e02e71"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override void Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.Reset </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>Resets this stream to the beginning. This is an optional operation, so subclasses may or may not implement this method. <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a38d93cb7458afcbfae55dc3554e02e71" title="Resets this stream to the beginning. This is an optional operation, so subclasses may or may not impl...">Reset()</a> is not needed for the standard indexing process. However, if the tokens of a <code><a class="el" 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></code> are intended to be consumed more than once, it is necessary to implement <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a38d93cb7458afcbfae55dc3554e02e71" title="Resets this stream to the beginning. This is an optional operation, so subclasses may or may not impl...">Reset()</a>. Note that if your <a class="el" 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> caches tokens and feeds them back again after a reset, it is imperative that you clone the tokens when you store them away (on the first pass) as well as when you return them (on future passes after <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a38d93cb7458afcbfae55dc3554e02e71" title="Resets this stream to the beginning. This is an optional operation, so subclasses may or may not impl...">Reset()</a>). </p> |
| |
| <p>Reimplemented from <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html#af7c4a3464dc78b1d0451492d9c520965">Lucene.Net.Analysis.TokenStream</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00278">278</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2df2953ae09d1779348232f7e7ea471e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.UpdateToken </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> </td> |
| <td class="paramname"><em>token</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> > </td> |
| <td class="paramname"><em>shingle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>currentPermutationStartOffset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_matrix_1_1_row.html">Row</a> > </td> |
| <td class="paramname"><em>currentPermutationRows</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">List< <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> > </td> |
| <td class="paramname"><em>currentPermuationTokens</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Final touch of a shingle token before it is passed on to the consumer from method <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#ae7bb9d5011b8527cf2571994d3492eae" title="Consumers (i.e., IndexWriter) use this method to advance the stream to the next token. Implementing classes must implement this method and update the appropriate Util.Attributes with the attributes of the next token.">IncrementToken()</a>. </p> |
| <p>Calculates and sets type, flags, position increment, start/end offsets and weight. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">token</td><td><a class="el" href="namespace_lucene_1_1_net_1_1_analysis_1_1_shingle.html">Shingle</a> <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html" title="A Token is an occurrence of a term from the text of a field. It consists of a term's text...">Token</a></td></tr> |
| <tr><td class="paramname">shingle</td><td>Tokens used to produce the shingle token.</td></tr> |
| <tr><td class="paramname">currentPermutationStartOffset</td><td>Start offset in parameter currentPermutationTokens</td></tr> |
| <tr><td class="paramname">currentPermutationRows</td><td>index to Matrix.Column.Row from the position of tokens in parameter currentPermutationTokens</td></tr> |
| <tr><td class="paramname">currentPermuationTokens</td><td>tokens of the current permutation of rows in the matrix. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00528">528</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="aacaf6867e8f8ce97180ae242dce66e84"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html">TokenSettingsCodec</a> Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.DefaultSettingsCodec = new <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_one_dimensional_non_weighted_token_settings_codec.html">OneDimensionalNonWeightedTokenSettingsCodec</a>()</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>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00108">108</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2deaf44ecf0cc7f94480533b1d7a79b0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Char Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.DefaultSpacerCharacter = '_'</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>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00107">107</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="affcc6c28d33ed4f37664fcfebb8f785c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.IgnoringSinglePrefixOrSuffixShingleByDefault</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>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00109">109</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="ae5927e0811018481f2cea8b64b740942"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.IsIgnoringSinglePrefixOrSuffixShingle</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00276">276</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a408182346270e41b52722538d77d1d85"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_matrix_1_1_matrix.html">Matrix.Matrix</a> Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.Matrix</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00272">272</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a85cc8643cd71bd5348971d3113ebcbcc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.MaximumShingleSize</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00270">270</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a424dba19bb5eeca1a76a0c0ab2795b74"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.MinimumShingleSize</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00268">268</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a759eeced2e5ffc9900e4dc0844bf1cfe"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Char Lucene.Net.Analysis.Shingle.ShingleMatrixFilter.SpacerCharacter</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_shingle_matrix_filter_8cs_source.html#l00274">274</a> of file <a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>contrib/Analyzers/Shingle/<a class="el" href="_shingle_matrix_filter_8cs_source.html">ShingleMatrixFilter.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:49 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> |
