Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html
blob: b28433597d40d2a01fd45e2da32e7c7952973431 [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.Search.Highlight.WeightedSpanTerm 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_search.html">Search</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search_1_1_highlight.html">Highlight</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</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_search_1_1_highlight_1_1_weighted_span_term-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Highlight.WeightedSpanTerm Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Lightweight class to hold term, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a>, and positions used for scoring this term.
<a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term.html">Lucene.Net.Search.Highlight.WeightedTerm</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:ac11adf7b6d5c68d46c7a46743a97cc50"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html#ac11adf7b6d5c68d46c7a46743a97cc50">WeightedSpanTerm</a> (float weight, String term)</td></tr>
<tr class="separator:ac11adf7b6d5c68d46c7a46743a97cc50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a957cc7822e9cea1f175a722a65e1c602"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html#a957cc7822e9cea1f175a722a65e1c602">WeightedSpanTerm</a> (float weight, String term, bool positionSensitive)</td></tr>
<tr class="separator:a957cc7822e9cea1f175a722a65e1c602"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d20abf4cb992be1fd27115060f2c63c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html#a7d20abf4cb992be1fd27115060f2c63c">CheckPosition</a> (int position)</td></tr>
<tr class="memdesc:a7d20abf4cb992be1fd27115060f2c63c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks to see if this term is valid at <code>position</code>. <a href="#a7d20abf4cb992be1fd27115060f2c63c"></a><br/></td></tr>
<tr class="separator:a7d20abf4cb992be1fd27115060f2c63c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c432d02e1d099b7884d907e1e06ffc1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html#a5c432d02e1d099b7884d907e1e06ffc1">AddPositionSpans</a> (List&lt; <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_position_span.html">PositionSpan</a> &gt; positionSpans)</td></tr>
<tr class="separator:a5c432d02e1d099b7884d907e1e06ffc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc3c5b61b73e9e18522ada11e5dda783"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html#abc3c5b61b73e9e18522ada11e5dda783">IsPositionSensitive</a> ()</td></tr>
<tr class="separator:abc3c5b61b73e9e18522ada11e5dda783"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4e06f42a367ada800b32751eab20be1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html#ab4e06f42a367ada800b32751eab20be1">SetPositionSensitive</a> (bool positionSensitive)</td></tr>
<tr class="separator:ab4e06f42a367ada800b32751eab20be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2becde3ff812b9542c4a32419ddf1bbb"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_position_span.html">PositionSpan</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html#a2becde3ff812b9542c4a32419ddf1bbb">GetPositionSpans</a> ()</td></tr>
<tr class="separator:a2becde3ff812b9542c4a32419ddf1bbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term.html">Lucene.Net.Search.Highlight.WeightedTerm</a></td></tr>
<tr class="memitem:ad57316fb28b9ed68fb314b4272411db3 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term.html#ad57316fb28b9ed68fb314b4272411db3">WeightedTerm</a> (float weight, String term)</td></tr>
<tr class="separator:ad57316fb28b9ed68fb314b4272411db3 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header properties_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term.html">Lucene.Net.Search.Highlight.WeightedTerm</a></td></tr>
<tr class="memitem:aca239a461b884e0a917f100d2e9fc011 inherit properties_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term.html#aca239a461b884e0a917f100d2e9fc011">Term</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aca239a461b884e0a917f100d2e9fc011 inherit properties_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term"><td class="mdescLeft">&#160;</td><td class="mdescRight">the term value (stemmed) <a href="#aca239a461b884e0a917f100d2e9fc011"></a><br/></td></tr>
<tr class="separator:aca239a461b884e0a917f100d2e9fc011 inherit properties_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef3a222c89817d52c24034ab09dcc394 inherit properties_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term.html#aef3a222c89817d52c24034ab09dcc394">Weight</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aef3a222c89817d52c24034ab09dcc394 inherit properties_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term"><td class="mdescLeft">&#160;</td><td class="mdescRight">the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a> associated with this term <a href="#aef3a222c89817d52c24034ab09dcc394"></a><br/></td></tr>
<tr class="separator:aef3a222c89817d52c24034ab09dcc394 inherit properties_class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term"><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>Lightweight class to hold term, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a>, and positions used for scoring this term. </p>
<p>Definition at line <a class="el" href="_weighted_span_term_8cs_source.html#l00028">28</a> of file <a class="el" href="_weighted_span_term_8cs_source.html">WeightedSpanTerm.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac11adf7b6d5c68d46c7a46743a97cc50"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.WeightedSpanTerm.WeightedSpanTerm </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>weight</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>term</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_weighted_span_term_8cs_source.html#l00033">33</a> of file <a class="el" href="_weighted_span_term_8cs_source.html">WeightedSpanTerm.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a957cc7822e9cea1f175a722a65e1c602"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.WeightedSpanTerm.WeightedSpanTerm </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>weight</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>term</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>positionSensitive</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_weighted_span_term_8cs_source.html#l00040">40</a> of file <a class="el" href="_weighted_span_term_8cs_source.html">WeightedSpanTerm.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5c432d02e1d099b7884d907e1e06ffc1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.Highlight.WeightedSpanTerm.AddPositionSpans </td>
<td>(</td>
<td class="paramtype">List&lt; <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_position_span.html">PositionSpan</a> &gt;&#160;</td>
<td class="paramname"><em>positionSpans</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_weighted_span_term_8cs_source.html#l00070">70</a> of file <a class="el" href="_weighted_span_term_8cs_source.html">WeightedSpanTerm.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a7d20abf4cb992be1fd27115060f2c63c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Lucene.Net.Search.Highlight.WeightedSpanTerm.CheckPosition </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>position</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks to see if this term is valid at <code>position</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">position</td><td>to check against valid term postions</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff this term is a hit at this position</dd></dl>
<p>Definition at line <a class="el" href="_weighted_span_term_8cs_source.html#l00052">52</a> of file <a class="el" href="_weighted_span_term_8cs_source.html">WeightedSpanTerm.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2becde3ff812b9542c4a32419ddf1bbb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">List&lt;<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_position_span.html">PositionSpan</a>&gt; Lucene.Net.Search.Highlight.WeightedSpanTerm.GetPositionSpans </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_weighted_span_term_8cs_source.html#l00085">85</a> of file <a class="el" href="_weighted_span_term_8cs_source.html">WeightedSpanTerm.cs</a>.</p>
</div>
</div>
<a class="anchor" id="abc3c5b61b73e9e18522ada11e5dda783"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Lucene.Net.Search.Highlight.WeightedSpanTerm.IsPositionSensitive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_weighted_span_term_8cs_source.html#l00075">75</a> of file <a class="el" href="_weighted_span_term_8cs_source.html">WeightedSpanTerm.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab4e06f42a367ada800b32751eab20be1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.Highlight.WeightedSpanTerm.SetPositionSensitive </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>positionSensitive</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_weighted_span_term_8cs_source.html#l00080">80</a> of file <a class="el" href="_weighted_span_term_8cs_source.html">WeightedSpanTerm.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Highlighter/<a class="el" href="_weighted_span_term_8cs_source.html">WeightedSpanTerm.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:58 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>