Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_one_dimensional_non_weighted_token_settings_codec.html
blob: e1142f4aa65748be920632c9a192675353bdc21d [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Analysis.Shingle.Codec.OneDimensionalNonWeightedTokenSettingsCodec Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_analysis.html">Analysis</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_analysis_1_1_shingle.html">Shingle</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec.html">Codec</a></li><li class="navelem"><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></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_one_dimensional_non_weighted_token_settings_codec-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Analysis.Shingle.Codec.OneDimensionalNonWeightedTokenSettingsCodec Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Using this codec makes a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html">ShingleMatrixFilter</a> act like <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_filter.html">ShingleFilter</a>. It produces the most simple sort of shingles, ignoring token position increments, etc.
<a 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#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html">Lucene.Net.Analysis.Shingle.Codec.TokenSettingsCodec</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:a7123c4b37d619ef476a6860a4ef5a716"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_token_positioner.html">TokenPositioner</a>&#160;</td><td class="memItemRight" valign="bottom"><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#a7123c4b37d619ef476a6860a4ef5a716">GetTokenPositioner</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> token)</td></tr>
<tr class="memdesc:a7123c4b37d619ef476a6860a4ef5a716"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves information on how 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&#39;s text...">Token</a> is to be inserted to a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a408182346270e41b52722538d77d1d85">ShingleMatrixFilter.Matrix</a>. <a href="#a7123c4b37d619ef476a6860a4ef5a716"></a><br/></td></tr>
<tr class="separator:a7123c4b37d619ef476a6860a4ef5a716"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1a0a76157bda2bc04cbc0857fd6e218"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><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#ab1a0a76157bda2bc04cbc0857fd6e218">SetTokenPositioner</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> token, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_token_positioner.html">TokenPositioner</a> tokenPositioner)</td></tr>
<tr class="memdesc:ab1a0a76157bda2bc04cbc0857fd6e218"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets information on how 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&#39;s text...">Token</a> is to be inserted to a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a408182346270e41b52722538d77d1d85">ShingleMatrixFilter.Matrix</a>. <a href="#ab1a0a76157bda2bc04cbc0857fd6e218"></a><br/></td></tr>
<tr class="separator:ab1a0a76157bda2bc04cbc0857fd6e218"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adad6192aaae0beec826a267042e74613"><td class="memItemLeft" align="right" valign="top">override float&#160;</td><td class="memItemRight" valign="bottom"><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#adad6192aaae0beec826a267042e74613">GetWeight</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> token)</td></tr>
<tr class="memdesc:adad6192aaae0beec826a267042e74613"><td class="mdescLeft">&#160;</td><td class="mdescRight">Have this method return 1f in order to 'disable' weights. <a href="#adad6192aaae0beec826a267042e74613"></a><br/></td></tr>
<tr class="separator:adad6192aaae0beec826a267042e74613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a412d1a3f2747812e59e35a31c10503c7"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><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#a412d1a3f2747812e59e35a31c10503c7">SetWeight</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> token, float weight)</td></tr>
<tr class="memdesc:a412d1a3f2747812e59e35a31c10503c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Have this method do nothing in order to 'disable' weights. <a href="#a412d1a3f2747812e59e35a31c10503c7"></a><br/></td></tr>
<tr class="separator:a412d1a3f2747812e59e35a31c10503c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Using this codec makes a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html">ShingleMatrixFilter</a> act like <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_filter.html">ShingleFilter</a>. It produces the most simple sort of shingles, ignoring token position increments, etc. </p>
<p>It adds each token as a new column. </p>
<p>Definition at line <a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html#l00026">26</a> of file <a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html">OneDimensionalNonWeightedTokenSettingsCodec.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7123c4b37d619ef476a6860a4ef5a716"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_token_positioner.html">TokenPositioner</a> Lucene.Net.Analysis.Shingle.Codec.OneDimensionalNonWeightedTokenSettingsCodec.GetTokenPositioner </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a>&#160;</td>
<td class="paramname"><em>token</em></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>Retrieves information on how 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&#39;s text...">Token</a> is to be inserted to a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a408182346270e41b52722538d77d1d85">ShingleMatrixFilter.Matrix</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">token</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html#a161f5739102c81075d0b36f419173821">Lucene.Net.Analysis.Shingle.Codec.TokenSettingsCodec</a>.</p>
<p>Definition at line <a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html#l00028">28</a> of file <a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html">OneDimensionalNonWeightedTokenSettingsCodec.cs</a>.</p>
</div>
</div>
<a class="anchor" id="adad6192aaae0beec826a267042e74613"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override float Lucene.Net.Analysis.Shingle.Codec.OneDimensionalNonWeightedTokenSettingsCodec.GetWeight </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a>&#160;</td>
<td class="paramname"><em>token</em></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>Have this method return 1f in order to 'disable' weights. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">token</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html#a0bf78252207b7c8df66335c0ed6fd279">Lucene.Net.Analysis.Shingle.Codec.TokenSettingsCodec</a>.</p>
<p>Definition at line <a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html#l00037">37</a> of file <a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html">OneDimensionalNonWeightedTokenSettingsCodec.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab1a0a76157bda2bc04cbc0857fd6e218"></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.Codec.OneDimensionalNonWeightedTokenSettingsCodec.SetTokenPositioner </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a>&#160;</td>
<td class="paramname"><em>token</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_token_positioner.html">TokenPositioner</a>&#160;</td>
<td class="paramname"><em>tokenPositioner</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Sets information on how 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&#39;s text...">Token</a> is to be inserted to a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_shingle_matrix_filter.html#a408182346270e41b52722538d77d1d85">ShingleMatrixFilter.Matrix</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">token</td><td></td></tr>
<tr><td class="paramname">tokenPositioner</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html#a78a3bd27c1bba452179d182cccddc4fe">Lucene.Net.Analysis.Shingle.Codec.TokenSettingsCodec</a>.</p>
<p>Definition at line <a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html#l00033">33</a> of file <a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html">OneDimensionalNonWeightedTokenSettingsCodec.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a412d1a3f2747812e59e35a31c10503c7"></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.Codec.OneDimensionalNonWeightedTokenSettingsCodec.SetWeight </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a>&#160;</td>
<td class="paramname"><em>token</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>weight</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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>Have this method do nothing in order to 'disable' weights. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">token</td><td></td></tr>
<tr><td class="paramname">weight</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_shingle_1_1_codec_1_1_token_settings_codec.html#ae61972a825e52edb1d603a0d5f3c5a85">Lucene.Net.Analysis.Shingle.Codec.TokenSettingsCodec</a>.</p>
<p>Definition at line <a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html#l00042">42</a> of file <a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html">OneDimensionalNonWeightedTokenSettingsCodec.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Analyzers/Shingle/Codec/<a class="el" href="_one_dimensional_non_weighted_token_settings_codec_8cs_source.html">OneDimensionalNonWeightedTokenSettingsCodec.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>