blob: 2b4b8ad7f9fe12bcb728fdd1a5d5f436d20829a2 [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.IOffsetAttribute Interface 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="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_offset_attribute.html">IOffsetAttribute</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="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_offset_attribute-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Analysis.Tokenattributes.IOffsetAttribute Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The start and end character offset 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="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_offset_attribute.html#details">More...</a></p>
<p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_util_1_1_i_attribute.html">Lucene.Net.Util.IAttribute</a>.</p>
<p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Lucene.Net.Analysis.Token</a>, and <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_offset_attribute.html">Lucene.Net.Analysis.Tokenattributes.OffsetAttribute</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:a34b717584a38139445eb689bf86cabb7"><td class="memItemLeft" align="right" valign="top">void&#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_offset_attribute.html#a34b717584a38139445eb689bf86cabb7">SetOffset</a> (int startOffset, int endOffset)</td></tr>
<tr class="memdesc:a34b717584a38139445eb689bf86cabb7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the starting and ending offset. See <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_offset_attribute.html#a2762094728bc2fd1d79680186e7db942" title="Returns this Token&#39;s starting offset, the position of the first character corresponding to this token...">StartOffset()</a> and <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_offset_attribute.html#a7e79d01df63e690957780c19ee5ac863" title="Returns this Token&#39;s ending offset, one greater than the position of the last character corresponding...">EndOffset()</a> <a href="#a34b717584a38139445eb689bf86cabb7"></a><br/></td></tr>
<tr class="separator:a34b717584a38139445eb689bf86cabb7"><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:a2762094728bc2fd1d79680186e7db942"><td class="memItemLeft" align="right" valign="top">int&#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_offset_attribute.html#a2762094728bc2fd1d79680186e7db942">StartOffset</a><code> [get]</code></td></tr>
<tr class="memdesc:a2762094728bc2fd1d79680186e7db942"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns this <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 starting offset, the position of the first character corresponding to this token in the source text. Note that the difference between endOffset() and startOffset() may not be equal to termText.length(), as the term text may have been altered by a stemmer or some other filter. <a href="#a2762094728bc2fd1d79680186e7db942"></a><br/></td></tr>
<tr class="separator:a2762094728bc2fd1d79680186e7db942"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7e79d01df63e690957780c19ee5ac863"><td class="memItemLeft" align="right" valign="top">int&#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_offset_attribute.html#a7e79d01df63e690957780c19ee5ac863">EndOffset</a><code> [get]</code></td></tr>
<tr class="memdesc:a7e79d01df63e690957780c19ee5ac863"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns this <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 ending offset, one greater than the position of the last character corresponding to this token in the source text. The length of the token in the source text is (endOffset - startOffset). <a href="#a7e79d01df63e690957780c19ee5ac863"></a><br/></td></tr>
<tr class="separator:a7e79d01df63e690957780c19ee5ac863"><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 start and end character offset 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="_i_offset_attribute_8cs_source.html#l00025">25</a> of file <a class="el" href="_i_offset_attribute_8cs_source.html">IOffsetAttribute.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a34b717584a38139445eb689bf86cabb7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Analysis.Tokenattributes.IOffsetAttribute.SetOffset </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>startOffset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>endOffset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the starting and ending offset. See <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_offset_attribute.html#a2762094728bc2fd1d79680186e7db942" title="Returns this Token&#39;s starting offset, the position of the first character corresponding to this token...">StartOffset()</a> and <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_offset_attribute.html#a7e79d01df63e690957780c19ee5ac863" title="Returns this Token&#39;s ending offset, one greater than the position of the last character corresponding...">EndOffset()</a> </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html#a08be487236606c501726d84749755f64">Lucene.Net.Analysis.Token</a>, and <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_offset_attribute.html#ae704fa655dfcadc86e3a7b6b11284033">Lucene.Net.Analysis.Tokenattributes.OffsetAttribute</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a7e79d01df63e690957780c19ee5ac863"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Analysis.Tokenattributes.IOffsetAttribute.EndOffset</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 this <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 ending offset, one greater than the position of the last character corresponding to this token in the source text. The length of the token in the source text is (endOffset - startOffset). </p>
<p>Definition at line <a class="el" href="_i_offset_attribute_8cs_source.html#l00046">46</a> of file <a class="el" href="_i_offset_attribute_8cs_source.html">IOffsetAttribute.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2762094728bc2fd1d79680186e7db942"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Analysis.Tokenattributes.IOffsetAttribute.StartOffset</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 this <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 starting offset, the position of the first character corresponding to this token in the source text. Note that the difference between endOffset() and startOffset() may not be equal to termText.length(), as the term text may have been altered by a stemmer or some other filter. </p>
<p>Definition at line <a class="el" href="_i_offset_attribute_8cs_source.html#l00033">33</a> of file <a class="el" href="_i_offset_attribute_8cs_source.html">IOffsetAttribute.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>core/Analysis/Tokenattributes/<a class="el" href="_i_offset_attribute_8cs_source.html">IOffsetAttribute.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>