| <!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.NumericField 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_numeric_field.html">NumericField</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_numeric_field-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Documents.NumericField Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>This class provides 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> that enables indexing of numeric values for efficient range filtering and sorting. Here's an example usage, adding an int value: |
| <a href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html">Lucene.Net.Documents.AbstractField</a>.</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:ae67c91b81edbcf343cb18f94f9500499"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#ae67c91b81edbcf343cb18f94f9500499">NumericField</a> (System.String name)</td></tr> |
| <tr class="memdesc:ae67c91b81edbcf343cb18f94f9500499"><td class="mdescLeft"> </td><td class="mdescRight">Creates a field for numeric values using the default <code>precisionStep</code> NumericUtils.PRECISION_STEP_DEFAULT (4). The instance is not yet initialized with a numeric value, before indexing a document containing this field, set a value using the various set<em>???</em>Value() methods. This constructor creates an indexed, but not stored field. <a href="#ae67c91b81edbcf343cb18f94f9500499"></a><br/></td></tr> |
| <tr class="separator:ae67c91b81edbcf343cb18f94f9500499"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6c5b26e2051877d5efbb34fa5e528ba9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#a6c5b26e2051877d5efbb34fa5e528ba9">NumericField</a> (System.String name, Field.Store store, bool index)</td></tr> |
| <tr class="memdesc:a6c5b26e2051877d5efbb34fa5e528ba9"><td class="mdescLeft"> </td><td class="mdescRight">Creates a field for numeric values using the default <code>precisionStep</code> NumericUtils.PRECISION_STEP_DEFAULT (4). The instance is not yet initialized with a numeric value, before indexing a document containing this field, set a value using the various set<em>???</em>Value() methods. <a href="#a6c5b26e2051877d5efbb34fa5e528ba9"></a><br/></td></tr> |
| <tr class="separator:a6c5b26e2051877d5efbb34fa5e528ba9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af1cdbd742275b546f9bf5c0c553c3c35"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#af1cdbd742275b546f9bf5c0c553c3c35">NumericField</a> (System.String name, int precisionStep)</td></tr> |
| <tr class="memdesc:af1cdbd742275b546f9bf5c0c553c3c35"><td class="mdescLeft"> </td><td class="mdescRight">Creates a field for numeric values with the specified <code>precisionStep</code>. The instance is not yet initialized with a numeric value, before indexing a document containing this field, set a value using the various set<em>???</em>Value() methods. This constructor creates an indexed, but not stored field. <a href="#af1cdbd742275b546f9bf5c0c553c3c35"></a><br/></td></tr> |
| <tr class="separator:af1cdbd742275b546f9bf5c0c553c3c35"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adff48b3d939e94390f084618b9a03829"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#adff48b3d939e94390f084618b9a03829">NumericField</a> (System.String name, int precisionStep, Field.Store store, bool index)</td></tr> |
| <tr class="memdesc:adff48b3d939e94390f084618b9a03829"><td class="mdescLeft"> </td><td class="mdescRight">Creates a field for numeric values with the specified <code>precisionStep</code>. The instance is not yet initialized with a numeric value, before indexing a document containing this field, set a value using the various set<em>???</em>Value() methods. <a href="#adff48b3d939e94390f084618b9a03829"></a><br/></td></tr> |
| <tr class="separator:adff48b3d939e94390f084618b9a03829"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a298b1411e72ac28c5c447434f63b85af"><td class="memItemLeft" align="right" valign="top">override byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#a298b1411e72ac28c5c447434f63b85af">GetBinaryValue</a> (byte[] result)</td></tr> |
| <tr class="memdesc:a298b1411e72ac28c5c447434f63b85af"><td class="mdescLeft"> </td><td class="mdescRight">Returns always <code>null</code> for numeric fields <a href="#a298b1411e72ac28c5c447434f63b85af"></a><br/></td></tr> |
| <tr class="separator:a298b1411e72ac28c5c447434f63b85af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a368bf0958d4c7db50b2d625518a85804"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html">NumericField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#a368bf0958d4c7db50b2d625518a85804">SetLongValue</a> (long value_Renamed)</td></tr> |
| <tr class="memdesc:a368bf0958d4c7db50b2d625518a85804"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the field with the supplied <code>long</code> value. <a href="#a368bf0958d4c7db50b2d625518a85804"></a><br/></td></tr> |
| <tr class="separator:a368bf0958d4c7db50b2d625518a85804"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2634e45e55bc134cd7a5651843c776b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html">NumericField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#a2634e45e55bc134cd7a5651843c776b9">SetIntValue</a> (int value_Renamed)</td></tr> |
| <tr class="memdesc:a2634e45e55bc134cd7a5651843c776b9"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the field with the supplied <code>int</code> value. <a href="#a2634e45e55bc134cd7a5651843c776b9"></a><br/></td></tr> |
| <tr class="separator:a2634e45e55bc134cd7a5651843c776b9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5ed9256e6b1e6db3c83db64a51e5a736"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html">NumericField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#a5ed9256e6b1e6db3c83db64a51e5a736">SetDoubleValue</a> (double value_Renamed)</td></tr> |
| <tr class="memdesc:a5ed9256e6b1e6db3c83db64a51e5a736"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the field with the supplied <code>double</code> value. <a href="#a5ed9256e6b1e6db3c83db64a51e5a736"></a><br/></td></tr> |
| <tr class="separator:a5ed9256e6b1e6db3c83db64a51e5a736"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0e3016a6a8373633e49ac3059bebf31c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html">NumericField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#a0e3016a6a8373633e49ac3059bebf31c">SetFloatValue</a> (float value_Renamed)</td></tr> |
| <tr class="memdesc:a0e3016a6a8373633e49ac3059bebf31c"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the field with the supplied <code>float</code> value. <a href="#a0e3016a6a8373633e49ac3059bebf31c"></a><br/></td></tr> |
| <tr class="separator:a0e3016a6a8373633e49ac3059bebf31c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html">Lucene.Net.Documents.AbstractField</a></td></tr> |
| <tr class="memitem:a6a26a474ae6cad038f7d84ffe46a240e inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual byte[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a6a26a474ae6cad038f7d84ffe46a240e">GetBinaryValue</a> ()</td></tr> |
| <tr class="memdesc:a6a26a474ae6cad038f7d84ffe46a240e inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Return the raw byte[] for the binary field. Note that you must also call BinaryLength and BinaryOffset to know which range of bytes in this returned array belong to the field. <a href="#a6a26a474ae6cad038f7d84ffe46a240e"></a><br/></td></tr> |
| <tr class="separator:a6a26a474ae6cad038f7d84ffe46a240e inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab141ef90189048a687a090df77620525 inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#ab141ef90189048a687a090df77620525">ToString</a> ()</td></tr> |
| <tr class="memdesc:ab141ef90189048a687a090df77620525 inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Prints a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> for human consumption. <a href="#ab141ef90189048a687a090df77620525"></a><br/></td></tr> |
| <tr class="separator:ab141ef90189048a687a090df77620525 inherit pub_methods_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a3610f92c08eec7e0a568969d1205448e"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#a3610f92c08eec7e0a568969d1205448e">TokenStreamValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a3610f92c08eec7e0a568969d1205448e"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="_numeric_utils_8cs.html#ab25a5cea67a38594cfddfac92e18554e">NumericTokenStream</a> for indexing the numeric value. <a href="#a3610f92c08eec7e0a568969d1205448e"></a><br/></td></tr> |
| <tr class="separator:a3610f92c08eec7e0a568969d1205448e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af8e1ab19e92068224c52849ebe7bed43"><td class="memItemLeft" align="right" valign="top">override TextReader </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#af8e1ab19e92068224c52849ebe7bed43">ReaderValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af8e1ab19e92068224c52849ebe7bed43"><td class="mdescLeft"> </td><td class="mdescRight">Returns always <code>null</code> for numeric fields <a href="#af8e1ab19e92068224c52849ebe7bed43"></a><br/></td></tr> |
| <tr class="separator:af8e1ab19e92068224c52849ebe7bed43"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac9297d23dacf6f18db8707c878da90f1"><td class="memItemLeft" align="right" valign="top">override string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#ac9297d23dacf6f18db8707c878da90f1">StringValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac9297d23dacf6f18db8707c878da90f1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the numeric value as a string (how it is stored, when Field.Store.YES is chosen). <a href="#ac9297d23dacf6f18db8707c878da90f1"></a><br/></td></tr> |
| <tr class="separator:ac9297d23dacf6f18db8707c878da90f1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a00d8f30fc3cf9e441af908a38d46b608"><td class="memItemLeft" align="right" valign="top">ValueType </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html#a00d8f30fc3cf9e441af908a38d46b608">NumericValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a00d8f30fc3cf9e441af908a38d46b608"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current numeric value as a subclass of Number, <code>null</code> if not yet initialized. <a href="#a00d8f30fc3cf9e441af908a38d46b608"></a><br/></td></tr> |
| <tr class="separator:a00d8f30fc3cf9e441af908a38d46b608"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html">Lucene.Net.Documents.AbstractField</a></td></tr> |
| <tr class="memitem:a12c43f4e1ba848fa13a2fb8e6390ff97 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a12c43f4e1ba848fa13a2fb8e6390ff97">Boost</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a12c43f4e1ba848fa13a2fb8e6390ff97 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the boost factor for hits for this field. <a href="#a12c43f4e1ba848fa13a2fb8e6390ff97"></a><br/></td></tr> |
| <tr class="separator:a12c43f4e1ba848fa13a2fb8e6390ff97 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac6304298a279ee813a8e0166dbe94a51 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#ac6304298a279ee813a8e0166dbe94a51">Name</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ac6304298a279ee813a8e0166dbe94a51 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the field as an interned string. For example "date", "title", "body", ... <a href="#ac6304298a279ee813a8e0166dbe94a51"></a><br/></td></tr> |
| <tr class="separator:ac6304298a279ee813a8e0166dbe94a51 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6c53bd9ec7c9b337d16a2cf4153be008 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a6c53bd9ec7c9b337d16a2cf4153be008">IsStored</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6c53bd9ec7c9b337d16a2cf4153be008 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff the value of the field is to be stored in the index for return with search hits. It is an error for this to be true if a field is Reader-valued. <a href="#a6c53bd9ec7c9b337d16a2cf4153be008"></a><br/></td></tr> |
| <tr class="separator:a6c53bd9ec7c9b337d16a2cf4153be008 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a54dba90afdf044e3973b13eee7aae9ce inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a54dba90afdf044e3973b13eee7aae9ce">IsIndexed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a54dba90afdf044e3973b13eee7aae9ce inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff the value of the field is to be indexed, so that it may be searched on. <a href="#a54dba90afdf044e3973b13eee7aae9ce"></a><br/></td></tr> |
| <tr class="separator:a54dba90afdf044e3973b13eee7aae9ce inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad3d8927a7ed80379a04a640cf16d0cb0 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#ad3d8927a7ed80379a04a640cf16d0cb0">IsTokenized</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ad3d8927a7ed80379a04a640cf16d0cb0 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are indexed as a single word and may not be Reader-valued. <a href="#ad3d8927a7ed80379a04a640cf16d0cb0"></a><br/></td></tr> |
| <tr class="separator:ad3d8927a7ed80379a04a640cf16d0cb0 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6636184a8406651116d0fc0efdd40fc3 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a6636184a8406651116d0fc0efdd40fc3">IsTermVectorStored</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6636184a8406651116d0fc0efdd40fc3 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff the term or terms used to index this field are stored as a term vector, available from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html#a93ef270cec13352696660ca154d4a1be" title="Return a term frequency vector for the specified document and field. The returned vector contains ter...">Lucene.Net.Index.IndexReader.GetTermFreqVector(int,String)</a>. These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the <code>stored</code> attribute instead. <a href="#a6636184a8406651116d0fc0efdd40fc3"></a><br/></td></tr> |
| <tr class="separator:a6636184a8406651116d0fc0efdd40fc3 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ce93e5a91e5453c763e58e1f90aeba8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a4ce93e5a91e5453c763e58e1f90aeba8">IsStoreOffsetWithTermVector</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4ce93e5a91e5453c763e58e1f90aeba8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff terms are stored as term vector together with their offsets (start and end position in source text). <a href="#a4ce93e5a91e5453c763e58e1f90aeba8"></a><br/></td></tr> |
| <tr class="separator:a4ce93e5a91e5453c763e58e1f90aeba8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96ab5a0c57151bd3d1af5db445a15b1f inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a96ab5a0c57151bd3d1af5db445a15b1f">IsStorePositionWithTermVector</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a96ab5a0c57151bd3d1af5db445a15b1f inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff terms are stored as term vector together with their token positions. <a href="#a96ab5a0c57151bd3d1af5db445a15b1f"></a><br/></td></tr> |
| <tr class="separator:a96ab5a0c57151bd3d1af5db445a15b1f inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afd9b57737df4ceb6ca96fab4b5a4e602 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#afd9b57737df4ceb6ca96fab4b5a4e602">IsBinary</a><code> [get]</code></td></tr> |
| <tr class="memdesc:afd9b57737df4ceb6ca96fab4b5a4e602 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True iff the value of the filed is stored as binary <a href="#afd9b57737df4ceb6ca96fab4b5a4e602"></a><br/></td></tr> |
| <tr class="separator:afd9b57737df4ceb6ca96fab4b5a4e602 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a36150c4089413d9ad15441c9901a2846 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a36150c4089413d9ad15441c9901a2846">BinaryLength</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a36150c4089413d9ad15441c9901a2846 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Returns length of byte[] segment that is used as value, if <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is not binary returned value is undefined <a href="#a36150c4089413d9ad15441c9901a2846"></a><br/></td></tr> |
| <tr class="separator:a36150c4089413d9ad15441c9901a2846 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a20c57d26c1976513b3faf4c966e2312b inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a20c57d26c1976513b3faf4c966e2312b">BinaryOffset</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a20c57d26c1976513b3faf4c966e2312b inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Returns offset into byte[] segment that is used as value, if <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is not binary returned value is undefined <a href="#a20c57d26c1976513b3faf4c966e2312b"></a><br/></td></tr> |
| <tr class="separator:a20c57d26c1976513b3faf4c966e2312b inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a176db64e8f17090893b4efda2bd1f9f8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a176db64e8f17090893b4efda2bd1f9f8">OmitNorms</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a176db64e8f17090893b4efda2bd1f9f8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">True if norms are omitted for this indexed field <a href="#a176db64e8f17090893b4efda2bd1f9f8"></a><br/></td></tr> |
| <tr class="separator:a176db64e8f17090893b4efda2bd1f9f8 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa95603c64c05d7fc1dba83b6ea452f6e inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#aa95603c64c05d7fc1dba83b6ea452f6e">OmitTermFreqAndPositions</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:aa95603c64c05d7fc1dba83b6ea452f6e inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="mdescLeft"> </td><td class="mdescRight">Expert: <a href="#aa95603c64c05d7fc1dba83b6ea452f6e"></a><br/></td></tr> |
| <tr class="separator:aa95603c64c05d7fc1dba83b6ea452f6e inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a722b0b487c0b6be77f49bcd4dc435cbf inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a722b0b487c0b6be77f49bcd4dc435cbf">IsLazy</a><code> [get]</code></td></tr> |
| <tr class="separator:a722b0b487c0b6be77f49bcd4dc435cbf inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab539f4526a717604c66f3313fb356df2 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">abstract <a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#ab539f4526a717604c66f3313fb356df2">TokenStreamValue</a><code> [get]</code></td></tr> |
| <tr class="separator:ab539f4526a717604c66f3313fb356df2 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab4c7cfe8281f7faf88979f0c16289c57 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">abstract TextReader </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#ab4c7cfe8281f7faf88979f0c16289c57">ReaderValue</a><code> [get]</code></td></tr> |
| <tr class="separator:ab4c7cfe8281f7faf88979f0c16289c57 inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acf676d7940f1a9bfad035f1220ec595f inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memItemLeft" align="right" valign="top">abstract string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#acf676d7940f1a9bfad035f1220ec595f">StringValue</a><code> [get]</code></td></tr> |
| <tr class="separator:acf676d7940f1a9bfad035f1220ec595f inherit properties_class_lucene_1_1_net_1_1_documents_1_1_abstract_field"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html">Lucene.Net.Documents.IFieldable</a></td></tr> |
| <tr class="memitem:a56f574c0f2e767e8e10a4977bbb2789a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a56f574c0f2e767e8e10a4977bbb2789a">Boost</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a56f574c0f2e767e8e10a4977bbb2789a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">Gets or sets the boost factor for hits for this field. This value will be multiplied into the score of all hits on this this field of this document. <a href="#a56f574c0f2e767e8e10a4977bbb2789a"></a><br/></td></tr> |
| <tr class="separator:a56f574c0f2e767e8e10a4977bbb2789a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a887bc8d5d19fdb6873625745a915a439 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a887bc8d5d19fdb6873625745a915a439">Name</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a887bc8d5d19fdb6873625745a915a439 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the field as an interned string. For example "date", "title", "body", ... <a href="#a887bc8d5d19fdb6873625745a915a439"></a><br/></td></tr> |
| <tr class="separator:a887bc8d5d19fdb6873625745a915a439 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adaea4a14b9c96576da9171b41abff836 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#adaea4a14b9c96576da9171b41abff836">StringValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:adaea4a14b9c96576da9171b41abff836 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">The value of the field as a String, or null. For indexing, if isStored()==true, the stringValue() will be used as the stored field value unless isBinary()==true, in which case GetBinaryValue() will be used. <a href="#adaea4a14b9c96576da9171b41abff836"></a><br/></td></tr> |
| <tr class="separator:adaea4a14b9c96576da9171b41abff836 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1576df6ab1faed2ae00f4d0557bb2ce8 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">TextReader </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1576df6ab1faed2ae00f4d0557bb2ce8">ReaderValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1576df6ab1faed2ae00f4d0557bb2ce8 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">The value of the field as a Reader, which can be used at index time to generate indexed tokens. <a href="#a1576df6ab1faed2ae00f4d0557bb2ce8"></a><br/></td></tr> |
| <tr class="separator:a1576df6ab1faed2ae00f4d0557bb2ce8 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75e563b489559fbad505a4c6be4ebbeb inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a75e563b489559fbad505a4c6be4ebbeb">TokenStreamValue</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a75e563b489559fbad505a4c6be4ebbeb inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">The TokenStream for this field to be used when indexing, or null. <a href="#a75e563b489559fbad505a4c6be4ebbeb"></a><br/></td></tr> |
| <tr class="separator:a75e563b489559fbad505a4c6be4ebbeb inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae96b9ed1decb32a4fc56362855d9ce24 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#ae96b9ed1decb32a4fc56362855d9ce24">IsStored</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae96b9ed1decb32a4fc56362855d9ce24 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if the value of the field is to be stored in the index for return with search hits. <a href="#ae96b9ed1decb32a4fc56362855d9ce24"></a><br/></td></tr> |
| <tr class="separator:ae96b9ed1decb32a4fc56362855d9ce24 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1d06afbb41d96935271f515185486894 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1d06afbb41d96935271f515185486894">IsIndexed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1d06afbb41d96935271f515185486894 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if the value of the field is to be indexed, so that it may be searched on. <a href="#a1d06afbb41d96935271f515185486894"></a><br/></td></tr> |
| <tr class="separator:a1d06afbb41d96935271f515185486894 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a759bc03b5d9691321bda270434e381f0 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a759bc03b5d9691321bda270434e381f0">IsTokenized</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a759bc03b5d9691321bda270434e381f0 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are indexed as a single word and may not be Reader-valued. <a href="#a759bc03b5d9691321bda270434e381f0"></a><br/></td></tr> |
| <tr class="separator:a759bc03b5d9691321bda270434e381f0 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e82d504152effe292572e6242c0ce16 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a4e82d504152effe292572e6242c0ce16">IsTermVectorStored</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4e82d504152effe292572e6242c0ce16 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if the term or terms used to index this field are stored as a term vector, available from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html#a93ef270cec13352696660ca154d4a1be" title="Return a term frequency vector for the specified document and field. The returned vector contains ter...">Lucene.Net.Index.IndexReader.GetTermFreqVector(int,String)</a>. These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the <code>stored</code> attribute instead. <a href="#a4e82d504152effe292572e6242c0ce16"></a><br/></td></tr> |
| <tr class="separator:a4e82d504152effe292572e6242c0ce16 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6dd87770d7fb1fe7f71a1b86af0f4cf5 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a6dd87770d7fb1fe7f71a1b86af0f4cf5">IsStoreOffsetWithTermVector</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6dd87770d7fb1fe7f71a1b86af0f4cf5 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if terms are stored as term vector together with their offsets (start and end positon in source text). <a href="#a6dd87770d7fb1fe7f71a1b86af0f4cf5"></a><br/></td></tr> |
| <tr class="separator:a6dd87770d7fb1fe7f71a1b86af0f4cf5 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3fe2ff23898c82339c83088fed82518a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a3fe2ff23898c82339c83088fed82518a">IsStorePositionWithTermVector</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a3fe2ff23898c82339c83088fed82518a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if terms are stored as term vector together with their token positions. <a href="#a3fe2ff23898c82339c83088fed82518a"></a><br/></td></tr> |
| <tr class="separator:a3fe2ff23898c82339c83088fed82518a inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1f0b930c4cc0180629d70fb056a17316 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1f0b930c4cc0180629d70fb056a17316">IsBinary</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1f0b930c4cc0180629d70fb056a17316 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if the value of the field is stored as binary <a href="#a1f0b930c4cc0180629d70fb056a17316"></a><br/></td></tr> |
| <tr class="separator:a1f0b930c4cc0180629d70fb056a17316 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e9e11d2fe5ae37031d6a590042720b3 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1e9e11d2fe5ae37031d6a590042720b3">OmitNorms</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:a1e9e11d2fe5ae37031d6a590042720b3 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">True if norms are omitted for this indexed field. <a href="#a1e9e11d2fe5ae37031d6a590042720b3"></a><br/></td></tr> |
| <tr class="separator:a1e9e11d2fe5ae37031d6a590042720b3 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad5c660c07e9defcf7cbcfbb93c18fa67 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#ad5c660c07e9defcf7cbcfbb93c18fa67">IsLazy</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ad5c660c07e9defcf7cbcfbb93c18fa67 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is Lazy or not. The semantics of Lazy loading are such that if a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is lazily loaded, retrieving it's values via StringValue() or GetBinaryValue() is only valid as long as the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html" title="IndexReader is an abstract class, providing an interface for accessing an index. Search of an index i...">Lucene.Net.Index.IndexReader</a> that retrieved the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> is still open. <a href="#ad5c660c07e9defcf7cbcfbb93c18fa67"></a><br/></td></tr> |
| <tr class="separator:ad5c660c07e9defcf7cbcfbb93c18fa67 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a715d668bb08d334114912c605cbd3a87 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a715d668bb08d334114912c605cbd3a87">BinaryOffset</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a715d668bb08d334114912c605cbd3a87 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">Returns offset into byte[] segment that is used as value, if <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is not binary returned value is undefined <a href="#a715d668bb08d334114912c605cbd3a87"></a><br/></td></tr> |
| <tr class="separator:a715d668bb08d334114912c605cbd3a87 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1626e0013eb0d4b47adddc18b4b588f2 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a1626e0013eb0d4b47adddc18b4b588f2">BinaryLength</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1626e0013eb0d4b47adddc18b4b588f2 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="mdescLeft"> </td><td class="mdescRight">Returns length of byte[] segment that is used as value, if <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> is not binary returned value is undefined <a href="#a1626e0013eb0d4b47adddc18b4b588f2"></a><br/></td></tr> |
| <tr class="separator:a1626e0013eb0d4b47adddc18b4b588f2 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2b04a2db2455db84a38aa483b3d5f156 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html#a2b04a2db2455db84a38aa483b3d5f156">OmitTermFreqAndPositions</a><code> [get, set]</code></td></tr> |
| <tr class="separator:a2b04a2db2455db84a38aa483b3d5f156 inherit properties_interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>This class provides 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> that enables indexing of numeric values for efficient range filtering and sorting. Here's an example usage, adding an int value: </p> |
| <p><code> document.add(new NumericField(name).setIntValue(value)); </code></p> |
| <p>For optimal performance, re-use the <code><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html" title="This class provides a Field that enables indexing of numeric values for efficient range filtering and...">NumericField</a></code> and <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> instance for more than one document:</p> |
| <p><code> <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html" title="This class provides a Field that enables indexing of numeric values for efficient range filtering and...">NumericField</a> field = new NumericField(name); <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> document = new <a class="el" href="_more_like_this_8cs.html#a2ad6aef8641c7b7a6cf9277f7d54b2cd">Document()</a>; document.add(field);</code></p> |
| <p><code> for(all documents) { ... field.setIntValue(value) writer.addDocument(document); ... } </code></p> |
| <p>The .<a class="el" href="namespace_lucene_1_1_net.html">Net</a> native types <code>int</code>, <code>long</code>, <code>float</code> and <code>double</code> are directly supported. However, any value that can be converted into these native types can also be indexed. For example, date/time values represented by a System.DateTime can be translated into a long value using the <code>java.util.Date.getTime</code> method. If you don't need millisecond precision, you can quantize the value, either by dividing the result of <code>java.util.Date.getTime</code> or using the separate getters (for year, month, etc.) to construct an <code>int</code> or <code>long</code> value.</p> |
| <p>To perform range querying or filtering against a <code><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html" title="This class provides a Field that enables indexing of numeric values for efficient range filtering and...">NumericField</a></code>, use NumericRangeQuery{T} or NumericRangeFilter{T} . To sort according to a <code><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html" title="This class provides a Field that enables indexing of numeric values for efficient range filtering and...">NumericField</a></code>, use the normal numeric sort types, eg SortField.INT <code><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html" title="This class provides a Field that enables indexing of numeric values for efficient range filtering and...">NumericField</a></code> values can also be loaded directly from <a class="el" href="_field_cache_sanity_checker_8cs.html#ae3da15e75141cdc8cab8107899059bb1">FieldCache</a>.</p> |
| <p>By default, a <code><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html" title="This class provides a Field that enables indexing of numeric values for efficient range filtering and...">NumericField</a></code>'s value is not stored but is indexed for range filtering and sorting. You can use the NumericField(String,Field.Store,bool) constructor if you need to change these defaults.</p> |
| <p>You may add the same field name as a <code><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html" title="This class provides a Field that enables indexing of numeric values for efficient range filtering and...">NumericField</a></code> to the same document more than once. Range querying and filtering will be the logical OR of all values; so a range query will hit all documents that have at least one value in the range. However sort behavior is not defined. If you need to sort, you should separately index a single-valued <code><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html" title="This class provides a Field that enables indexing of numeric values for efficient range filtering and...">NumericField</a></code>.</p> |
| <p>A <code><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html" title="This class provides a Field that enables indexing of numeric values for efficient range filtering and...">NumericField</a></code> will consume somewhat more disk space in the index than an ordinary single-valued field. However, for a typical index that includes substantial textual content per document, this increase will likely be in the noise. </p> |
| <p>Within <a class="el" href="namespace_lucene.html">Lucene</a>, each numeric value is indexed as a <em>trie</em> structure, where each term is logically assigned to larger and larger pre-defined brackets (which are simply lower-precision representations of the value). The step size between each successive bracket is called the <code>precisionStep</code>, measured in bits. Smaller <code>precisionStep</code> values result in larger number of brackets, which consumes more disk space in the index but may result in faster range search performance. The default value, 4, was selected for a reasonable tradeoff of disk space consumption versus performance. You can use the expert constructor NumericField(String,int,Field.Store,bool) if you'd like to change the value. Note that you must also specify a congruent value when creating NumericRangeQuery{T} or NumericRangeFilter{T}. For low cardinality fields larger precision steps are good. If the cardinality is < 100, it is fair to use int.MaxValue, which produces one term per value.</p> |
| <p>For more information on the internals of numeric trie indexing, including the <a href="../search/NumericRangeQuery.html#precisionStepDesc"><code>precisionStep</code></a> configuration, see NumericRangeQuery{T}. The format of indexed values is described in <a class="el" href="_numeric_range_query_8cs.html#a35ee450e1da1e0bf32b70e5018cc9e5e">NumericUtils</a>.</p> |
| <p>If you only need to sort by numeric value, and never run range querying/filtering, you can index using a <code>precisionStep</code> of int.MaxValue. This will minimize disk space consumed. </p> |
| <p>More advanced users can instead use <a class="el" href="_numeric_utils_8cs.html#ab25a5cea67a38594cfddfac92e18554e">NumericTokenStream</a> directly, when indexing numbers. This class is a wrapper around this token stream type for easier, more intuitive usage.</p> |
| <p><b>NOTE:</b> This class is only used during indexing. When retrieving the stored field value from a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> instance after search, you will get a conventional <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_i_fieldable.html" title="Synonymous with Field.">IFieldable</a> instance where the numeric values are returned as Strings (according to <code>toString(value)</code> of the used data type).</p> |
| <p><font color="red"><b>NOTE:</b> This API is experimental and might change in incompatible ways in the next release.</font></p> |
| <p><since> 2.9 </since> </p> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00145">145</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="ae67c91b81edbcf343cb18f94f9500499"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.NumericField.NumericField </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a field for numeric values using the default <code>precisionStep</code> NumericUtils.PRECISION_STEP_DEFAULT (4). The instance is not yet initialized with a numeric value, before indexing a document containing this field, set a value using the various set<em>???</em>Value() methods. This constructor creates an indexed, but not stored field. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the field name </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00158">158</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6c5b26e2051877d5efbb34fa5e528ba9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.NumericField.NumericField </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Field.Store </td> |
| <td class="paramname"><em>store</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>index</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a field for numeric values using the default <code>precisionStep</code> NumericUtils.PRECISION_STEP_DEFAULT (4). The instance is not yet initialized with a numeric value, before indexing a document containing this field, set a value using the various set<em>???</em>Value() methods. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the field name </td></tr> |
| <tr><td class="paramname">store</td><td>if the field should be stored in plain text form (according to <code>toString(value)</code> of the used data type) </td></tr> |
| <tr><td class="paramname">index</td><td>if the field should be indexed using <a class="el" href="_numeric_utils_8cs.html#ab25a5cea67a38594cfddfac92e18554e">NumericTokenStream</a> </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00174">174</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af1cdbd742275b546f9bf5c0c553c3c35"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.NumericField.NumericField </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>precisionStep</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a field for numeric values with the specified <code>precisionStep</code>. The instance is not yet initialized with a numeric value, before indexing a document containing this field, set a value using the various set<em>???</em>Value() methods. This constructor creates an indexed, but not stored field. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the field name </td></tr> |
| <tr><td class="paramname">precisionStep</td><td>the used <a href="../search/NumericRangeQuery.html#precisionStepDesc">precision step</a> </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00188">188</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="adff48b3d939e94390f084618b9a03829"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Documents.NumericField.NumericField </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>precisionStep</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">Field.Store </td> |
| <td class="paramname"><em>store</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>index</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a field for numeric values with the specified <code>precisionStep</code>. The instance is not yet initialized with a numeric value, before indexing a document containing this field, set a value using the various set<em>???</em>Value() methods. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the field name </td></tr> |
| <tr><td class="paramname">precisionStep</td><td>the used <a href="../search/NumericRangeQuery.html#precisionStepDesc">precision step</a> </td></tr> |
| <tr><td class="paramname">store</td><td>if the field should be stored in plain text form (according to <code>toString(value)</code> of the used data type) </td></tr> |
| <tr><td class="paramname">index</td><td>if the field should be indexed using <a class="el" href="_numeric_utils_8cs.html#ab25a5cea67a38594cfddfac92e18554e">NumericTokenStream</a> </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00206">206</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a298b1411e72ac28c5c447434f63b85af"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override byte [] Lucene.Net.Documents.NumericField.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>Returns always <code>null</code> for numeric fields </p> |
| |
| <p>Reimplemented from <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_abstract_field.html#a283237239676dd08a85b564a373c19ee">Lucene.Net.Documents.AbstractField</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00219">219</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5ed9256e6b1e6db3c83db64a51e5a736"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html">NumericField</a> Lucene.Net.Documents.NumericField.SetDoubleValue </td> |
| <td>(</td> |
| <td class="paramtype">double </td> |
| <td class="paramname"><em>value_Renamed</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes the field with the supplied <code>double</code> value.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">value_Renamed</td><td>the numeric value </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>this instance, because of this you can use it the following way: <code>document.add(new NumericField(name, precisionStep).setDoubleValue(value))</code> </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00274">274</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a0e3016a6a8373633e49ac3059bebf31c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html">NumericField</a> Lucene.Net.Documents.NumericField.SetFloatValue </td> |
| <td>(</td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>value_Renamed</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes the field with the supplied <code>float</code> value.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">value_Renamed</td><td>the numeric value </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>this instance, because of this you can use it the following way: <code>document.add(new NumericField(name, precisionStep).setFloatValue(value))</code> </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00287">287</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2634e45e55bc134cd7a5651843c776b9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html">NumericField</a> Lucene.Net.Documents.NumericField.SetIntValue </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>value_Renamed</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes the field with the supplied <code>int</code> value.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">value_Renamed</td><td>the numeric value </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>this instance, because of this you can use it the following way: <code>document.add(new NumericField(name, precisionStep).setIntValue(value))</code> </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00261">261</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a368bf0958d4c7db50b2d625518a85804"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_numeric_field.html">NumericField</a> Lucene.Net.Documents.NumericField.SetLongValue </td> |
| <td>(</td> |
| <td class="paramtype">long </td> |
| <td class="paramname"><em>value_Renamed</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes the field with the supplied <code>long</code> value.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">value_Renamed</td><td>the numeric value </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>this instance, because of this you can use it the following way: <code>document.add(new NumericField(name, precisionStep).SetLongValue(value))</code> </dd></dl> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00248">248</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a00d8f30fc3cf9e441af908a38d46b608"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ValueType Lucene.Net.Documents.NumericField.NumericValue</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 current numeric value as a subclass of Number, <code>null</code> if not yet initialized. </p> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00238">238</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af8e1ab19e92068224c52849ebe7bed43"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override TextReader Lucene.Net.Documents.NumericField.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>Returns always <code>null</code> for numeric fields </p> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00226">226</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac9297d23dacf6f18db8707c878da90f1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override string Lucene.Net.Documents.NumericField.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>Returns the numeric value as a string (how it is stored, when Field.Store.YES is chosen). </p> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00232">232</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3610f92c08eec7e0a568969d1205448e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override <a class="el" href="_more_like_this_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> Lucene.Net.Documents.NumericField.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>Returns a <a class="el" href="_numeric_utils_8cs.html#ab25a5cea67a38594cfddfac92e18554e">NumericTokenStream</a> for indexing the numeric value. </p> |
| |
| <p>Definition at line <a class="el" href="_numeric_field_8cs_source.html#l00214">214</a> of file <a class="el" href="_numeric_field_8cs_source.html">NumericField.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="_numeric_field_8cs_source.html">NumericField.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> |
