Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack.html
blob: 32e7ce37458bd73dd4ee4451615ca6cd74367f5b [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.Vectorhighlight.FieldTermStack 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_vectorhighlight.html">Vectorhighlight</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack.html">FieldTermStack</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Vectorhighlight.FieldTermStack Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack.html" title="FieldTermStack is a stack that keeps query terms in the specified field of the document to be highlig...">FieldTermStack</a></code> is a stack that keeps query terms in the specified field of the document to be highlighted.
<a href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a28123023e97871f15896bd98d9dfdf5d"><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_vectorhighlight_1_1_field_term_stack.html#a28123023e97871f15896bd98d9dfdf5d">FieldTermStack</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, String fieldName, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> fieldQuery)</td></tr>
<tr class="memdesc:a28123023e97871f15896bd98d9dfdf5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">a constructor. <a href="#a28123023e97871f15896bd98d9dfdf5d"></a><br/></td></tr>
<tr class="separator:a28123023e97871f15896bd98d9dfdf5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abef30958d058375a27a4379ace514771"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack.html#abef30958d058375a27a4379ace514771">Pop</a> ()</td></tr>
<tr class="memdesc:abef30958d058375a27a4379ace514771"><td class="mdescLeft">&#160;</td><td class="mdescRight"> <a href="#abef30958d058375a27a4379ace514771"></a><br/></td></tr>
<tr class="separator:abef30958d058375a27a4379ace514771"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21f0292c4b05c1709cac7a050d970221"><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_vectorhighlight_1_1_field_term_stack.html#a21f0292c4b05c1709cac7a050d970221">Push</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a> termInfo)</td></tr>
<tr class="memdesc:a21f0292c4b05c1709cac7a050d970221"><td class="mdescLeft">&#160;</td><td class="mdescRight"> <a href="#a21f0292c4b05c1709cac7a050d970221"></a><br/></td></tr>
<tr class="separator:a21f0292c4b05c1709cac7a050d970221"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7da60a7282471b3e5cc546904a539e0"><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_vectorhighlight_1_1_field_term_stack.html#ac7da60a7282471b3e5cc546904a539e0">IsEmpty</a> ()</td></tr>
<tr class="memdesc:ac7da60a7282471b3e5cc546904a539e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">to know whether the stack is empty <a href="#ac7da60a7282471b3e5cc546904a539e0"></a><br/></td></tr>
<tr class="separator:ac7da60a7282471b3e5cc546904a539e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a593a37285583687b8f73f6e96a956a62"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack.html#a593a37285583687b8f73f6e96a956a62">Main</a> (String[] args)</td></tr>
<tr class="separator:a593a37285583687b8f73f6e96a956a62"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aafbb5cb3998ab0e591903144429b1172"><td class="memItemLeft" align="right" valign="top">LinkedList&lt; <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack.html#aafbb5cb3998ab0e591903144429b1172">termList</a> = new LinkedList&lt;<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a>&gt;()</td></tr>
<tr class="separator:aafbb5cb3998ab0e591903144429b1172"><td class="memSeparator" colspan="2">&#160;</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:aaeb17f78f5dd869fefb9a332271c43ab"><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_vectorhighlight_1_1_field_term_stack.html#aaeb17f78f5dd869fefb9a332271c43ab">FieldName</a><code> [get]</code></td></tr>
<tr class="memdesc:aaeb17f78f5dd869fefb9a332271c43ab"><td class="mdescLeft">&#160;</td><td class="mdescRight"> <a href="#aaeb17f78f5dd869fefb9a332271c43ab"></a><br/></td></tr>
<tr class="separator:aaeb17f78f5dd869fefb9a332271c43ab"><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><code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack.html" title="FieldTermStack is a stack that keeps query terms in the specified field of the document to be highlig...">FieldTermStack</a></code> is a stack that keeps query terms in the specified field of the document to be highlighted. </p>
<p>Definition at line <a class="el" href="_field_term_stack_8cs_source.html#l00037">37</a> of file <a class="el" href="_field_term_stack_8cs_source.html">FieldTermStack.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a28123023e97871f15896bd98d9dfdf5d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Vectorhighlight.FieldTermStack.FieldTermStack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>docId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>fieldName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a>&#160;</td>
<td class="paramname"><em>fieldQuery</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>a constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>IndexReader of the index</td></tr>
<tr><td class="paramname">docId</td><td>document id to be highlighted</td></tr>
<tr><td class="paramname">fieldName</td><td>field of the document to be highlighted</td></tr>
<tr><td class="paramname">fieldQuery</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> object</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_field_term_stack_8cs_source.html#l00102">102</a> of file <a class="el" href="_field_term_stack_8cs_source.html">FieldTermStack.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac7da60a7282471b3e5cc546904a539e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Lucene.Net.Search.Vectorhighlight.FieldTermStack.IsEmpty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>to know whether the stack is empty </p>
<dl class="section return"><dt>Returns</dt><dd>true if the stack is empty, false if not</dd></dl>
<p>Definition at line <a class="el" href="_field_term_stack_8cs_source.html#l00191">191</a> of file <a class="el" href="_field_term_stack_8cs_source.html">FieldTermStack.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a593a37285583687b8f73f6e96a956a62"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void Lucene.Net.Search.Vectorhighlight.FieldTermStack.Main </td>
<td>(</td>
<td class="paramtype">String[]&#160;</td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></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="_field_term_stack_8cs_source.html#l00042">42</a> of file <a class="el" href="_field_term_stack_8cs_source.html">FieldTermStack.cs</a>.</p>
</div>
</div>
<a class="anchor" id="abef30958d058375a27a4379ace514771"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a> Lucene.Net.Search.Vectorhighlight.FieldTermStack.Pop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p></p>
<dl class="section return"><dt>Returns</dt><dd>the top <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a> object of the stack</dd></dl>
<p>Definition at line <a class="el" href="_field_term_stack_8cs_source.html#l00168">168</a> of file <a class="el" href="_field_term_stack_8cs_source.html">FieldTermStack.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a21f0292c4b05c1709cac7a050d970221"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.Vectorhighlight.FieldTermStack.Push </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a>&#160;</td>
<td class="paramname"><em>termInfo</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">termInfo</td><td>the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a> object to be put on the top of the stack</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_field_term_stack_8cs_source.html#l00181">181</a> of file <a class="el" href="_field_term_stack_8cs_source.html">FieldTermStack.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aafbb5cb3998ab0e591903144429b1172"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LinkedList&lt;<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a>&gt; Lucene.Net.Search.Vectorhighlight.FieldTermStack.termList = new LinkedList&lt;<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_term_stack_1_1_term_info.html">TermInfo</a>&gt;()</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_field_term_stack_8cs_source.html#l00040">40</a> of file <a class="el" href="_field_term_stack_8cs_source.html">FieldTermStack.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="aaeb17f78f5dd869fefb9a332271c43ab"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Lucene.Net.Search.Vectorhighlight.FieldTermStack.FieldName</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p></p>
<p>field name </p>
<p>Definition at line <a class="el" href="_field_term_stack_8cs_source.html#l00160">160</a> of file <a class="el" href="_field_term_stack_8cs_source.html">FieldTermStack.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/FastVectorHighlighter/<a class="el" href="_field_term_stack_8cs_source.html">FieldTermStack.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>