| <!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.Documents.Field 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_documents.html">Documents</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_documents_1_1_field-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Documents.Field Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A field is a section of a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a>. Each field has two parts, a name and a value. Values may be free text, provided as a String or as a Reader, or they may be atomic keywords, which are not further processed. Such keywords may be used to represent dates, urls, etc. Fields are optionally stored in the index, so that they may be returned with hits on the document. |
| <a href="class_lucene_1_1_net_1_1_documents_1_1_field.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html">Lucene.Net.Documents.AbstractField</a>, and <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">Lucene.Net.Documents.IFieldable</a>.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:aa200dd8593e5a9caf29bb3380df5b4ad"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> { <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ada7469a286259799e5b37e5db9296f00b3">YES</a>, |
| <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4adac2f3f489a00553e7a01d369c103c7251">NO</a> |
| }</td></tr> |
| <tr class="memdesc:aa200dd8593e5a9caf29bb3380df5b4ad"><td class="mdescLeft"> </td><td class="mdescRight">Specifies whether and how a field should be stored. <a href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">More...</a><br/></td></tr> |
| <tr class="separator:aa200dd8593e5a9caf29bb3380df5b4ad"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6da09f47bd62b150214f07404e03be47"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47">Index</a> { <br/> |
|   <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47ac2f3f489a00553e7a01d369c103c7251">NO</a>, |
| <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47a11bafc6149b3e73a290841caa2154a3d">ANALYZED</a>, |
| <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47a79e415ba75f00aaee941935b93efecd9">NOT_ANALYZED</a>, |
| <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47a9e352cdf44c79dea8b83f66c1b20f2e3">NOT_ANALYZED_NO_NORMS</a>, |
| <br/> |
|   <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47a1ff027332258c6df510eaa5f5e97b483">ANALYZED_NO_NORMS</a> |
| <br/> |
| }</td></tr> |
| <tr class="memdesc:a6da09f47bd62b150214f07404e03be47"><td class="mdescLeft"> </td><td class="mdescRight">Specifies whether and how a field should be indexed. <a href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47">More...</a><br/></td></tr> |
| <tr class="separator:a6da09f47bd62b150214f07404e03be47"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3b16afc1c9c84681505db09934edd40e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40e">TermVector</a> { <br/> |
|   <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40eac2f3f489a00553e7a01d369c103c7251">NO</a>, |
| <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40ea7469a286259799e5b37e5db9296f00b3">YES</a>, |
| <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40ea7ddcb0bf12bb332be4a2264e68ce876c">WITH_POSITIONS</a>, |
| <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40ea0594f9fbbd396c253ec42c44a000b331">WITH_OFFSETS</a>, |
| <br/> |
|   <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40ea54b2cad1837b9a5b85a158e4d31b1d21">WITH_POSITIONS_OFFSETS</a> |
| <br/> |
| }</td></tr> |
| <tr class="memdesc:a3b16afc1c9c84681505db09934edd40e"><td class="mdescLeft"> </td><td class="mdescRight">Specifies whether and how a field should have term vectors. <a href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40e">More...</a><br/></td></tr> |
| <tr class="separator:a3b16afc1c9c84681505db09934edd40e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:aa8b8851f8ce109c25a0c5e9f3aeb3077"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa8b8851f8ce109c25a0c5e9f3aeb3077">SetValue</a> (System.String value)</td></tr> |
| <tr class="memdesc:aa8b8851f8ce109c25a0c5e9f3aeb3077"><td class="mdescLeft"> </td><td class="mdescRight">Expert: change the value of this field. This can be used during indexing to re-use a single <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> instance to improve indexing speed by avoiding GC cost of new'ing and reclaiming <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> instances. Typically a single <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> instance is re-used as well. This helps most on small documents. <a href="#aa8b8851f8ce109c25a0c5e9f3aeb3077"></a><br/></td></tr> |
| <tr class="separator:aa8b8851f8ce109c25a0c5e9f3aeb3077"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4f6aca573c2bcf046307041016c6d65f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a4f6aca573c2bcf046307041016c6d65f">SetValue</a> (System.IO.TextReader value)</td></tr> |
| <tr class="memdesc:a4f6aca573c2bcf046307041016c6d65f"><td class="mdescLeft"> </td><td class="mdescRight">Expert: change the value of this field. See <a href="#setValue(java.lang.String)">setValue(String)</a>. <a href="#a4f6aca573c2bcf046307041016c6d65f"></a><br/></td></tr> |
| <tr class="separator:a4f6aca573c2bcf046307041016c6d65f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac0024427761fc7c8782cda7c812790f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#ac0024427761fc7c8782cda7c812790f3">SetValue</a> (byte[] value)</td></tr> |
| <tr class="memdesc:ac0024427761fc7c8782cda7c812790f3"><td class="mdescLeft"> </td><td class="mdescRight">Expert: change the value of this field. See <a href="#setValue(java.lang.String)">setValue(String)</a>. <a href="#ac0024427761fc7c8782cda7c812790f3"></a><br/></td></tr> |
| <tr class="separator:ac0024427761fc7c8782cda7c812790f3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2bdfe6a8450d1e32fc35566bbf243d8c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a2bdfe6a8450d1e32fc35566bbf243d8c">SetValue</a> (byte[] value, int offset, int length)</td></tr> |
| <tr class="memdesc:a2bdfe6a8450d1e32fc35566bbf243d8c"><td class="mdescLeft"> </td><td class="mdescRight">Expert: change the value of this field. See <a href="#setValue(java.lang.String)">setValue(String)</a>. <a href="#a2bdfe6a8450d1e32fc35566bbf243d8c"></a><br/></td></tr> |
| <tr class="separator:a2bdfe6a8450d1e32fc35566bbf243d8c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9ba35709a6518d82ef7552c1fe3bc896"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a9ba35709a6518d82ef7552c1fe3bc896">SetTokenStream</a> (<a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> tokenStream)</td></tr> |
| <tr class="memdesc:a9ba35709a6518d82ef7552c1fe3bc896"><td class="mdescLeft"> </td><td class="mdescRight">Expert: sets the token stream to be used for indexing and causes isIndexed() and isTokenized() to return true. May be combined with stored values from stringValue() or GetBinaryValue() <a href="#a9ba35709a6518d82ef7552c1fe3bc896"></a><br/></td></tr> |
| <tr class="separator:a9ba35709a6518d82ef7552c1fe3bc896"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6806fd35d105d14b3a2b8fb40a7dfe67"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6806fd35d105d14b3a2b8fb40a7dfe67">Field</a> (System.String name, System.String value, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> store, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47">Index</a> index)</td></tr> |
| <tr class="memdesc:a6806fd35d105d14b3a2b8fb40a7dfe67"><td class="mdescLeft"> </td><td class="mdescRight">Create a field by specifying its name, value and how it will be saved in the index. Term vectors will not be stored in the index. <a href="#a6806fd35d105d14b3a2b8fb40a7dfe67"></a><br/></td></tr> |
| <tr class="separator:a6806fd35d105d14b3a2b8fb40a7dfe67"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abb2d635c30101749c77eb050ccc45f18"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#abb2d635c30101749c77eb050ccc45f18">Field</a> (System.String name, System.String value, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> store, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47">Index</a> index, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40e">TermVector</a> termVector)</td></tr> |
| <tr class="memdesc:abb2d635c30101749c77eb050ccc45f18"><td class="mdescLeft"> </td><td class="mdescRight">Create a field by specifying its name, value and how it will be saved in the index. <a href="#abb2d635c30101749c77eb050ccc45f18"></a><br/></td></tr> |
| <tr class="separator:abb2d635c30101749c77eb050ccc45f18"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e101116eaa1bb7abbeebf2b0e731135"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a1e101116eaa1bb7abbeebf2b0e731135">Field</a> (System.String name, bool internName, System.String value, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> store, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47">Index</a> index, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40e">TermVector</a> termVector)</td></tr> |
| <tr class="memdesc:a1e101116eaa1bb7abbeebf2b0e731135"><td class="mdescLeft"> </td><td class="mdescRight">Create a field by specifying its name, value and how it will be saved in the index. <a href="#a1e101116eaa1bb7abbeebf2b0e731135"></a><br/></td></tr> |
| <tr class="separator:a1e101116eaa1bb7abbeebf2b0e731135"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9daed22a6dee78c30d0f0d81f74d3357"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a9daed22a6dee78c30d0f0d81f74d3357">Field</a> (System.String name, System.IO.TextReader reader)</td></tr> |
| <tr class="memdesc:a9daed22a6dee78c30d0f0d81f74d3357"><td class="mdescLeft"> </td><td class="mdescRight">Create a tokenized and indexed field that is not stored. Term vectors will not be stored. The Reader is read only when the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is added to the index, i.e. you may not close the Reader until IndexWriter.AddDocument(Document) has been called. <a href="#a9daed22a6dee78c30d0f0d81f74d3357"></a><br/></td></tr> |
| <tr class="separator:a9daed22a6dee78c30d0f0d81f74d3357"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afea87c06a30e9f6d5de5485d57935928"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#afea87c06a30e9f6d5de5485d57935928">Field</a> (System.String name, System.IO.TextReader reader, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40e">TermVector</a> termVector)</td></tr> |
| <tr class="memdesc:afea87c06a30e9f6d5de5485d57935928"><td class="mdescLeft"> </td><td class="mdescRight">Create a tokenized and indexed field that is not stored, optionally with storing term vectors. The Reader is read only when the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is added to the index, i.e. you may not close the Reader until IndexWriter.AddDocument(Document) has been called. <a href="#afea87c06a30e9f6d5de5485d57935928"></a><br/></td></tr> |
| <tr class="separator:afea87c06a30e9f6d5de5485d57935928"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0cabd0537b001b85d1d5eec732329ce8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a0cabd0537b001b85d1d5eec732329ce8">Field</a> (System.String name, <a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> tokenStream)</td></tr> |
| <tr class="memdesc:a0cabd0537b001b85d1d5eec732329ce8"><td class="mdescLeft"> </td><td class="mdescRight">Create a tokenized and indexed field that is not stored. Term vectors will not be stored. This is useful for pre-analyzed fields. The TokenStream is read only when the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is added to the index, i.e. you may not close the TokenStream until IndexWriter.AddDocument(Document) has been called. <a href="#a0cabd0537b001b85d1d5eec732329ce8"></a><br/></td></tr> |
| <tr class="separator:a0cabd0537b001b85d1d5eec732329ce8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a82fd8802c6418c2a570279eb1ac30d7e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a82fd8802c6418c2a570279eb1ac30d7e">Field</a> (System.String name, <a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> tokenStream, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40e">TermVector</a> termVector)</td></tr> |
| <tr class="memdesc:a82fd8802c6418c2a570279eb1ac30d7e"><td class="mdescLeft"> </td><td class="mdescRight">Create a tokenized and indexed field that is not stored, optionally with storing term vectors. This is useful for pre-analyzed fields. The TokenStream is read only when the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is added to the index, i.e. you may not close the TokenStream until IndexWriter.AddDocument(Document) has been called. <a href="#a82fd8802c6418c2a570279eb1ac30d7e"></a><br/></td></tr> |
| <tr class="separator:a82fd8802c6418c2a570279eb1ac30d7e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:affde6da3d2e21f52d1d9b6602cfb294b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#affde6da3d2e21f52d1d9b6602cfb294b">Field</a> (System.String name, byte[] value_Renamed, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> store)</td></tr> |
| <tr class="memdesc:affde6da3d2e21f52d1d9b6602cfb294b"><td class="mdescLeft"> </td><td class="mdescRight">Create a stored field with binary value. Optionally the value may be compressed. <a href="#affde6da3d2e21f52d1d9b6602cfb294b"></a><br/></td></tr> |
| <tr class="separator:affde6da3d2e21f52d1d9b6602cfb294b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abb95f75536067bd5ea7bb5befcd22b79"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#abb95f75536067bd5ea7bb5befcd22b79">Field</a> (System.String name, byte[] value_Renamed, int offset, int length, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> store)</td></tr> |
| <tr class="memdesc:abb95f75536067bd5ea7bb5befcd22b79"><td class="mdescLeft"> </td><td class="mdescRight">Create a stored field with binary value. Optionally the value may be compressed. <a href="#abb95f75536067bd5ea7bb5befcd22b79"></a><br/></td></tr> |
| <tr class="separator:abb95f75536067bd5ea7bb5befcd22b79"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html">Lucene.Net.Documents.AbstractField</a></td></tr> |
| <tr class="memitem:a6a26a474ae6cad038f7d84ffe46a240e inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><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_documents_1_1_abstract_field.html#a6a26a474ae6cad038f7d84ffe46a240e">GetBinaryValue</a> ()</td></tr> |
| <tr class="memdesc:a6a26a474ae6cad038f7d84ffe46a240e inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Return the raw byte[] for the binary field. Note that you must also call BinaryLength and BinaryOffset to know which range of bytes in this returned array belong to the field. <a href="#a6a26a474ae6cad038f7d84ffe46a240e"></a><br/></td></tr> |
| <tr class="separator:a6a26a474ae6cad038f7d84ffe46a240e inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a283237239676dd08a85b564a373c19ee inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><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_documents_1_1_abstract_field.html#a283237239676dd08a85b564a373c19ee">GetBinaryValue</a> (byte[] result)</td></tr> |
| <tr class="memdesc:a283237239676dd08a85b564a373c19ee inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Return the raw byte[] for the binary field. Note that you must also call BinaryLength and BinaryOffset to know which range of bytes in this returned array belong to the field.About reuse: if you pass in the result byte[] and it is used, likely the underlying implementation will hold onto this byte[] and return it in future calls to GetBinaryValue() or GetBinaryValue(). So if you subsequently re-use the same byte[] elsewhere it will alter this Fieldable's value. <a href="#a283237239676dd08a85b564a373c19ee"></a><br/></td></tr> |
| <tr class="separator:a283237239676dd08a85b564a373c19ee inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab141ef90189048a687a090df77620525 inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#ab141ef90189048a687a090df77620525">ToString</a> ()</td></tr> |
| <tr class="memdesc:ab141ef90189048a687a090df77620525 inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Prints a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> for human consumption. <a href="#ab141ef90189048a687a090df77620525"></a><br/></td></tr> |
| <tr class="separator:ab141ef90189048a687a090df77620525 inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><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:abe014bfc3a4421dec2cc63d3c37555af"><td class="memItemLeft" align="right" valign="top">override string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#abe014bfc3a4421dec2cc63d3c37555af">StringValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:abe014bfc3a4421dec2cc63d3c37555af"><td class="mdescLeft"> </td><td class="mdescRight">The value of the field as a String, or null. If null, the Reader value or binary value is used. Exactly one of stringValue(), readerValue(), and getBinaryValue() must be set. <a href="#abe014bfc3a4421dec2cc63d3c37555af"></a><br/></td></tr> |
| <tr class="separator:abe014bfc3a4421dec2cc63d3c37555af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5a05f633b3cc24610ab4924f585b306f"><td class="memItemLeft" align="right" valign="top">override TextReader </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a5a05f633b3cc24610ab4924f585b306f">ReaderValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5a05f633b3cc24610ab4924f585b306f"><td class="mdescLeft"> </td><td class="mdescRight">The value of the field as a Reader, or null. If null, the String value or binary value is used. Exactly one of stringValue(), readerValue(), and getBinaryValue() must be set. <a href="#a5a05f633b3cc24610ab4924f585b306f"></a><br/></td></tr> |
| <tr class="separator:a5a05f633b3cc24610ab4924f585b306f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6d1244ea637f48640c365b7641238ad6"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6d1244ea637f48640c365b7641238ad6">TokenStreamValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6d1244ea637f48640c365b7641238ad6"><td class="mdescLeft"> </td><td class="mdescRight">The TokesStream for this field to be used when indexing, or null. If null, the Reader value or String value is analyzed to produce the indexed tokens. <a href="#a6d1244ea637f48640c365b7641238ad6"></a><br/></td></tr> |
| <tr class="separator:a6d1244ea637f48640c365b7641238ad6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html">Lucene.Net.Documents.AbstractField</a></td></tr> |
| <tr class="memitem:a12c43f4e1ba848fa13a2fb8e6390ff97 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a12c43f4e1ba848fa13a2fb8e6390ff97">Boost</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a12c43f4e1ba848fa13a2fb8e6390ff97 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the boost factor for hits for this field. <a href="#a12c43f4e1ba848fa13a2fb8e6390ff97"></a><br/></td></tr> |
| <tr class="separator:a12c43f4e1ba848fa13a2fb8e6390ff97 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac6304298a279ee813a8e0166dbe94a51 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#ac6304298a279ee813a8e0166dbe94a51">Name</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac6304298a279ee813a8e0166dbe94a51 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the field as an interned string. For example "date", "title", "body", ... <a href="#ac6304298a279ee813a8e0166dbe94a51"></a><br/></td></tr> |
| <tr class="separator:ac6304298a279ee813a8e0166dbe94a51 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6c53bd9ec7c9b337d16a2cf4153be008 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a6c53bd9ec7c9b337d16a2cf4153be008">IsStored</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6c53bd9ec7c9b337d16a2cf4153be008 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff the value of the field is to be stored in the index for return with search hits. It is an error for this to be true if a field is Reader-valued. <a href="#a6c53bd9ec7c9b337d16a2cf4153be008"></a><br/></td></tr> |
| <tr class="separator:a6c53bd9ec7c9b337d16a2cf4153be008 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a54dba90afdf044e3973b13eee7aae9ce inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a54dba90afdf044e3973b13eee7aae9ce">IsIndexed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a54dba90afdf044e3973b13eee7aae9ce inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff the value of the field is to be indexed, so that it may be searched on. <a href="#a54dba90afdf044e3973b13eee7aae9ce"></a><br/></td></tr> |
| <tr class="separator:a54dba90afdf044e3973b13eee7aae9ce inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad3d8927a7ed80379a04a640cf16d0cb0 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#ad3d8927a7ed80379a04a640cf16d0cb0">IsTokenized</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ad3d8927a7ed80379a04a640cf16d0cb0 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are indexed as a single word and may not be Reader-valued. <a href="#ad3d8927a7ed80379a04a640cf16d0cb0"></a><br/></td></tr> |
| <tr class="separator:ad3d8927a7ed80379a04a640cf16d0cb0 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6636184a8406651116d0fc0efdd40fc3 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a6636184a8406651116d0fc0efdd40fc3">IsTermVectorStored</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6636184a8406651116d0fc0efdd40fc3 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff the term or terms used to index this field are stored as a term vector, available from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html#a93ef270cec13352696660ca154d4a1be" title="Return a term frequency vector for the specified document and field. The returned vector contains ter...">Lucene.Net.Index.IndexReader.GetTermFreqVector(int,String)</a>. These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the <code>stored</code> attribute instead. <a href="#a6636184a8406651116d0fc0efdd40fc3"></a><br/></td></tr> |
| <tr class="separator:a6636184a8406651116d0fc0efdd40fc3 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ce93e5a91e5453c763e58e1f90aeba8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a4ce93e5a91e5453c763e58e1f90aeba8">IsStoreOffsetWithTermVector</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4ce93e5a91e5453c763e58e1f90aeba8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff terms are stored as term vector together with their offsets (start and end position in source text). <a href="#a4ce93e5a91e5453c763e58e1f90aeba8"></a><br/></td></tr> |
| <tr class="separator:a4ce93e5a91e5453c763e58e1f90aeba8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96ab5a0c57151bd3d1af5db445a15b1f inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a96ab5a0c57151bd3d1af5db445a15b1f">IsStorePositionWithTermVector</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a96ab5a0c57151bd3d1af5db445a15b1f inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff terms are stored as term vector together with their token positions. <a href="#a96ab5a0c57151bd3d1af5db445a15b1f"></a><br/></td></tr> |
| <tr class="separator:a96ab5a0c57151bd3d1af5db445a15b1f inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afd9b57737df4ceb6ca96fab4b5a4e602 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#afd9b57737df4ceb6ca96fab4b5a4e602">IsBinary</a><code> [get]</code></td></tr> |
| <tr class="memdesc:afd9b57737df4ceb6ca96fab4b5a4e602 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff the value of the filed is stored as binary <a href="#afd9b57737df4ceb6ca96fab4b5a4e602"></a><br/></td></tr> |
| <tr class="separator:afd9b57737df4ceb6ca96fab4b5a4e602 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a36150c4089413d9ad15441c9901a2846 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><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_documents_1_1_abstract_field.html#a36150c4089413d9ad15441c9901a2846">BinaryLength</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a36150c4089413d9ad15441c9901a2846 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Returns length of byte[] segment that is used as value, if <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is not binary returned value is undefined <a href="#a36150c4089413d9ad15441c9901a2846"></a><br/></td></tr> |
| <tr class="separator:a36150c4089413d9ad15441c9901a2846 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a20c57d26c1976513b3faf4c966e2312b inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><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_documents_1_1_abstract_field.html#a20c57d26c1976513b3faf4c966e2312b">BinaryOffset</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a20c57d26c1976513b3faf4c966e2312b inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Returns offset into byte[] segment that is used as value, if <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is not binary returned value is undefined <a href="#a20c57d26c1976513b3faf4c966e2312b"></a><br/></td></tr> |
| <tr class="separator:a20c57d26c1976513b3faf4c966e2312b inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a176db64e8f17090893b4efda2bd1f9f8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a176db64e8f17090893b4efda2bd1f9f8">OmitNorms</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a176db64e8f17090893b4efda2bd1f9f8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True if norms are omitted for this indexed field <a href="#a176db64e8f17090893b4efda2bd1f9f8"></a><br/></td></tr> |
| <tr class="separator:a176db64e8f17090893b4efda2bd1f9f8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa95603c64c05d7fc1dba83b6ea452f6e inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#aa95603c64c05d7fc1dba83b6ea452f6e">OmitTermFreqAndPositions</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:aa95603c64c05d7fc1dba83b6ea452f6e inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Expert: <a href="#aa95603c64c05d7fc1dba83b6ea452f6e"></a><br/></td></tr> |
| <tr class="separator:aa95603c64c05d7fc1dba83b6ea452f6e inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a722b0b487c0b6be77f49bcd4dc435cbf inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a722b0b487c0b6be77f49bcd4dc435cbf">IsLazy</a><code> [get]</code></td></tr> |
| <tr class="separator:a722b0b487c0b6be77f49bcd4dc435cbf inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab539f4526a717604c66f3313fb356df2 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#ab539f4526a717604c66f3313fb356df2">TokenStreamValue</a><code> [get]</code></td></tr> |
| <tr class="separator:ab539f4526a717604c66f3313fb356df2 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab4c7cfe8281f7faf88979f0c16289c57 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">abstract TextReader </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#ab4c7cfe8281f7faf88979f0c16289c57">ReaderValue</a><code> [get]</code></td></tr> |
| <tr class="separator:ab4c7cfe8281f7faf88979f0c16289c57 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acf676d7940f1a9bfad035f1220ec595f inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">abstract string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#acf676d7940f1a9bfad035f1220ec595f">StringValue</a><code> [get]</code></td></tr> |
| <tr class="separator:acf676d7940f1a9bfad035f1220ec595f inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">Lucene.Net.Documents.IFieldable</a></td></tr> |
| <tr class="memitem:a56f574c0f2e767e8e10a4977bbb2789a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a56f574c0f2e767e8e10a4977bbb2789a">Boost</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a56f574c0f2e767e8e10a4977bbb2789a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the boost factor for hits for this field. This value will be multiplied into the score of all hits on this this field of this document. <a href="#a56f574c0f2e767e8e10a4977bbb2789a"></a><br/></td></tr> |
| <tr class="separator:a56f574c0f2e767e8e10a4977bbb2789a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a887bc8d5d19fdb6873625745a915a439 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439">Name</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a887bc8d5d19fdb6873625745a915a439 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the field as an interned string. For example "date", "title", "body", ... <a href="#a887bc8d5d19fdb6873625745a915a439"></a><br/></td></tr> |
| <tr class="separator:a887bc8d5d19fdb6873625745a915a439 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adaea4a14b9c96576da9171b41abff836 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#adaea4a14b9c96576da9171b41abff836">StringValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:adaea4a14b9c96576da9171b41abff836 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">The value of the field as a String, or null. For indexing, if isStored()==true, the stringValue() will be used as the stored field value unless isBinary()==true, in which case GetBinaryValue() will be used. <a href="#adaea4a14b9c96576da9171b41abff836"></a><br/></td></tr> |
| <tr class="separator:adaea4a14b9c96576da9171b41abff836 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1576df6ab1faed2ae00f4d0557bb2ce8 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">TextReader </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1576df6ab1faed2ae00f4d0557bb2ce8">ReaderValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1576df6ab1faed2ae00f4d0557bb2ce8 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">The value of the field as a Reader, which can be used at index time to generate indexed tokens. <a href="#a1576df6ab1faed2ae00f4d0557bb2ce8"></a><br/></td></tr> |
| <tr class="separator:a1576df6ab1faed2ae00f4d0557bb2ce8 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75e563b489559fbad505a4c6be4ebbeb inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a75e563b489559fbad505a4c6be4ebbeb">TokenStreamValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a75e563b489559fbad505a4c6be4ebbeb inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">The TokenStream for this field to be used when indexing, or null. <a href="#a75e563b489559fbad505a4c6be4ebbeb"></a><br/></td></tr> |
| <tr class="separator:a75e563b489559fbad505a4c6be4ebbeb inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae96b9ed1decb32a4fc56362855d9ce24 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#ae96b9ed1decb32a4fc56362855d9ce24">IsStored</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae96b9ed1decb32a4fc56362855d9ce24 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if the value of the field is to be stored in the index for return with search hits. <a href="#ae96b9ed1decb32a4fc56362855d9ce24"></a><br/></td></tr> |
| <tr class="separator:ae96b9ed1decb32a4fc56362855d9ce24 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d06afbb41d96935271f515185486894 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1d06afbb41d96935271f515185486894">IsIndexed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1d06afbb41d96935271f515185486894 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if the value of the field is to be indexed, so that it may be searched on. <a href="#a1d06afbb41d96935271f515185486894"></a><br/></td></tr> |
| <tr class="separator:a1d06afbb41d96935271f515185486894 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a759bc03b5d9691321bda270434e381f0 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a759bc03b5d9691321bda270434e381f0">IsTokenized</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a759bc03b5d9691321bda270434e381f0 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are indexed as a single word and may not be Reader-valued. <a href="#a759bc03b5d9691321bda270434e381f0"></a><br/></td></tr> |
| <tr class="separator:a759bc03b5d9691321bda270434e381f0 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e82d504152effe292572e6242c0ce16 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a4e82d504152effe292572e6242c0ce16">IsTermVectorStored</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4e82d504152effe292572e6242c0ce16 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if the term or terms used to index this field are stored as a term vector, available from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html#a93ef270cec13352696660ca154d4a1be" title="Return a term frequency vector for the specified document and field. The returned vector contains ter...">Lucene.Net.Index.IndexReader.GetTermFreqVector(int,String)</a>. These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the <code>stored</code> attribute instead. <a href="#a4e82d504152effe292572e6242c0ce16"></a><br/></td></tr> |
| <tr class="separator:a4e82d504152effe292572e6242c0ce16 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6dd87770d7fb1fe7f71a1b86af0f4cf5 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a6dd87770d7fb1fe7f71a1b86af0f4cf5">IsStoreOffsetWithTermVector</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6dd87770d7fb1fe7f71a1b86af0f4cf5 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if terms are stored as term vector together with their offsets (start and end positon in source text). <a href="#a6dd87770d7fb1fe7f71a1b86af0f4cf5"></a><br/></td></tr> |
| <tr class="separator:a6dd87770d7fb1fe7f71a1b86af0f4cf5 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3fe2ff23898c82339c83088fed82518a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a3fe2ff23898c82339c83088fed82518a">IsStorePositionWithTermVector</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a3fe2ff23898c82339c83088fed82518a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if terms are stored as term vector together with their token positions. <a href="#a3fe2ff23898c82339c83088fed82518a"></a><br/></td></tr> |
| <tr class="separator:a3fe2ff23898c82339c83088fed82518a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1f0b930c4cc0180629d70fb056a17316 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1f0b930c4cc0180629d70fb056a17316">IsBinary</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1f0b930c4cc0180629d70fb056a17316 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if the value of the field is stored as binary <a href="#a1f0b930c4cc0180629d70fb056a17316"></a><br/></td></tr> |
| <tr class="separator:a1f0b930c4cc0180629d70fb056a17316 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e9e11d2fe5ae37031d6a590042720b3 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1e9e11d2fe5ae37031d6a590042720b3">OmitNorms</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a1e9e11d2fe5ae37031d6a590042720b3 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if norms are omitted for this indexed field. <a href="#a1e9e11d2fe5ae37031d6a590042720b3"></a><br/></td></tr> |
| <tr class="separator:a1e9e11d2fe5ae37031d6a590042720b3 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad5c660c07e9defcf7cbcfbb93c18fa67 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#ad5c660c07e9defcf7cbcfbb93c18fa67">IsLazy</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ad5c660c07e9defcf7cbcfbb93c18fa67 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is Lazy or not. The semantics of Lazy loading are such that if a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is lazily loaded, retrieving it's values via StringValue() or GetBinaryValue() is only valid as long as the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html" title="IndexReader is an abstract class, providing an interface for accessing an index. Search of an index i...">Lucene.Net.Index.IndexReader</a> that retrieved the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is still open. <a href="#ad5c660c07e9defcf7cbcfbb93c18fa67"></a><br/></td></tr> |
| <tr class="separator:ad5c660c07e9defcf7cbcfbb93c18fa67 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a715d668bb08d334114912c605cbd3a87 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a715d668bb08d334114912c605cbd3a87">BinaryOffset</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a715d668bb08d334114912c605cbd3a87 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">Returns offset into byte[] segment that is used as value, if <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is not binary returned value is undefined <a href="#a715d668bb08d334114912c605cbd3a87"></a><br/></td></tr> |
| <tr class="separator:a715d668bb08d334114912c605cbd3a87 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1626e0013eb0d4b47adddc18b4b588f2 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1626e0013eb0d4b47adddc18b4b588f2">BinaryLength</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1626e0013eb0d4b47adddc18b4b588f2 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">Returns length of byte[] segment that is used as value, if <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is not binary returned value is undefined <a href="#a1626e0013eb0d4b47adddc18b4b588f2"></a><br/></td></tr> |
| <tr class="separator:a1626e0013eb0d4b47adddc18b4b588f2 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2b04a2db2455db84a38aa483b3d5f156 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a2b04a2db2455db84a38aa483b3d5f156">OmitTermFreqAndPositions</a><code> [get, set]</code></td></tr> |
| <tr class="separator:a2b04a2db2455db84a38aa483b3d5f156 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><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 field is a section of a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a>. Each field has two parts, a name and a value. Values may be free text, provided as a String or as a Reader, or they may be atomic keywords, which are not further processed. Such keywords may be used to represent dates, urls, etc. Fields are optionally stored in the index, so that they may be returned with hits on the document. </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00035">35</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| </div><h2 class="groupheader">Member Enumeration Documentation</h2> |
| <a class="anchor" id="a6da09f47bd62b150214f07404e03be47"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum Lucene.Net.Documents.Field.Index</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Specifies whether and how a field should be indexed. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a6da09f47bd62b150214f07404e03be47ac2f3f489a00553e7a01d369c103c7251"></a>NO</em> </td><td class="fielddoc"> |
| <p>Do not index the field value. This field can thus not be searched, but one can still access its contents provided it is <a class="el" href="">stored</a>. </p> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a6da09f47bd62b150214f07404e03be47a11bafc6149b3e73a290841caa2154a3d"></a>ANALYZED</em> </td><td class="fielddoc"> |
| <p><a class="el" href="namespace_lucene_1_1_net_1_1_index.html">Index</a> the tokens produced by running the field's value through an Analyzer. This is useful for common text. </p> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a6da09f47bd62b150214f07404e03be47a79e415ba75f00aaee941935b93efecd9"></a>NOT_ANALYZED</em> </td><td class="fielddoc"> |
| <p><a class="el" href="namespace_lucene_1_1_net_1_1_index.html">Index</a> the field's value without using an Analyzer, so it can be searched. As no analyzer is used the value will be stored as a single term. This is useful for unique Ids like product numbers. </p> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a6da09f47bd62b150214f07404e03be47a9e352cdf44c79dea8b83f66c1b20f2e3"></a>NOT_ANALYZED_NO_NORMS</em> </td><td class="fielddoc"> |
| <p>Expert: <a class="el" href="namespace_lucene_1_1_net_1_1_index.html">Index</a> the field's value without an Analyzer, and also disable the storing of norms. Note that you can also separately enable/disable norms by setting AbstractField.OmitNorms. No norms means that index-time field and document boosting and field length normalization are disabled. The benefit is less memory usage as norms take up one byte of RAM per indexed field for every document in the index, during searching. Note that once you index a given field <em>with</em> norms enabled, disabling norms will have no effect. In other words, for this to have the above described effect on a field, all instances of that field must be indexed with NOT_ANALYZED_NO_NORMS from the beginning. </p> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a6da09f47bd62b150214f07404e03be47a1ff027332258c6df510eaa5f5e97b483"></a>ANALYZED_NO_NORMS</em> </td><td class="fielddoc"> |
| <p>Expert: <a class="el" href="namespace_lucene_1_1_net_1_1_index.html">Index</a> the tokens produced by running the field's value through an Analyzer, and also separately disable the storing of norms. See NOT_ANALYZED_NO_NORMS for what norms are and why you may want to disable them. </p> |
| </td></tr> |
| </table> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00053">53</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa200dd8593e5a9caf29bb3380df5b4ad"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum Lucene.Net.Documents.Field.Store</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Specifies whether and how a field should be stored. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="aa200dd8593e5a9caf29bb3380df5b4ada7469a286259799e5b37e5db9296f00b3"></a>YES</em> </td><td class="fielddoc"> |
| <p><a class="el" href="namespace_lucene_1_1_net_1_1_store.html">Store</a> the original field value in the index. This is useful for short texts like a document's title which should be displayed with the results. The value is stored in its original form, i.e. no analyzer is used before it is stored. </p> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="aa200dd8593e5a9caf29bb3380df5b4adac2f3f489a00553e7a01d369c103c7251"></a>NO</em> </td><td class="fielddoc"> |
| <p>Do not store the field value in the index. </p> |
| </td></tr> |
| </table> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00038">38</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3b16afc1c9c84681505db09934edd40e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum Lucene.Net.Documents.Field.TermVector</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Specifies whether and how a field should have term vectors. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a3b16afc1c9c84681505db09934edd40eac2f3f489a00553e7a01d369c103c7251"></a>NO</em> </td><td class="fielddoc"> |
| <p>Do not store term vectors. </p> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a3b16afc1c9c84681505db09934edd40ea7469a286259799e5b37e5db9296f00b3"></a>YES</em> </td><td class="fielddoc"> |
| <p><a class="el" href="namespace_lucene_1_1_net_1_1_store.html">Store</a> the term vectors of each document. A term vector is a list of the document's terms and their number of occurrences in that document. </p> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a3b16afc1c9c84681505db09934edd40ea7ddcb0bf12bb332be4a2264e68ce876c"></a>WITH_POSITIONS</em> </td><td class="fielddoc"> |
| <p><a class="el" href="namespace_lucene_1_1_net_1_1_store.html">Store</a> the term vector + token position information </p> |
| <dl class="section see"><dt>See Also</dt><dd>YES</dd></dl> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a3b16afc1c9c84681505db09934edd40ea0594f9fbbd396c253ec42c44a000b331"></a>WITH_OFFSETS</em> </td><td class="fielddoc"> |
| <p><a class="el" href="namespace_lucene_1_1_net_1_1_store.html">Store</a> the term vector + Token offset information </p> |
| <dl class="section see"><dt>See Also</dt><dd>YES</dd></dl> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a3b16afc1c9c84681505db09934edd40ea54b2cad1837b9a5b85a158e4d31b1d21"></a>WITH_POSITIONS_OFFSETS</em> </td><td class="fielddoc"> |
| <p><a class="el" href="namespace_lucene_1_1_net_1_1_store.html">Store</a> the term vector + Token position and offset information </p> |
| <dl class="section see"><dt>See Also</dt><dd>YES</dd></dl> |
| <dl class="section see"><dt>See Also</dt><dd>WITH_POSITIONS</dd></dl> |
| <dl class="section see"><dt>See Also</dt><dd>WITH_OFFSETS</dd></dl> |
| </td></tr> |
| </table> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00100">100</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a6806fd35d105d14b3a2b8fb40a7dfe67"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.Field.Field </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>value</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> </td> |
| <td class="paramname"><em>store</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47">Index</a> </td> |
| <td class="paramname"><em>index</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a field by specifying its name, value and how it will be saved in the index. Term vectors will not be stored in the index. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the field </td></tr> |
| <tr><td class="paramname">value</td><td>The string to process </td></tr> |
| <tr><td class="paramname">store</td><td>Whether <code>value</code> should be stored in the index </td></tr> |
| <tr><td class="paramname">index</td><td>Whether the field should be indexed, and if so, if it should be tokenized before indexing </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> NullPointerException if name or value is <code>null</code> </throws> <throws> IllegalArgumentException if the field is neither stored nor indexed </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00248">248</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abb2d635c30101749c77eb050ccc45f18"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.Field.Field </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>value</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> </td> |
| <td class="paramname"><em>store</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47">Index</a> </td> |
| <td class="paramname"><em>index</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40e">TermVector</a> </td> |
| <td class="paramname"><em>termVector</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a field by specifying its name, value and how it will be saved in the index. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the field </td></tr> |
| <tr><td class="paramname">value</td><td>The string to process </td></tr> |
| <tr><td class="paramname">store</td><td>Whether <code>value</code> should be stored in the index </td></tr> |
| <tr><td class="paramname">index</td><td>Whether the field should be indexed, and if so, if it should be tokenized before indexing </td></tr> |
| <tr><td class="paramname">termVector</td><td>Whether term vector should be stored </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> NullPointerException if name or value is <code>null</code> </throws> <throws> IllegalArgumentException in any of the following situations: </throws> </p> |
| <ul> |
| <li> |
| the field is neither stored nor indexed </li> |
| <li> |
| the field is not indexed but termVector is <code>TermVector.YES</code> </li> |
| </ul> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00275">275</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1e101116eaa1bb7abbeebf2b0e731135"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.Field.Field </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>internName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>value</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> </td> |
| <td class="paramname"><em>store</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a6da09f47bd62b150214f07404e03be47">Index</a> </td> |
| <td class="paramname"><em>index</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40e">TermVector</a> </td> |
| <td class="paramname"><em>termVector</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a field by specifying its name, value and how it will be saved in the index. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the field </td></tr> |
| <tr><td class="paramname">internName</td><td>Whether to .intern() name or not </td></tr> |
| <tr><td class="paramname">value</td><td>The string to process </td></tr> |
| <tr><td class="paramname">store</td><td>Whether <code>value</code> should be stored in the index </td></tr> |
| <tr><td class="paramname">index</td><td>Whether the field should be indexed, and if so, if it should be tokenized before indexing </td></tr> |
| <tr><td class="paramname">termVector</td><td>Whether term vector should be stored </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> NullPointerException if name or value is <code>null</code> </throws> <throws> IllegalArgumentException in any of the following situations: </throws> </p> |
| <ul> |
| <li> |
| the field is neither stored nor indexed </li> |
| <li> |
| the field is not indexed but termVector is <code>TermVector.YES</code> </li> |
| </ul> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00304">304</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9daed22a6dee78c30d0f0d81f74d3357"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.Field.Field </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.IO.TextReader </td> |
| <td class="paramname"><em>reader</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a tokenized and indexed field that is not stored. Term vectors will not be stored. The Reader is read only when the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is added to the index, i.e. you may not close the Reader until IndexWriter.AddDocument(Document) has been called. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the field </td></tr> |
| <tr><td class="paramname">reader</td><td>The reader with the content </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> NullPointerException if name or reader is <code>null</code> </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00352">352</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="afea87c06a30e9f6d5de5485d57935928"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.Field.Field </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.IO.TextReader </td> |
| <td class="paramname"><em>reader</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40e">TermVector</a> </td> |
| <td class="paramname"><em>termVector</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a tokenized and indexed field that is not stored, optionally with storing term vectors. The Reader is read only when the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is added to the index, i.e. you may not close the Reader until IndexWriter.AddDocument(Document) has been called. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the field </td></tr> |
| <tr><td class="paramname">reader</td><td>The reader with the content </td></tr> |
| <tr><td class="paramname">termVector</td><td>Whether term vector should be stored </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> NullPointerException if name or reader is <code>null</code> </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00369">369</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0cabd0537b001b85d1d5eec732329ce8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.Field.Field </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> </td> |
| <td class="paramname"><em>tokenStream</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a tokenized and indexed field that is not stored. Term vectors will not be stored. This is useful for pre-analyzed fields. The TokenStream is read only when the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is added to the index, i.e. you may not close the TokenStream until IndexWriter.AddDocument(Document) has been called. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the field </td></tr> |
| <tr><td class="paramname">tokenStream</td><td>The TokenStream with the content </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> NullPointerException if name or tokenStream is <code>null</code> </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00401">401</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a82fd8802c6418c2a570279eb1ac30d7e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.Field.Field </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> </td> |
| <td class="paramname"><em>tokenStream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#a3b16afc1c9c84681505db09934edd40e">TermVector</a> </td> |
| <td class="paramname"><em>termVector</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a tokenized and indexed field that is not stored, optionally with storing term vectors. This is useful for pre-analyzed fields. The TokenStream is read only when the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is added to the index, i.e. you may not close the TokenStream until IndexWriter.AddDocument(Document) has been called. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the field </td></tr> |
| <tr><td class="paramname">tokenStream</td><td>The TokenStream with the content </td></tr> |
| <tr><td class="paramname">termVector</td><td>Whether term vector should be stored </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> NullPointerException if name or tokenStream is <code>null</code> </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00419">419</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="affde6da3d2e21f52d1d9b6602cfb294b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.Field.Field </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>value_Renamed</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> </td> |
| <td class="paramname"><em>store</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a stored field with binary value. Optionally the value may be compressed. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the field </td></tr> |
| <tr><td class="paramname">value_Renamed</td><td>The binary value </td></tr> |
| <tr><td class="paramname">store</td><td>How <code>value</code> should be stored (compressed or not) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> IllegalArgumentException if store is <code>Store.NO</code> </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00451">451</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abb95f75536067bd5ea7bb5befcd22b79"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.Field.Field </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>value_Renamed</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 class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html#aa200dd8593e5a9caf29bb3380df5b4ad">Store</a> </td> |
| <td class="paramname"><em>store</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a stored field with binary value. Optionally the value may be compressed. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>The name of the field </td></tr> |
| <tr><td class="paramname">value_Renamed</td><td>The binary value </td></tr> |
| <tr><td class="paramname">offset</td><td>Starting offset in value where this <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a>'s bytes are </td></tr> |
| <tr><td class="paramname">length</td><td>Number of bytes to use for this <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a>, starting at offset </td></tr> |
| <tr><td class="paramname">store</td><td>How <code>value</code> should be stored (compressed or not) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> IllegalArgumentException if store is <code>Store.NO</code> </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00469">469</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a9ba35709a6518d82ef7552c1fe3bc896"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Documents.Field.SetTokenStream </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> </td> |
| <td class="paramname"><em>tokenStream</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Expert: sets the token stream to be used for indexing and causes isIndexed() and isTokenized() to return true. May be combined with stored values from stringValue() or GetBinaryValue() </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00226">226</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa8b8851f8ce109c25a0c5e9f3aeb3077"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Documents.Field.SetValue </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Expert: change the value of this field. This can be used during indexing to re-use a single <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> instance to improve indexing speed by avoiding GC cost of new'ing and reclaiming <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> instances. Typically a single <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> instance is re-used as well. This helps most on small documents.</p> |
| <p>Each <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> instance should only be used once within a single <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> instance. See <a href="http://wiki.apache.org/lucene-java/ImproveIndexingSpeed">ImproveIndexingSpeed</a> for details.</p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00176">176</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4f6aca573c2bcf046307041016c6d65f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Documents.Field.SetValue </td> |
| <td>(</td> |
| <td class="paramtype">System.IO.TextReader </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Expert: change the value of this field. See <a href="#setValue(java.lang.String)">setValue(String)</a>. </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00186">186</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac0024427761fc7c8782cda7c812790f3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Documents.Field.SetValue </td> |
| <td>(</td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Expert: change the value of this field. See <a href="#setValue(java.lang.String)">setValue(String)</a>. </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00200">200</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2bdfe6a8450d1e32fc35566bbf243d8c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Documents.Field.SetValue </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> |
| </div><div class="memdoc"> |
| |
| <p>Expert: change the value of this field. See <a href="#setValue(java.lang.String)">setValue(String)</a>. </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00212">212</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a5a05f633b3cc24610ab4924f585b306f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override TextReader Lucene.Net.Documents.Field.ReaderValue</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>The value of the field as a Reader, or null. If null, the String value or binary value is used. Exactly one of stringValue(), readerValue(), and getBinaryValue() must be set. </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00151">151</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abe014bfc3a4421dec2cc63d3c37555af"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override string Lucene.Net.Documents.Field.StringValue</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>The value of the field as a String, or null. If null, the Reader value or binary value is used. Exactly one of stringValue(), readerValue(), and getBinaryValue() must be set. </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00142">142</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6d1244ea637f48640c365b7641238ad6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override <a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> Lucene.Net.Documents.Field.TokenStreamValue</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>The TokesStream for this field to be used when indexing, or null. If null, the Reader value or String value is analyzed to produce the indexed tokens. </p> |
| |
| <p>Definition at line <a class="el" href="_field_8cs_source.html#l00159">159</a> of file <a class="el" href="_field_8cs_source.html">Field.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Document/<a class="el" href="_field_8cs_source.html">Field.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> |
