Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / core_2_analysis_2_token_8cs.html
blob: da7671e4a7fa51981b647bd980baa178f09aef1c [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: core/Analysis/Token.cs File 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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#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="dir_1efe588324fc547683bba4a3f1bac847.html">core</a></li><li class="navelem"><a class="el" href="dir_6336841c10663a412729e336c4986ba5.html">Analysis</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">Token.cs File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="core_2_analysis_2_token_8cs_source.html">Go to the source code of this file.</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_analysis_1_1_token.html">Lucene.Net.Analysis.Token</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">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> is an occurrence of a term from the text of a field. It consists of a term's text, the start and end offset of the term in the text of the field, and a type string. The start and end offsets permit applications to re-associate a token with its source text, e.g., to display highlighted query terms in a document browser, or to show matching text fragments in a &lt;abbr title="KeyWord In Context"&gt;KWIC&lt;/abbr&gt; display, etc. The type is a string, assigned by a lexical analyzer (a.k.a. tokenizer), naming the lexical or syntactic class that the token belongs to. For example an end of sentence marker token might be implemented with type "eos". The default token type is "word". 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> can optionally have metadata (a.k.a. Payload) in the form of a variable length byte array. Use TermPositions.PayloadLength and TermPositions.GetPayload(byte[], int) to retrieve the payloads from the index. <a href="class_lucene_1_1_net_1_1_analysis_1_1_token.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_analysis_1_1_token_1_1_token_attribute_factory.html">Lucene.Net.Analysis.Token.TokenAttributeFactory</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>Expert</b>: Creates an AttributeFactory returning <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> as instance for the basic attributes and for all other attributes calls the given delegate factory. <a href="class_lucene_1_1_net_1_1_analysis_1_1_token_1_1_token_attribute_factory.html#details">More...</a><br/></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="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespace_lucene_1_1_net_1_1_analysis"><td class="memItemLeft" align="right" valign="top">package &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_lucene_1_1_net_1_1_analysis.html">Lucene.Net.Analysis</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="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aba3faac25c0f0a8ba32b9ec6854f2657"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="core_2_analysis_2_token_8cs.html#aba3faac25c0f0a8ba32b9ec6854f2657">Payload</a> = <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html">Lucene.Net.Index.Payload</a></td></tr>
<tr class="separator:aba3faac25c0f0a8ba32b9ec6854f2657"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17a77b770c87cb0e7153982c4171bfcc"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="core_2_analysis_2_token_8cs.html#a17a77b770c87cb0e7153982c4171bfcc">TermPositions</a> = <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html">Lucene.Net.Index.TermPositions</a></td></tr>
<tr class="separator:a17a77b770c87cb0e7153982c4171bfcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7655d900c1223d105f817ed088201c3"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="core_2_analysis_2_token_8cs.html#ac7655d900c1223d105f817ed088201c3">ArrayUtil</a> = <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_array_util.html">Lucene.Net.Util.ArrayUtil</a></td></tr>
<tr class="separator:ac7655d900c1223d105f817ed088201c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c6c543e9e03ec9a8e489ea9e99694bf"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="core_2_analysis_2_token_8cs.html#a0c6c543e9e03ec9a8e489ea9e99694bf">Attribute</a> = <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html">Lucene.Net.Util.Attribute</a></td></tr>
<tr class="separator:a0c6c543e9e03ec9a8e489ea9e99694bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ac7655d900c1223d105f817ed088201c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_array_util.html">ArrayUtil</a> = <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_array_util.html">Lucene.Net.Util.ArrayUtil</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="core_2_analysis_2_token_8cs_source.html#l00024">24</a> of file <a class="el" href="core_2_analysis_2_token_8cs_source.html">Token.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a0c6c543e9e03ec9a8e489ea9e99694bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html">Attribute</a> = <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_attribute.html">Lucene.Net.Util.Attribute</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="core_2_analysis_2_token_8cs_source.html#l00025">25</a> of file <a class="el" href="core_2_analysis_2_token_8cs_source.html">Token.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aba3faac25c0f0a8ba32b9ec6854f2657"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="core_2_analysis_2_token_8cs.html#aba3faac25c0f0a8ba32b9ec6854f2657">Payload</a> = <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html">Lucene.Net.Index.Payload</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="core_2_analysis_2_token_8cs_source.html#l00022">22</a> of file <a class="el" href="core_2_analysis_2_token_8cs_source.html">Token.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a17a77b770c87cb0e7153982c4171bfcc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="core_2_analysis_2_token_8cs.html#a17a77b770c87cb0e7153982c4171bfcc">TermPositions</a> = <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html">Lucene.Net.Index.TermPositions</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="core_2_analysis_2_token_8cs_source.html#l00023">23</a> of file <a class="el" href="core_2_analysis_2_token_8cs_source.html">Token.cs</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:47 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>