blob: 8d072e8dd3edd285580616325407a65df9bac322 [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/Document/Fieldable.cs Source File</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_26c304b05067858a09da5afdd232cb28.html">Document</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Fieldable.cs</div> </div>
</div><!--header-->
<div class="contents">
<a href="_fieldable_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* </span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * this work for additional information regarding copyright ownership.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">using</span> System;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">using</span> System.IO;</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="code" href="_fieldable_8cs.html#a205730fc8c2839cf92051d131140dae0"> 20</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> = Lucene.Net.Analysis.TokenStream;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="code" href="_fieldable_8cs.html#a7e48939924d26d58803de390e852a01c"> 21</a></span>&#160;<span class="keyword">using</span> <a class="code" href="_fieldable_8cs.html#a7e48939924d26d58803de390e852a01c">FieldInvertState</a> = Lucene.Net.Index.FieldInvertState;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span>Lucene.Net.<a class="code" href="_index_set_8cs.html#ab0c91be630b1f43f2379cc5964ed640c">Documents</a></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html"> 35</a></span>&#160; <span class="keyword">public</span> <span class="keyword">interface </span><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a56f574c0f2e767e8e10a4977bbb2789a"> 66</a></span>&#160; <span class="keywordtype">float</span> Boost { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439"> 71</a></span>&#160; <span class="keywordtype">string</span> Name { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#adaea4a14b9c96576da9171b41abff836"> 82</a></span>&#160; <span class="keywordtype">string</span> StringValue { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1576df6ab1faed2ae00f4d0557bb2ce8"> 87</a></span>&#160; TextReader ReaderValue { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a75e563b489559fbad505a4c6be4ebbeb"> 92</a></span>&#160; <a class="code" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> TokenStreamValue { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#ae96b9ed1decb32a4fc56362855d9ce24"> 97</a></span>&#160; <span class="keywordtype">bool</span> IsStored { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1d06afbb41d96935271f515185486894"> 102</a></span>&#160; <span class="keywordtype">bool</span> IsIndexed { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a759bc03b5d9691321bda270434e381f0"> 108</a></span>&#160; <span class="keywordtype">bool</span> IsTokenized { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div>
<div class="line"><a name="l00119"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a4e82d504152effe292572e6242c0ce16"> 119</a></span>&#160; <span class="keywordtype">bool</span> IsTermVectorStored { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;</div>
<div class="line"><a name="l00124"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a6dd87770d7fb1fe7f71a1b86af0f4cf5"> 124</a></span>&#160; <span class="keywordtype">bool</span> IsStoreOffsetWithTermVector { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;</div>
<div class="line"><a name="l00127"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a3fe2ff23898c82339c83088fed82518a"> 127</a></span>&#160; <span class="keywordtype">bool</span> IsStorePositionWithTermVector { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div>
<div class="line"><a name="l00130"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1f0b930c4cc0180629d70fb056a17316"> 130</a></span>&#160; <span class="keywordtype">bool</span> IsBinary { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div>
<div class="line"><a name="l00140"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1e9e11d2fe5ae37031d6a590042720b3"> 140</a></span>&#160; <span class="keywordtype">bool</span> OmitNorms { <span class="keyword">get</span>; <span class="keyword">set</span>; }</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div>
<div class="line"><a name="l00149"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#ad5c660c07e9defcf7cbcfbb93c18fa67"> 149</a></span>&#160; <span class="keywordtype">bool</span> IsLazy { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;</div>
<div class="line"><a name="l00155"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a715d668bb08d334114912c605cbd3a87"> 155</a></span>&#160; <span class="keywordtype">int</span> BinaryOffset { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;</div>
<div class="line"><a name="l00161"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1626e0013eb0d4b47adddc18b4b588f2"> 161</a></span>&#160; <span class="keywordtype">int</span> BinaryLength { <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; byte[] GetBinaryValue();</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; byte[] GetBinaryValue(byte[] result);</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;</div>
<div class="line"><a name="l00203"></a><span class="lineno"><a class="code" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a2b04a2db2455db84a38aa483b3d5f156"> 203</a></span>&#160; <span class="keywordtype">bool</span> OmitTermFreqAndPositions { <span class="keyword">set</span>; <span class="keyword">get</span>; }</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; }</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:44 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>