| <!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.PayloadAttribute 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 |
|  <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 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 List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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_payload_attribute.html">PayloadAttribute</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Analysis.Tokenattributes.PayloadAttribute Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The payload 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's text...">Token</a>. See also <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute.html#a48c0899f5fb938e38c4a9f218d3a2292" title="Returns this Token's payload.">Payload</a>. |
| <a href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_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_payload_attribute.html">Lucene.Net.Analysis.Tokenattributes.IPayloadAttribute</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:adcd6cd346cc5d13e78e5423ec008f279"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute.html#adcd6cd346cc5d13e78e5423ec008f279">PayloadAttribute</a> ()</td></tr> |
| <tr class="memdesc:adcd6cd346cc5d13e78e5423ec008f279"><td class="mdescLeft"> </td><td class="mdescRight">Initialize this attribute with no payload. <a href="#adcd6cd346cc5d13e78e5423ec008f279"></a><br/></td></tr> |
| <tr class="separator:adcd6cd346cc5d13e78e5423ec008f279"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0e500519d61e4a9e10cf936a0c32b17a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute.html#a0e500519d61e4a9e10cf936a0c32b17a">PayloadAttribute</a> (<a class="el" href="core_2_analysis_2_token_8cs.html#aba3faac25c0f0a8ba32b9ec6854f2657">Payload</a> payload)</td></tr> |
| <tr class="memdesc:a0e500519d61e4a9e10cf936a0c32b17a"><td class="mdescLeft"> </td><td class="mdescRight">Initialize this attribute with the given payload. <a href="#a0e500519d61e4a9e10cf936a0c32b17a"></a><br/></td></tr> |
| <tr class="separator:a0e500519d61e4a9e10cf936a0c32b17a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a54452d495324723271b5b372a96bcc58"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute.html#a54452d495324723271b5b372a96bcc58">Clear</a> ()</td></tr> |
| <tr class="separator:a54452d495324723271b5b372a96bcc58"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab300a570824d1d4fb2f06076741f6a09"><td class="memItemLeft" align="right" valign="top">override System.Object </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute.html#ab300a570824d1d4fb2f06076741f6a09">Clone</a> ()</td></tr> |
| <tr class="separator:ab300a570824d1d4fb2f06076741f6a09"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7cc41b811f6efc21be200b07e4cc4eb0"><td class="memItemLeft" align="right" valign="top">override bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute.html#a7cc41b811f6efc21be200b07e4cc4eb0">Equals</a> (System.Object other)</td></tr> |
| <tr class="separator:a7cc41b811f6efc21be200b07e4cc4eb0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af2e1c18f4b9205dd1800c1e69436c97d"><td class="memItemLeft" align="right" valign="top">override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute.html#af2e1c18f4b9205dd1800c1e69436c97d">GetHashCode</a> ()</td></tr> |
| <tr class="separator:af2e1c18f4b9205dd1800c1e69436c97d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a50584a65752ef977f5e89ae8f40d2779"><td class="memItemLeft" align="right" valign="top">override void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute.html#a50584a65752ef977f5e89ae8f40d2779">CopyTo</a> (<a class="el" href="_single_token_token_stream_8cs.html#a0c6c543e9e03ec9a8e489ea9e99694bf">Attribute</a> target)</td></tr> |
| <tr class="separator:a50584a65752ef977f5e89ae8f40d2779"><td class="memSeparator" colspan="2"> </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:a48c0899f5fb938e38c4a9f218d3a2292"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="core_2_analysis_2_token_8cs.html#aba3faac25c0f0a8ba32b9ec6854f2657">Payload</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute.html#a48c0899f5fb938e38c4a9f218d3a2292">Payload</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a48c0899f5fb938e38c4a9f218d3a2292"><td class="mdescLeft"> </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's text...">Token</a>'s payload. <a href="#a48c0899f5fb938e38c4a9f218d3a2292"></a><br/></td></tr> |
| <tr class="separator:a48c0899f5fb938e38c4a9f218d3a2292"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_payload_attribute"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_payload_attribute')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_payload_attribute.html">Lucene.Net.Analysis.Tokenattributes.IPayloadAttribute</a></td></tr> |
| <tr class="memitem:a85b93b190217f58207d09ef78a2381df inherit properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_payload_attribute"><td class="memItemLeft" align="right" valign="top"><a class="el" href="core_2_analysis_2_token_8cs.html#aba3faac25c0f0a8ba32b9ec6854f2657">Payload</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_payload_attribute.html#a85b93b190217f58207d09ef78a2381df">Payload</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a85b93b190217f58207d09ef78a2381df inherit properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_payload_attribute"><td class="mdescLeft"> </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's text...">Token</a>'s payload. <a href="#a85b93b190217f58207d09ef78a2381df"></a><br/></td></tr> |
| <tr class="separator:a85b93b190217f58207d09ef78a2381df inherit properties_interface_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_i_payload_attribute"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>The payload 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's text...">Token</a>. See also <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_tokenattributes_1_1_payload_attribute.html#a48c0899f5fb938e38c4a9f218d3a2292" title="Returns this Token's payload.">Payload</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_payload_attribute_8cs_source.html#l00027">27</a> of file <a class="el" href="_payload_attribute_8cs_source.html">PayloadAttribute.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="adcd6cd346cc5d13e78e5423ec008f279"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Analysis.Tokenattributes.PayloadAttribute.PayloadAttribute </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initialize this attribute with no payload.</p> |
| |
| <p>Definition at line <a class="el" href="_payload_attribute_8cs_source.html#l00032">32</a> of file <a class="el" href="_payload_attribute_8cs_source.html">PayloadAttribute.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0e500519d61e4a9e10cf936a0c32b17a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Analysis.Tokenattributes.PayloadAttribute.PayloadAttribute </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="core_2_analysis_2_token_8cs.html#aba3faac25c0f0a8ba32b9ec6854f2657">Payload</a> </td> |
| <td class="paramname"><em>payload</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initialize this attribute with the given payload. </p> |
| |
| <p>Definition at line <a class="el" href="_payload_attribute_8cs_source.html#l00037">37</a> of file <a class="el" href="_payload_attribute_8cs_source.html">PayloadAttribute.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a54452d495324723271b5b372a96bcc58"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override void Lucene.Net.Analysis.Tokenattributes.PayloadAttribute.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="_payload_attribute_8cs_source.html#l00049">49</a> of file <a class="el" href="_payload_attribute_8cs_source.html">PayloadAttribute.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab300a570824d1d4fb2f06076741f6a09"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.Object Lucene.Net.Analysis.Tokenattributes.PayloadAttribute.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="_payload_attribute_8cs_source.html#l00054">54</a> of file <a class="el" href="_payload_attribute_8cs_source.html">PayloadAttribute.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a50584a65752ef977f5e89ae8f40d2779"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override void Lucene.Net.Analysis.Tokenattributes.PayloadAttribute.CopyTo </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="_single_token_token_stream_8cs.html#a0c6c543e9e03ec9a8e489ea9e99694bf">Attribute</a> </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="_payload_attribute_8cs_source.html#l00094">94</a> of file <a class="el" href="_payload_attribute_8cs_source.html">PayloadAttribute.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7cc41b811f6efc21be200b07e4cc4eb0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override bool Lucene.Net.Analysis.Tokenattributes.PayloadAttribute.Equals </td> |
| <td>(</td> |
| <td class="paramtype">System.Object </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="_payload_attribute_8cs_source.html#l00068">68</a> of file <a class="el" href="_payload_attribute_8cs_source.html">PayloadAttribute.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af2e1c18f4b9205dd1800c1e69436c97d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Analysis.Tokenattributes.PayloadAttribute.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="_payload_attribute_8cs_source.html#l00089">89</a> of file <a class="el" href="_payload_attribute_8cs_source.html">PayloadAttribute.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a48c0899f5fb938e38c4a9f218d3a2292"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="core_2_analysis_2_token_8cs.html#aba3faac25c0f0a8ba32b9ec6854f2657">Payload</a> Lucene.Net.Analysis.Tokenattributes.PayloadAttribute.Payload</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</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's text...">Token</a>'s payload.</p> |
| |
| <p>Definition at line <a class="el" href="_payload_attribute_8cs_source.html#l00044">44</a> of file <a class="el" href="_payload_attribute_8cs_source.html">PayloadAttribute.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="_payload_attribute_8cs_source.html">PayloadAttribute.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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
