blob: f94caca16b0ac4fd4a5346ceb3c381afe8a79ded [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.Tokenattributes.TermAttribute 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_tokenattributes.html">Tokenattributes</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html">TermAttribute</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_analysis_1_1_tokenattributes_1_1_term_attribute-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Analysis.Tokenattributes.TermAttribute Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The term text of 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>.
<a href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#details">More...</a></p>
<p>Inherits Attribute, <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute.html">Lucene.Net.Analysis.Tokenattributes.ITermAttribute</a>, and ICloneable.</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:a587e91d6aae0ce7cdc629719cf62db88"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a587e91d6aae0ce7cdc629719cf62db88">SetTermBuffer</a> (char[] buffer, int offset, int length)</td></tr>
<tr class="memdesc:a587e91d6aae0ce7cdc629719cf62db88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies the contents of buffer, starting at offset for length characters, into the termBuffer array. <a href="#a587e91d6aae0ce7cdc629719cf62db88"></a><br/></td></tr>
<tr class="separator:a587e91d6aae0ce7cdc629719cf62db88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fa78c39dc25d76e5e3e4fab741be071"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a2fa78c39dc25d76e5e3e4fab741be071">SetTermBuffer</a> (System.String buffer)</td></tr>
<tr class="memdesc:a2fa78c39dc25d76e5e3e4fab741be071"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies the contents of buffer into the termBuffer array. <a href="#a2fa78c39dc25d76e5e3e4fab741be071"></a><br/></td></tr>
<tr class="separator:a2fa78c39dc25d76e5e3e4fab741be071"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3adacd808026a1791e085e35917e5ca3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a3adacd808026a1791e085e35917e5ca3">SetTermBuffer</a> (System.String buffer, int offset, int length)</td></tr>
<tr class="memdesc:a3adacd808026a1791e085e35917e5ca3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies the contents of buffer, starting at offset and continuing for length characters, into the termBuffer array. <a href="#a3adacd808026a1791e085e35917e5ca3"></a><br/></td></tr>
<tr class="separator:a3adacd808026a1791e085e35917e5ca3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fe15700b924cd1e4ac89b11bd1a8bfb"><td class="memItemLeft" align="right" valign="top">virtual char[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a4fe15700b924cd1e4ac89b11bd1a8bfb">TermBuffer</a> ()</td></tr>
<tr class="memdesc:a4fe15700b924cd1e4ac89b11bd1a8bfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the internal termBuffer character array which you can then directly alter. If the array is too small for your token, use <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a33a9959e17a60ee8dd58f91fd2e1514e" title="Grows the termBuffer to at least size newSize, preserving the existing content. Note: If the next ope...">ResizeTermBuffer(int)</a> to increase it. After altering the buffer be sure to call <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#aeb365f5805f9aedfef6369e4303f1dcf" title="Set number of valid characters (length of the term) in the termBuffer array. Use this to truncate the...">SetTermLength</a> to record the number of valid characters that were placed into the termBuffer. <a href="#a4fe15700b924cd1e4ac89b11bd1a8bfb"></a><br/></td></tr>
<tr class="separator:a4fe15700b924cd1e4ac89b11bd1a8bfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33a9959e17a60ee8dd58f91fd2e1514e"><td class="memItemLeft" align="right" valign="top">virtual char[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a33a9959e17a60ee8dd58f91fd2e1514e">ResizeTermBuffer</a> (int newSize)</td></tr>
<tr class="memdesc:a33a9959e17a60ee8dd58f91fd2e1514e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Grows the termBuffer to at least size newSize, preserving the existing content. Note: If the next operation is to change the contents of the term buffer use <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a587e91d6aae0ce7cdc629719cf62db88" title="Copies the contents of buffer, starting at offset for length characters, into the termBuffer array...">SetTermBuffer(char[], int, int)</a>, SetTermBuffer(String), or SetTermBuffer(String, int, int) to optimally combine the resize with the setting of the termBuffer. <a href="#a33a9959e17a60ee8dd58f91fd2e1514e"></a><br/></td></tr>
<tr class="separator:a33a9959e17a60ee8dd58f91fd2e1514e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c0e1059d199654a6f44e83bea05979a"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a2c0e1059d199654a6f44e83bea05979a">TermLength</a> ()</td></tr>
<tr class="memdesc:a2c0e1059d199654a6f44e83bea05979a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return number of valid characters (length of the term) in the termBuffer array. <a href="#a2c0e1059d199654a6f44e83bea05979a"></a><br/></td></tr>
<tr class="separator:a2c0e1059d199654a6f44e83bea05979a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb365f5805f9aedfef6369e4303f1dcf"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#aeb365f5805f9aedfef6369e4303f1dcf">SetTermLength</a> (int length)</td></tr>
<tr class="memdesc:aeb365f5805f9aedfef6369e4303f1dcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set number of valid characters (length of the term) in the termBuffer array. Use this to truncate the termBuffer or to synchronize with external manipulation of the termBuffer. Note: to grow the size of the array, use <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a33a9959e17a60ee8dd58f91fd2e1514e" title="Grows the termBuffer to at least size newSize, preserving the existing content. Note: If the next ope...">ResizeTermBuffer(int)</a> first. <a href="#aeb365f5805f9aedfef6369e4303f1dcf"></a><br/></td></tr>
<tr class="separator:aeb365f5805f9aedfef6369e4303f1dcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeea8dafcff23dcdfa939d170c563e183"><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_analysis_1_1_tokenattributes_1_1_term_attribute.html#aeea8dafcff23dcdfa939d170c563e183">GetHashCode</a> ()</td></tr>
<tr class="separator:aeea8dafcff23dcdfa939d170c563e183"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a216006f84b3371657575f05666d4209b"><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_tokenattributes_1_1_term_attribute.html#a216006f84b3371657575f05666d4209b">Clear</a> ()</td></tr>
<tr class="separator:a216006f84b3371657575f05666d4209b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b717d535de1b2891d33bd290008e217"><td class="memItemLeft" align="right" valign="top">override System.Object&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a7b717d535de1b2891d33bd290008e217">Clone</a> ()</td></tr>
<tr class="separator:a7b717d535de1b2891d33bd290008e217"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1654d06f08e62912df0bbbabd90e639"><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_analysis_1_1_tokenattributes_1_1_term_attribute.html#ad1654d06f08e62912df0bbbabd90e639">Equals</a> (System.Object other)</td></tr>
<tr class="separator:ad1654d06f08e62912df0bbbabd90e639"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9541fb9e0c20d64da327bddc438e0045"><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_analysis_1_1_tokenattributes_1_1_term_attribute.html#a9541fb9e0c20d64da327bddc438e0045">ToString</a> ()</td></tr>
<tr class="separator:a9541fb9e0c20d64da327bddc438e0045"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb89be041bae6a82538a1786267cf249"><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_tokenattributes_1_1_term_attribute.html#acb89be041bae6a82538a1786267cf249">CopyTo</a> (<a class="el" href="_single_token_token_stream_8cs.html#a0c6c543e9e03ec9a8e489ea9e99694bf">Attribute</a> target)</td></tr>
<tr class="separator:acb89be041bae6a82538a1786267cf249"><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:a71691a2acfd8af5f25adb4782e9eaddb"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a71691a2acfd8af5f25adb4782e9eaddb">Term</a><code> [get]</code></td></tr>
<tr class="memdesc:a71691a2acfd8af5f25adb4782e9eaddb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <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>'s term text. <a href="#a71691a2acfd8af5f25adb4782e9eaddb"></a><br/></td></tr>
<tr class="separator:a71691a2acfd8af5f25adb4782e9eaddb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute.html">Lucene.Net.Analysis.Tokenattributes.ITermAttribute</a></td></tr>
<tr class="memitem:acdcd805612ee71187baaf3ab48d73536 inherit properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute.html#acdcd805612ee71187baaf3ab48d73536">Term</a><code> [get]</code></td></tr>
<tr class="memdesc:acdcd805612ee71187baaf3ab48d73536 inherit properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <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>'s term text. <a href="#acdcd805612ee71187baaf3ab48d73536"></a><br/></td></tr>
<tr class="separator:acdcd805612ee71187baaf3ab48d73536 inherit properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute"><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>The term text of 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>.</p>
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00028">28</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a216006f84b3371657575f05666d4209b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Analysis.Tokenattributes.TermAttribute.Clear </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_attribute_8cs_source.html#l00210">210</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a7b717d535de1b2891d33bd290008e217"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.Object Lucene.Net.Analysis.Tokenattributes.TermAttribute.Clone </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_attribute_8cs_source.html#l00215">215</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="acb89be041bae6a82538a1786267cf249"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Analysis.Tokenattributes.TermAttribute.CopyTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_single_token_token_stream_8cs.html#a0c6c543e9e03ec9a8e489ea9e99694bf">Attribute</a>&#160;</td>
<td class="paramname"><em>target</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00261">261</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ad1654d06f08e62912df0bbbabd90e639"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Analysis.Tokenattributes.TermAttribute.Equals </td>
<td>(</td>
<td class="paramtype">System.Object&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00227">227</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aeea8dafcff23dcdfa939d170c563e183"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Analysis.Tokenattributes.TermAttribute.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_attribute_8cs_source.html#l00202">202</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a33a9959e17a60ee8dd58f91fd2e1514e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual char [] Lucene.Net.Analysis.Tokenattributes.TermAttribute.ResizeTermBuffer </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>newSize</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>Grows the termBuffer to at least size newSize, preserving the existing content. Note: If the next operation is to change the contents of the term buffer use <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a587e91d6aae0ce7cdc629719cf62db88" title="Copies the contents of buffer, starting at offset for length characters, into the termBuffer array...">SetTermBuffer(char[], int, int)</a>, SetTermBuffer(String), or SetTermBuffer(String, int, int) to optimally combine the resize with the setting of the termBuffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newSize</td><td>minimum size of the new termBuffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>newly created termBuffer with length &gt;= newSize </dd></dl>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute.html#a9f594808c7e8de9313e98d49d8a43682">Lucene.Net.Analysis.Tokenattributes.ITermAttribute</a>.</p>
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00124">124</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a587e91d6aae0ce7cdc629719cf62db88"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Lucene.Net.Analysis.Tokenattributes.TermAttribute.SetTermBuffer </td>
<td>(</td>
<td class="paramtype">char[]&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>length</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>Copies the contents of buffer, starting at offset for length characters, into the termBuffer array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>the buffer to copy </td></tr>
<tr><td class="paramname">offset</td><td>the index in the buffer of the first character to copy </td></tr>
<tr><td class="paramname">length</td><td>the number of characters to copy </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute.html#a7d592ba9508e9455f993b9e3b0f0cb18">Lucene.Net.Analysis.Tokenattributes.ITermAttribute</a>.</p>
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00062">62</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2fa78c39dc25d76e5e3e4fab741be071"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Lucene.Net.Analysis.Tokenattributes.TermAttribute.SetTermBuffer </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>buffer</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>Copies the contents of buffer into the termBuffer array.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>the buffer to copy </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute.html#a0995c3766f9a82e06351d42c21de8ce3">Lucene.Net.Analysis.Tokenattributes.ITermAttribute</a>.</p>
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00072">72</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a3adacd808026a1791e085e35917e5ca3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Lucene.Net.Analysis.Tokenattributes.TermAttribute.SetTermBuffer </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>length</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>Copies the contents of buffer, starting at offset and continuing for length characters, into the termBuffer array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>the buffer to copy </td></tr>
<tr><td class="paramname">offset</td><td>the index in the buffer of the first character to copy </td></tr>
<tr><td class="paramname">length</td><td>the number of characters to copy </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute.html#a38adefe6f0c4b9bba4cb4d0b7e7093f1">Lucene.Net.Analysis.Tokenattributes.ITermAttribute</a>.</p>
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00089">89</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aeb365f5805f9aedfef6369e4303f1dcf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Lucene.Net.Analysis.Tokenattributes.TermAttribute.SetTermLength </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>length</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>Set number of valid characters (length of the term) in the termBuffer array. Use this to truncate the termBuffer or to synchronize with external manipulation of the termBuffer. Note: to grow the size of the array, use <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a33a9959e17a60ee8dd58f91fd2e1514e" title="Grows the termBuffer to at least size newSize, preserving the existing content. Note: If the next ope...">ResizeTermBuffer(int)</a> first. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">length</td><td>the truncated length </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute.html#ae4951ce808c42afee61f3f0e78a2c59a">Lucene.Net.Analysis.Tokenattributes.ITermAttribute</a>.</p>
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00194">194</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a4fe15700b924cd1e4ac89b11bd1a8bfb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual char [] Lucene.Net.Analysis.Tokenattributes.TermAttribute.TermBuffer </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>Returns the internal termBuffer character array which you can then directly alter. If the array is too small for your token, use <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a33a9959e17a60ee8dd58f91fd2e1514e" title="Grows the termBuffer to at least size newSize, preserving the existing content. Note: If the next ope...">ResizeTermBuffer(int)</a> to increase it. After altering the buffer be sure to call <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#aeb365f5805f9aedfef6369e4303f1dcf" title="Set number of valid characters (length of the term) in the termBuffer array. Use this to truncate the...">SetTermLength</a> to record the number of valid characters that were placed into the termBuffer. </p>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute.html#a1ed6aedff1a97a528106c529bbe0532d">Lucene.Net.Analysis.Tokenattributes.ITermAttribute</a>.</p>
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00106">106</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2c0e1059d199654a6f44e83bea05979a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int Lucene.Net.Analysis.Tokenattributes.TermAttribute.TermLength </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>Return number of valid characters (length of the term) in the termBuffer array. </p>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_term_attribute.html#ac3e3e78df53c33bb23c7ad9636ec0c66">Lucene.Net.Analysis.Tokenattributes.ITermAttribute</a>.</p>
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00181">181</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a9541fb9e0c20d64da327bddc438e0045"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.String Lucene.Net.Analysis.Tokenattributes.TermAttribute.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_attribute_8cs_source.html#l00255">255</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a71691a2acfd8af5f25adb4782e9eaddb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual string Lucene.Net.Analysis.Tokenattributes.TermAttribute.Term</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 <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>'s term text. </p>
<p>This method has a performance penalty because the text is stored internally in a char[]. If possible, use <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a4fe15700b924cd1e4ac89b11bd1a8bfb" title="Returns the internal termBuffer character array which you can then directly alter. If the array is too small for your token, use ResizeTermBuffer(int) to increase it. After altering the buffer be sure to call SetTermLength to record the number of valid characters that were placed into the termBuffer. ">TermBuffer()</a> and <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_term_attribute.html#a2c0e1059d199654a6f44e83bea05979a" title="Return number of valid characters (length of the term) in the termBuffer array. ">TermLength()</a> directly instead. If you really need a String, use this method, which is nothing more than a convenience call to <b>new String(token.termBuffer(), 0, token.termLength())</b> </p>
<p>Definition at line <a class="el" href="_term_attribute_8cs_source.html#l00045">45</a> of file <a class="el" href="_term_attribute_8cs_source.html">TermAttribute.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Analysis/Tokenattributes/<a class="el" href="_term_attribute_8cs_source.html">TermAttribute.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>