| <!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.AbstractField 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_abstract_field.html">AbstractField</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Documents.AbstractField Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p> |
| <a href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">Lucene.Net.Documents.IFieldable</a>.</p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Lucene.Net.Documents.Field</a>, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html">Lucene.Net.Documents.NumericField</a>, and Lucene.Net.Index.FieldsReader.LazyField.</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:a6a26a474ae6cad038f7d84ffe46a240e"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a283237239676dd08a85b564a373c19ee"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab141ef90189048a687a090df77620525"><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"><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"><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:a12c43f4e1ba848fa13a2fb8e6390ff97"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac6304298a279ee813a8e0166dbe94a51"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6c53bd9ec7c9b337d16a2cf4153be008"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a54dba90afdf044e3973b13eee7aae9ce"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad3d8927a7ed80379a04a640cf16d0cb0"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6636184a8406651116d0fc0efdd40fc3"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ce93e5a91e5453c763e58e1f90aeba8"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96ab5a0c57151bd3d1af5db445a15b1f"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afd9b57737df4ceb6ca96fab4b5a4e602"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a36150c4089413d9ad15441c9901a2846"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a20c57d26c1976513b3faf4c966e2312b"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a176db64e8f17090893b4efda2bd1f9f8"><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"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa95603c64c05d7fc1dba83b6ea452f6e"><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"><td class="mdescLeft"> </td><td class="mdescRight">Expert: <a href="#aa95603c64c05d7fc1dba83b6ea452f6e"></a><br/></td></tr> |
| <tr class="separator:aa95603c64c05d7fc1dba83b6ea452f6e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a722b0b487c0b6be77f49bcd4dc435cbf"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab539f4526a717604c66f3313fb356df2"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab4c7cfe8281f7faf88979f0c16289c57"><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"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acf676d7940f1a9bfad035f1220ec595f"><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"><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>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00032">32</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a6a26a474ae6cad038f7d84ffe46a240e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual byte [] Lucene.Net.Documents.AbstractField.GetBinaryValue </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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>Implements <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1dc9e02aaec54ab33b827ccf60b7c116">Lucene.Net.Documents.IFieldable</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00172">172</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a283237239676dd08a85b564a373c19ee"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual byte [] Lucene.Net.Documents.AbstractField.GetBinaryValue </td> |
| <td>(</td> |
| <td class="paramtype">byte[] </td> |
| <td class="paramname"><em>result</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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>Implements <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a9f4b536bdce466cfccf889d18410cecb">Lucene.Net.Documents.IFieldable</a>.</p> |
| |
| <p>Reimplemented in <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#a298b1411e72ac28c5c447434f63b85af">Lucene.Net.Documents.NumericField</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00177">177</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab141ef90189048a687a090df77620525"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Documents.AbstractField.ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>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. </p> |
| |
| <p>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00240">240</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a36150c4089413d9ad15441c9901a2846"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual int Lucene.Net.Documents.AbstractField.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="_abstract_field_8cs_source.html#l00190">190</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a20c57d26c1976513b3faf4c966e2312b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual int Lucene.Net.Documents.AbstractField.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="_abstract_field_8cs_source.html#l00206">206</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a12c43f4e1ba848fa13a2fb8e6390ff97"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual float Lucene.Net.Documents.AbstractField.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. </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> |
| |
| <p>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00085">85</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="afd9b57737df4ceb6ca96fab4b5a4e602"></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.AbstractField.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 iff the value of the filed is stored as binary </p> |
| |
| <p>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00161">161</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a54dba90afdf044e3973b13eee7aae9ce"></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.AbstractField.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 iff 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="_abstract_field_8cs_source.html#l00118">118</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a722b0b487c0b6be77f49bcd4dc435cbf"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Lucene.Net.Documents.AbstractField.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>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00235">235</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6c53bd9ec7c9b337d16a2cf4153be008"></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.AbstractField.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 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. </p> |
| |
| <p>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00110">110</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4ce93e5a91e5453c763e58e1f90aeba8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Lucene.Net.Documents.AbstractField.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 iff terms are stored as term vector together with their offsets (start and end position in source text). </p> |
| |
| <p>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00149">149</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a96ab5a0c57151bd3d1af5db445a15b1f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Lucene.Net.Documents.AbstractField.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 iff terms are stored as term vector together with their token positions.</p> |
| |
| <p>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00155">155</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6636184a8406651116d0fc0efdd40fc3"></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.AbstractField.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 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. </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="_abstract_field_8cs_source.html#l00141">141</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad3d8927a7ed80379a04a640cf16d0cb0"></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.AbstractField.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 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. </p> |
| |
| <p>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00127">127</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac6304298a279ee813a8e0166dbe94a51"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual string Lucene.Net.Documents.AbstractField.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="_abstract_field_8cs_source.html#l00094">94</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a176db64e8f17090893b4efda2bd1f9f8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Lucene.Net.Documents.AbstractField.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>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00212">212</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa95603c64c05d7fc1dba83b6ea452f6e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Lucene.Net.Documents.AbstractField.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="_payload_span_util_8cs.html#a945cd0e79343408e87508a19920e3941">PhraseQuery</a> or <a class="el" href="_span_query_filter_8cs.html#acc785bedc86fa99fa13c32eaf059baab">SpanQuery</a> subclasses will silently fail to find results. </p> |
| |
| <p>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00229">229</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab4c7cfe8281f7faf88979f0c16289c57"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract TextReader Lucene.Net.Documents.AbstractField.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>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00309">309</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acf676d7940f1a9bfad035f1220ec595f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract string Lucene.Net.Documents.AbstractField.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>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00310">310</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab539f4526a717604c66f3313fb356df2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract <a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> Lucene.Net.Documents.AbstractField.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>Definition at line <a class="el" href="_abstract_field_8cs_source.html#l00308">308</a> of file <a class="el" href="_abstract_field_8cs_source.html">AbstractField.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="_abstract_field_8cs_source.html">AbstractField.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> |
