| <!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.Payload 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_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html">Payload</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_index_1_1_payload-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Index.Payload 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_payload.html" title="A Payload is metadata that can be stored together with each occurrence of a term. This metadata is st...">Payload</a> is metadata that can be stored together with each occurrence of a term. This metadata is stored inline in the posting list of the specific term. To store payloads in the index a <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> has to be used that produces payload data. Use <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html#adbfebfa3b7a2bd01f3ba0eede68ea964" title="Returns the length of the payload at the current term position. This is invalid until NextPosition() ...">TermPositions.PayloadLength</a> and <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html#ad3740df833e76a4850d88eaab68a9629" title="Returns the payload data at the current term position. This is invalid until NextPosition() is called...">TermPositions.GetPayload(byte[], int)</a> to retrieve the payloads from the index.<br/> |
| |
| <a href="class_lucene_1_1_net_1_1_index_1_1_payload.html#details">More...</a></p> |
| |
| <p>Inherits 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:a552df0ce6a4eec54d856cb357113cf7b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a552df0ce6a4eec54d856cb357113cf7b">Payload</a> ()</td></tr> |
| <tr class="memdesc:a552df0ce6a4eec54d856cb357113cf7b"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty payload and does not allocate a byte array. <a href="#a552df0ce6a4eec54d856cb357113cf7b"></a><br/></td></tr> |
| <tr class="separator:a552df0ce6a4eec54d856cb357113cf7b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2cb09d319e3f79ad2d29733e0adbcb8a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a2cb09d319e3f79ad2d29733e0adbcb8a">Payload</a> (byte[] data)</td></tr> |
| <tr class="memdesc:a2cb09d319e3f79ad2d29733e0adbcb8a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new payload with the the given array as data. A reference to the passed-in array is held, i. e. no copy is made. <a href="#a2cb09d319e3f79ad2d29733e0adbcb8a"></a><br/></td></tr> |
| <tr class="separator:a2cb09d319e3f79ad2d29733e0adbcb8a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae941d501b8cc4e452d81cb4a2277f361"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#ae941d501b8cc4e452d81cb4a2277f361">Payload</a> (byte[] data, int offset, int length)</td></tr> |
| <tr class="memdesc:ae941d501b8cc4e452d81cb4a2277f361"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new payload with the the given array as data. A reference to the passed-in array is held, i. e. no copy is made. <a href="#ae941d501b8cc4e452d81cb4a2277f361"></a><br/></td></tr> |
| <tr class="separator:ae941d501b8cc4e452d81cb4a2277f361"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9abaef661b75b98548d7a83ac1d802f1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a9abaef661b75b98548d7a83ac1d802f1">SetData</a> (byte[] value, int offset, int length)</td></tr> |
| <tr class="memdesc:a9abaef661b75b98548d7a83ac1d802f1"><td class="mdescLeft"> </td><td class="mdescRight">Sets this payloads data. A reference to the passed-in array is held, i. e. no copy is made. <a href="#a9abaef661b75b98548d7a83ac1d802f1"></a><br/></td></tr> |
| <tr class="separator:a9abaef661b75b98548d7a83ac1d802f1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a26bd765cad33dbdf9bc0cd9926dff50c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a26bd765cad33dbdf9bc0cd9926dff50c">SetData</a> (byte[] value)</td></tr> |
| <tr class="memdesc:a26bd765cad33dbdf9bc0cd9926dff50c"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets a reference to the underlying byte array that holds this payloads data. Data is not copied. <a href="#a26bd765cad33dbdf9bc0cd9926dff50c"></a><br/></td></tr> |
| <tr class="separator:a26bd765cad33dbdf9bc0cd9926dff50c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a042e7c37a15f1d04ac31df93bc73c246"><td class="memItemLeft" align="right" valign="top">virtual byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a042e7c37a15f1d04ac31df93bc73c246">GetData</a> ()</td></tr> |
| <tr class="memdesc:a042e7c37a15f1d04ac31df93bc73c246"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets a reference to the underlying byte array that holds this payloads data. Data is not copied. <a href="#a042e7c37a15f1d04ac31df93bc73c246"></a><br/></td></tr> |
| <tr class="separator:a042e7c37a15f1d04ac31df93bc73c246"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a576e909bb00bb5f513be8075ae67af16"><td class="memItemLeft" align="right" valign="top">virtual byte </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a576e909bb00bb5f513be8075ae67af16">ByteAt</a> (int index)</td></tr> |
| <tr class="memdesc:a576e909bb00bb5f513be8075ae67af16"><td class="mdescLeft"> </td><td class="mdescRight">Returns the byte at the given index. <a href="#a576e909bb00bb5f513be8075ae67af16"></a><br/></td></tr> |
| <tr class="separator:a576e909bb00bb5f513be8075ae67af16"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7ee889192762889f57e4a46146cff87f"><td class="memItemLeft" align="right" valign="top">virtual byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a7ee889192762889f57e4a46146cff87f">ToByteArray</a> ()</td></tr> |
| <tr class="memdesc:a7ee889192762889f57e4a46146cff87f"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a new byte array, copies the payload data into it and returns it. <a href="#a7ee889192762889f57e4a46146cff87f"></a><br/></td></tr> |
| <tr class="separator:a7ee889192762889f57e4a46146cff87f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a730d182e645087f04873b3deb737f8a8"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a730d182e645087f04873b3deb737f8a8">CopyTo</a> (byte[] target, int targetOffset)</td></tr> |
| <tr class="memdesc:a730d182e645087f04873b3deb737f8a8"><td class="mdescLeft"> </td><td class="mdescRight">Copies the payload data to a byte array. <a href="#a730d182e645087f04873b3deb737f8a8"></a><br/></td></tr> |
| <tr class="separator:a730d182e645087f04873b3deb737f8a8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a8e85764e5ae04eaf766d600cca7327"><td class="memItemLeft" align="right" valign="top">virtual System.Object </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a5a8e85764e5ae04eaf766d600cca7327">Clone</a> ()</td></tr> |
| <tr class="memdesc:a5a8e85764e5ae04eaf766d600cca7327"><td class="mdescLeft"> </td><td class="mdescRight">Clones this payload by creating a copy of the underlying byte array. <a href="#a5a8e85764e5ae04eaf766d600cca7327"></a><br/></td></tr> |
| <tr class="separator:a5a8e85764e5ae04eaf766d600cca7327"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a17fb1fb83b1947a914dbcf62d561d759"><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_index_1_1_payload.html#a17fb1fb83b1947a914dbcf62d561d759">Equals</a> (System.Object obj)</td></tr> |
| <tr class="separator:a17fb1fb83b1947a914dbcf62d561d759"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac7500e90daf7d6282dbbccca15eaffde"><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_index_1_1_payload.html#ac7500e90daf7d6282dbbccca15eaffde">GetHashCode</a> ()</td></tr> |
| <tr class="separator:ac7500e90daf7d6282dbbccca15eaffde"><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:a9c042971649d2ae90d392c79bc71f234"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a9c042971649d2ae90d392c79bc71f234">Offset</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a9c042971649d2ae90d392c79bc71f234"><td class="mdescLeft"> </td><td class="mdescRight">Returns the offset in the underlying byte array <a href="#a9c042971649d2ae90d392c79bc71f234"></a><br/></td></tr> |
| <tr class="separator:a9c042971649d2ae90d392c79bc71f234"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a86640081e2996358cca1c40d63daee60"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_payload.html#a86640081e2996358cca1c40d63daee60">Length</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a86640081e2996358cca1c40d63daee60"><td class="mdescLeft"> </td><td class="mdescRight">Returns the length of the payload data. <a href="#a86640081e2996358cca1c40d63daee60"></a><br/></td></tr> |
| <tr class="separator:a86640081e2996358cca1c40d63daee60"><td class="memSeparator" colspan="2"> </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_payload.html" title="A Payload is metadata that can be stored together with each occurrence of a term. This metadata is st...">Payload</a> is metadata that can be stored together with each occurrence of a term. This metadata is stored inline in the posting list of the specific term. </p> |
| <p>To store payloads in the index a <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> has to be used that produces payload data. </p> |
| <p>Use <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html#adbfebfa3b7a2bd01f3ba0eede68ea964" title="Returns the length of the payload at the current term position. This is invalid until NextPosition() ...">TermPositions.PayloadLength</a> and <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_positions.html#ad3740df833e76a4850d88eaab68a9629" title="Returns the payload data at the current term position. This is invalid until NextPosition() is called...">TermPositions.GetPayload(byte[], int)</a> to retrieve the payloads from the index.<br/> |
| </p> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00038">38</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a552df0ce6a4eec54d856cb357113cf7b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Index.Payload.Payload </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates an empty payload and does not allocate a byte array. </p> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00050">50</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2cb09d319e3f79ad2d29733e0adbcb8a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Index.Payload.Payload </td> |
| <td>(</td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>data</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a new payload with the the given array as data. A reference to the passed-in array is held, i. e. no copy is made. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">data</td><td>the data of this payload </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00062">62</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae941d501b8cc4e452d81cb4a2277f361"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Index.Payload.Payload </td> |
| <td>(</td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>data</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>offset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>length</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a new payload with the the given array as data. A reference to the passed-in array is held, i. e. no copy is made. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">data</td><td>the data of this payload </td></tr> |
| <tr><td class="paramname">offset</td><td>the offset in the data byte array </td></tr> |
| <tr><td class="paramname">length</td><td>the length of the data </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00077">77</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a576e909bb00bb5f513be8075ae67af16"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual byte Lucene.Net.Index.Payload.ByteAt </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>index</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>Returns the byte at the given index.</p> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00128">128</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5a8e85764e5ae04eaf766d600cca7327"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual System.Object Lucene.Net.Index.Payload.Clone </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>Clones this payload by creating a copy of the underlying byte array. </p> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00164">164</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a730d182e645087f04873b3deb737f8a8"></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.Index.Payload.CopyTo </td> |
| <td>(</td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>target</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>targetOffset</em> </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 payload data to a byte array. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">target</td><td>the target byte array </td></tr> |
| <tr><td class="paramname">targetOffset</td><td>the offset in the target byte array </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00152">152</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a17fb1fb83b1947a914dbcf62d561d759"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override bool Lucene.Net.Index.Payload.Equals </td> |
| <td>(</td> |
| <td class="paramtype">System.Object </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="_payload_8cs_source.html#l00191">191</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a042e7c37a15f1d04ac31df93bc73c246"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual byte [] Lucene.Net.Index.Payload.GetData </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>Gets or sets a reference to the underlying byte array that holds this payloads data. Data is not copied. </p> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00110">110</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac7500e90daf7d6282dbbccca15eaffde"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Index.Payload.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_8cs_source.html#l00212">212</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9abaef661b75b98548d7a83ac1d802f1"></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.Index.Payload.SetData </td> |
| <td>(</td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>value</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>offset</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>length</em> </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>Sets this payloads data. A reference to the passed-in array is held, i. e. no copy is made. </p> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00092">92</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a26bd765cad33dbdf9bc0cd9926dff50c"></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.Index.Payload.SetData </td> |
| <td>(</td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>value</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>Gets or sets a reference to the underlying byte array that holds this payloads data. Data is not copied. </p> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00102">102</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7ee889192762889f57e4a46146cff87f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual byte [] Lucene.Net.Index.Payload.ToByteArray </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>Allocates a new byte array, copies the payload data into it and returns it. </p> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00138">138</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a86640081e2996358cca1c40d63daee60"></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.Index.Payload.Length</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 length of the payload data. </p> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00123">123</a> of file <a class="el" href="_payload_8cs_source.html">Payload.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9c042971649d2ae90d392c79bc71f234"></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.Index.Payload.Offset</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 offset in the underlying byte array </p> |
| |
| <p>Definition at line <a class="el" href="_payload_8cs_source.html#l00117">117</a> of file <a class="el" href="_payload_8cs_source.html">Payload.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="_payload_8cs_source.html">Payload.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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
