blob: 1007af8c93e9e37ae4339cc3587b15ff99e60adf [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.Index.Term 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_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_index_1_1_term-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.Term Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> represents a word from text. This is the unit of search. It is composed of two elements, the text of the word, as a string, and the name of the field that the text occured in, an interned string. Note that terms may represent more than words from text fields, but also things like dates, email addresses, urls, etc.
<a href="class_lucene_1_1_net_1_1_index_1_1_term.html#details">More...</a></p>
<p>Inherits IComparable&lt; Term &gt;.</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:a8d6601bb9e6c004148076104f33d237a"><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_index_1_1_term.html#a8d6601bb9e6c004148076104f33d237a">Term</a> (System.String fld, System.String txt)</td></tr>
<tr class="memdesc:a8d6601bb9e6c004148076104f33d237a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> with the given field and text. Note that a null field or null text value results in undefined behavior for most <a class="el" href="namespace_lucene.html">Lucene</a> APIs that accept a <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> parameter. <a href="#a8d6601bb9e6c004148076104f33d237a"></a><br/></td></tr>
<tr class="separator:a8d6601bb9e6c004148076104f33d237a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbd9efd853218563d716bec38c2bf0c2"><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_index_1_1_term.html#abbd9efd853218563d716bec38c2bf0c2">Term</a> (System.String fld)</td></tr>
<tr class="memdesc:abbd9efd853218563d716bec38c2bf0c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> with the given field and empty text. This serves two purposes: 1) reuse of a <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> with the same field. 2) pattern for a query. <a href="#abbd9efd853218563d716bec38c2bf0c2"></a><br/></td></tr>
<tr class="separator:abbd9efd853218563d716bec38c2bf0c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab579168593e435880d6e946870c8a07d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html#ab579168593e435880d6e946870c8a07d">CreateTerm</a> (System.String text)</td></tr>
<tr class="memdesc:ab579168593e435880d6e946870c8a07d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optimized construction of new Terms by reusing same field as this <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> <a href="#ab579168593e435880d6e946870c8a07d"></a><br/></td></tr>
<tr class="separator:ab579168593e435880d6e946870c8a07d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a576e0c713a41a45f056d1b98bf0ae3e7"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html#a576e0c713a41a45f056d1b98bf0ae3e7">Equals</a> (System.Object obj)</td></tr>
<tr class="separator:a576e0c713a41a45f056d1b98bf0ae3e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e009618832cdc18f4e3018837fbaa6f"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html#a7e009618832cdc18f4e3018837fbaa6f">GetHashCode</a> ()</td></tr>
<tr class="separator:a7e009618832cdc18f4e3018837fbaa6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb594fa95c66472eb42d1bf985fda42f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html#aeb594fa95c66472eb42d1bf985fda42f">CompareTo</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a> other)</td></tr>
<tr class="memdesc:aeb594fa95c66472eb42d1bf985fda42f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two terms, returning a negative integer if this term belongs before the argument, zero if this term is equal to the argument, and a positive integer if this term belongs after the argument. The ordering of terms is first by field, then by text. <a href="#aeb594fa95c66472eb42d1bf985fda42f"></a><br/></td></tr>
<tr class="separator:aeb594fa95c66472eb42d1bf985fda42f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a197861521215fdf24606c214c0c29fdd"><td class="memItemLeft" align="right" valign="top">override System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html#a197861521215fdf24606c214c0c29fdd">ToString</a> ()</td></tr>
<tr class="separator:a197861521215fdf24606c214c0c29fdd"><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:a2ecfa7c0860798920d089654f34aa222"><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_index_1_1_term.html#a2ecfa7c0860798920d089654f34aa222">Field</a><code> [get]</code></td></tr>
<tr class="memdesc:a2ecfa7c0860798920d089654f34aa222"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the field of this term, an interned string. The field indicates the part of a document which this term came from. <a href="#a2ecfa7c0860798920d089654f34aa222"></a><br/></td></tr>
<tr class="separator:a2ecfa7c0860798920d089654f34aa222"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe11c449ea7db39725c494b2c2574847"><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_index_1_1_term.html#afe11c449ea7db39725c494b2c2574847">Text</a><code> [get]</code></td></tr>
<tr class="memdesc:afe11c449ea7db39725c494b2c2574847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the text of this term. In the case of words, this is simply the text of the word. In the case of dates and other types, this is an encoding of the object as a string. <a href="#afe11c449ea7db39725c494b2c2574847"></a><br/></td></tr>
<tr class="separator:afe11c449ea7db39725c494b2c2574847"><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>A <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> represents a word from text. This is the unit of search. It is composed of two elements, the text of the word, as a string, and the name of the field that the text occured in, an interned string. Note that terms may represent more than words from text fields, but also things like dates, email addresses, urls, etc. </p>
<p>Definition at line <a class="el" href="_term_8cs_source.html#l00032">32</a> of file <a class="el" href="_term_8cs_source.html">Term.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8d6601bb9e6c004148076104f33d237a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Index.Term.Term </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>fld</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>txt</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> with the given field and text. Note that a null field or null text value results in undefined behavior for most <a class="el" href="namespace_lucene.html">Lucene</a> APIs that accept a <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> parameter. </p>
<p>Definition at line <a class="el" href="_term_8cs_source.html#l00041">41</a> of file <a class="el" href="_term_8cs_source.html">Term.cs</a>.</p>
</div>
</div>
<a class="anchor" id="abbd9efd853218563d716bec38c2bf0c2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Index.Term.Term </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>fld</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> with the given field and empty text. This serves two purposes: 1) reuse of a <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> with the same field. 2) pattern for a query. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fld</td><td></td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_term_8cs_source.html#l00054">54</a> of file <a class="el" href="_term_8cs_source.html">Term.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aeb594fa95c66472eb42d1bf985fda42f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Index.Term.CompareTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a>&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two terms, returning a negative integer if this term belongs before the argument, zero if this term is equal to the argument, and a positive integer if this term belongs after the argument. The ordering of terms is first by field, then by text. </p>
<p>Definition at line <a class="el" href="_term_8cs_source.html#l00135">135</a> of file <a class="el" href="_term_8cs_source.html">Term.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab579168593e435880d6e946870c8a07d"></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_index_1_1_term.html">Term</a> Lucene.Net.Index.Term.CreateTerm </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Optimized construction of new Terms by reusing same field as this <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> </p>
<ul>
<li>avoids field.intern() overhead </li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>The text of the new term (field is implicitly same as this <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> instance) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> </dd></dl>
<p>Definition at line <a class="el" href="_term_8cs_source.html#l00088">88</a> of file <a class="el" href="_term_8cs_source.html">Term.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a576e0c713a41a45f056d1b98bf0ae3e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Index.Term.Equals </td>
<td>(</td>
<td class="paramtype">System.Object&#160;</td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_term_8cs_source.html#l00094">94</a> of file <a class="el" href="_term_8cs_source.html">Term.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a7e009618832cdc18f4e3018837fbaa6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Index.Term.GetHashCode </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="_term_8cs_source.html#l00121">121</a> of file <a class="el" href="_term_8cs_source.html">Term.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a197861521215fdf24606c214c0c29fdd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.String Lucene.Net.Index.Term.ToString </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="_term_8cs_source.html#l00151">151</a> of file <a class="el" href="_term_8cs_source.html">Term.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a2ecfa7c0860798920d089654f34aa222"></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.Index.Term.Field</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>Returns the field of this term, an interned string. The field indicates the part of a document which this term came from. </p>
<p>Definition at line <a class="el" href="_term_8cs_source.html#l00068">68</a> of file <a class="el" href="_term_8cs_source.html">Term.cs</a>.</p>
</div>
</div>
<a class="anchor" id="afe11c449ea7db39725c494b2c2574847"></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.Index.Term.Text</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>Returns the text of this term. In the case of words, this is simply the text of the word. In the case of dates and other types, this is an encoding of the object as a string. </p>
<p>Definition at line <a class="el" href="_term_8cs_source.html#l00077">77</a> of file <a class="el" href="_term_8cs_source.html">Term.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Index/<a class="el" href="_term_8cs_source.html">Term.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:55 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>