| <!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.IFieldable Interface 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="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">IFieldable</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Documents.IFieldable Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Synonymous with <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>. |
| <a href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#details">More...</a></p> |
| |
| <p>Inherited by <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="class_lucene_1_1_net_1_1_documents_1_1_field.html">Lucene.Net.Documents.Field</a>.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a1dc9e02aaec54ab33b827ccf60b7c116"><td class="memItemLeft" align="right" valign="top">byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1dc9e02aaec54ab33b827ccf60b7c116">GetBinaryValue</a> ()</td></tr> |
| <tr class="memdesc:a1dc9e02aaec54ab33b827ccf60b7c116"><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="#a1dc9e02aaec54ab33b827ccf60b7c116"></a><br/></td></tr> |
| <tr class="separator:a1dc9e02aaec54ab33b827ccf60b7c116"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9f4b536bdce466cfccf889d18410cecb"><td class="memItemLeft" align="right" valign="top">byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a9f4b536bdce466cfccf889d18410cecb">GetBinaryValue</a> (byte[] result)</td></tr> |
| <tr class="memdesc:a9f4b536bdce466cfccf889d18410cecb"><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="#a9f4b536bdce466cfccf889d18410cecb"></a><br/></td></tr> |
| <tr class="separator:a9f4b536bdce466cfccf889d18410cecb"><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:a56f574c0f2e767e8e10a4977bbb2789a"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a887bc8d5d19fdb6873625745a915a439"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adaea4a14b9c96576da9171b41abff836"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1576df6ab1faed2ae00f4d0557bb2ce8"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75e563b489559fbad505a4c6be4ebbeb"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae96b9ed1decb32a4fc56362855d9ce24"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d06afbb41d96935271f515185486894"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a759bc03b5d9691321bda270434e381f0"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e82d504152effe292572e6242c0ce16"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6dd87770d7fb1fe7f71a1b86af0f4cf5"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3fe2ff23898c82339c83088fed82518a"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1f0b930c4cc0180629d70fb056a17316"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e9e11d2fe5ae37031d6a590042720b3"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad5c660c07e9defcf7cbcfbb93c18fa67"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a715d668bb08d334114912c605cbd3a87"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1626e0013eb0d4b47adddc18b4b588f2"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2b04a2db2455db84a38aa483b3d5f156"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Synonymous with <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>. </p> |
| <p><bold>WARNING</bold>: This interface may change within minor versions, despite <a class="el" href="namespace_lucene.html">Lucene</a>'s backward compatibility requirements. This means new methods may be added from version to version. This change only affects the Fieldable API; other backwards compatibility promises remain intact. For example, <a class="el" href="namespace_lucene.html">Lucene</a> can still read and write indices created within the same major version. </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00035">35</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a1dc9e02aaec54ab33b827ccf60b7c116"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">byte [] Lucene.Net.Documents.IFieldable.GetBinaryValue </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <dl class="section return"><dt>Returns</dt><dd>reference to the <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> value as byte[]. </dd></dl> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a6a26a474ae6cad038f7d84ffe46a240e">Lucene.Net.Documents.AbstractField</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9f4b536bdce466cfccf889d18410cecb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">byte [] Lucene.Net.Documents.IFieldable.GetBinaryValue </td> |
| <td>(</td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>result</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">result</td><td>User defined buffer that will be used if possible. If this is null or not large enough, a new buffer is allocated </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>reference to the <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> value as byte[]. </dd></dl> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#a298b1411e72ac28c5c447434f63b85af">Lucene.Net.Documents.NumericField</a>, and <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a283237239676dd08a85b564a373c19ee">Lucene.Net.Documents.AbstractField</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a1626e0013eb0d4b47adddc18b4b588f2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Documents.IFieldable.BinaryLength</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns 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 </p> |
| <p>length of byte[] segment that represents 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> value </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00161">161</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a715d668bb08d334114912c605cbd3a87"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Documents.IFieldable.BinaryOffset</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns 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 </p> |
| <p>index of the first character in byte[] segment that represents 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> value </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00155">155</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a56f574c0f2e767e8e10a4977bbb2789a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">float Lucene.Net.Documents.IFieldable.Boost</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| <p>The boost is multiplied by Lucene.Net.Documents.Document.Boost of the document containing this field. If a document has multiple fields with the same name, all such values are multiplied together. This product is then used to compute the norm factor for the field. By default, in the Lucene.Net.Search.Similarity.ComputeNorm(String,Lucene.Net.Index.FieldInvertState) method, the boost value is multiplied by the Lucene.Net.Search.Similarity.LengthNorm(String,int) and then rounded by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#abb8c94a5e3079a47004af1bf117af1de" title="Encodes a normalization factor for storage in an index.">Lucene.Net.Search.Similarity.EncodeNorm(float)</a> before it is stored in the index. One should attempt to ensure that this product does not overflow the range of that encoding.</p> |
| <p>The default value is 1.0.</p> |
| <p>Note: this value is not stored directly with the document in the index. <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html">Documents</a> returned from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html#ae5a8698ada40868908ea27f502337ee2" title="Returns the stored fields of the nth Document in this index. NOTE: for performance reasons...">Lucene.Net.Index.IndexReader.Document(int)</a> and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_searcher.html#a9d0023e8f18632fe0709e9c40155dbca" title="Expert: Returns the stored fields of document i.">Lucene.Net.Search.Searcher.Doc(int)</a> may thus not have the same value present as when this field was indexed.</p> |
| <dl class="section see"><dt>See Also</dt><dd>Lucene.Net.Documents.Document.Boost</dd></dl> |
| <dl class="section see"><dt>See Also</dt><dd>Lucene.Net.Search.Similarity.ComputeNorm(String, FieldInvertState)</dd></dl> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_similarity.html#abb8c94a5e3079a47004af1bf117af1de" title="Encodes a normalization factor for storage in an index.">Lucene.Net.Search.Similarity.EncodeNorm(float)</a></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00066">66</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1f0b930c4cc0180629d70fb056a17316"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Documents.IFieldable.IsBinary</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>True if the value of the field is stored as binary </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00130">130</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1d06afbb41d96935271f515185486894"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Documents.IFieldable.IsIndexed</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>True if the value of the field is to be indexed, so that it may be searched on. </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00102">102</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad5c660c07e9defcf7cbcfbb93c18fa67"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Documents.IFieldable.IsLazy</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>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. </p> |
| <p>true if this field can be loaded lazily </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00149">149</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae96b9ed1decb32a4fc56362855d9ce24"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Documents.IFieldable.IsStored</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>True if the value of the field is to be stored in the index for return with search hits. </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00097">97</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6dd87770d7fb1fe7f71a1b86af0f4cf5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Documents.IFieldable.IsStoreOffsetWithTermVector</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>True if terms are stored as term vector together with their offsets (start and end positon in source text). </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00124">124</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3fe2ff23898c82339c83088fed82518a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Documents.IFieldable.IsStorePositionWithTermVector</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>True if terms are stored as term vector together with their token positions.</p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00127">127</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4e82d504152effe292572e6242c0ce16"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Documents.IFieldable.IsTermVectorStored</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>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. </p> |
| <dl class="section see"><dt>See Also</dt><dd><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></dd></dl> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00119">119</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a759bc03b5d9691321bda270434e381f0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Documents.IFieldable.IsTokenized</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>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. </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00108">108</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a887bc8d5d19fdb6873625745a915a439"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Lucene.Net.Documents.IFieldable.Name</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the name of the field as an interned string. For example "date", "title", "body", ... </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00071">71</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1e9e11d2fe5ae37031d6a590042720b3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Documents.IFieldable.OmitNorms</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>True if norms are omitted for this indexed field. </p> |
| <p>Expert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field. </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00140">140</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2b04a2db2455db84a38aa483b3d5f156"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Documents.IFieldable.OmitTermFreqAndPositions</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Expert: </p> |
| <p>If set, omit term freq, positions and payloads from postings for this field. </p> |
| <p><b>NOTE</b>: While this option reduces storage space required in the index, it also means any query requiring positional information, such as <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_query.html" title="A Query that matches documents containing a particular sequence of terms. A PhraseQuery is built by Q...">Lucene.Net.Search.PhraseQuery</a> or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_query.html" title="Base class for span-based queries. ">Lucene.Net.Search.Spans.SpanQuery</a> subclasses will silently fail to find results. </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00203">203</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1576df6ab1faed2ae00f4d0557bb2ce8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">TextReader Lucene.Net.Documents.IFieldable.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, which can be used at index time to generate indexed tokens.</p> |
| <dl class="section see"><dt>See Also</dt><dd>StringValue()</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00087">87</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="adaea4a14b9c96576da9171b41abff836"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string Lucene.Net.Documents.IFieldable.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. 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. </p> |
| <p>If isIndexed()==true and isTokenized()==false, this String value will be indexed as a single token. If isIndexed()==true and isTokenized()==true, then tokenStreamValue() will be used to generate indexed tokens if not null, else readerValue() will be used to generate indexed tokens if not null, else stringValue() will be used to generate tokens. </p> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00082">82</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a75e563b489559fbad505a4c6be4ebbeb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> Lucene.Net.Documents.IFieldable.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 TokenStream for this field to be used when indexing, or null.</p> |
| <dl class="section see"><dt>See Also</dt><dd>StringValue()</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_fieldable_8cs_source.html#l00092">92</a> of file <a class="el" href="_fieldable_8cs_source.html">Fieldable.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>core/Document/<a class="el" href="_fieldable_8cs_source.html">Fieldable.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> |
