| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Interface IIndexableField |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Interface IIndexableField |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Index.IIndexableField"> |
| |
| |
| <h1 id="Lucene_Net_Index_IIndexableField" data-uid="Lucene.Net.Index.IIndexableField" class="text-break">Interface IIndexableField |
| </h1> |
| <div class="markdown level0 summary"><p>Represents a single field for indexing. <a class="xref" href="Lucene.Net.Index.IndexWriter.html">IndexWriter</a> |
| consumes IEnumerable<IndexableField> as a document. |
| <p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></div> |
| <div class="markdown level0 conceptual"></div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Index.html">Lucene.Net.Index</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Index_IIndexableField_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public interface IIndexableField</code></pre> |
| </div> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_Boost.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.Boost%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L75">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_Boost_" data-uid="Lucene.Net.Index.IIndexableField.Boost*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_Boost" data-uid="Lucene.Net.Index.IIndexableField.Boost">Boost</h4> |
| <div class="markdown level1 summary"><p>Returns the field's index-time boost. |
| <p> |
| Only fields can have an index-time boost, if you want to simulate |
| a "document boost", then you must pre-multiply it across all the |
| relevant fields yourself. |
| <p> |
| The boost is used to compute the norm factor for the field. By |
| default, in the <a class="xref" href="Lucene.Net.Search.Similarities.Similarity.html#Lucene_Net_Search_Similarities_Similarity_ComputeNorm_Lucene_Net_Index_FieldInvertState_">ComputeNorm(FieldInvertState)</a> method, |
| the boost value is multiplied by the length normalization factor and then |
| rounded by <a class="xref" href="Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_EncodeNormValue_System_Single_">EncodeNormValue(Single)</a> before it is stored in the |
| index. One should attempt to ensure that this product does not overflow |
| the range of that encoding. |
| <p> |
| It is illegal to return a boost other than 1.0f for a field that is not |
| indexed (<a class="xref" href="Lucene.Net.Index.IIndexableFieldType.html#Lucene_Net_Index_IIndexableFieldType_IsIndexed">IsIndexed</a> is false) or omits normalization values |
| (<a class="xref" href="Lucene.Net.Index.IIndexableFieldType.html#Lucene_Net_Index_IIndexableFieldType_OmitNorms">OmitNorms</a> returns true).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">float Boost { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Index_IIndexableField_Boost_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Search.Similarities.Similarity.html#Lucene_Net_Search_Similarities_Similarity_ComputeNorm_Lucene_Net_Index_FieldInvertState_">ComputeNorm</a>(<a class="xref" href="Lucene.Net.Index.FieldInvertState.html">FieldInvertState</a>)</div> |
| <div><a class="xref" href="Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_EncodeNormValue_System_Single_">EncodeNormValue(Single)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_IndexableFieldType.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.IndexableFieldType%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L53">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_IndexableFieldType_" data-uid="Lucene.Net.Index.IIndexableField.IndexableFieldType*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_IndexableFieldType" data-uid="Lucene.Net.Index.IIndexableField.IndexableFieldType">IndexableFieldType</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Index.IIndexableFieldType.html">IIndexableFieldType</a> describing the properties |
| of this field.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">IIndexableFieldType IndexableFieldType { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.IIndexableFieldType.html">IIndexableFieldType</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_Name.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.Name%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L42">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_Name_" data-uid="Lucene.Net.Index.IIndexableField.Name*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_Name" data-uid="Lucene.Net.Index.IIndexableField.Name">Name</h4> |
| <div class="markdown level1 summary"><p>Field name </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string Name { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_NumericType.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.NumericType%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L145">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_NumericType_" data-uid="Lucene.Net.Index.IIndexableField.NumericType*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_NumericType" data-uid="Lucene.Net.Index.IIndexableField.NumericType">NumericType</h4> |
| <div class="markdown level1 summary"><p>Gets the <a class="xref" href="Lucene.Net.Documents.NumericFieldType.html">NumericFieldType</a> of the underlying value, or <a class="xref" href="Lucene.Net.Documents.NumericFieldType.html#Lucene_Net_Documents_NumericFieldType_NONE">NONE</a> if the value is not set or non-numeric. |
| <p> |
| Expert: The difference between this property and <a class="xref" href="Lucene.Net.Documents.FieldType.html#Lucene_Net_Documents_FieldType_NumericType">NumericType</a> is |
| this is represents the current state of the field (whether being written or read) and the |
| <a class="xref" href="Lucene.Net.Documents.FieldType.html">FieldType</a> property represents instructions on how the field will be written, |
| but does not re-populate when reading back from an index (it is write-only). |
| <p> |
| In Java, the numeric type was determined by checking the type of<br><a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetNumericValue">GetNumericValue()</a>. However, since there are no reference number |
| types in .NET, using <a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetNumericValue">GetNumericValue()</a> so will cause boxing/unboxing. It is |
| therefore recommended to use this property to check the underlying type and the corresponding |
| <code>Get*Value()</code> method to retrieve the value. |
| <p> |
| NOTE: Since Lucene codecs do not support <a class="xref" href="Lucene.Net.Documents.NumericFieldType.html#Lucene_Net_Documents_NumericFieldType_BYTE">BYTE</a> or <a class="xref" href="Lucene.Net.Documents.NumericFieldType.html#Lucene_Net_Documents_NumericFieldType_INT16">INT16</a>, |
| fields created with these types will always be <a class="xref" href="Lucene.Net.Documents.NumericFieldType.html#Lucene_Net_Documents_NumericFieldType_INT32">INT32</a> when read back from the index.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">NumericFieldType NumericType { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.NumericFieldType.html">NumericFieldType</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetBinaryValue.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetBinaryValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L79">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetBinaryValue_" data-uid="Lucene.Net.Index.IIndexableField.GetBinaryValue*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetBinaryValue" data-uid="Lucene.Net.Index.IIndexableField.GetBinaryValue">GetBinaryValue()</h4> |
| <div class="markdown level1 summary"><p>Non-null if this field has a binary value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">BytesRef GetBinaryValue()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetByteValue.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetByteValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L153">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetByteValue_" data-uid="Lucene.Net.Index.IIndexableField.GetByteValue*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetByteValue" data-uid="Lucene.Net.Index.IIndexableField.GetByteValue">GetByteValue()</h4> |
| <div class="markdown level1 summary"><p>Returns the field value as <span class="xref">System.Byte</span> or <code>null</code> if the type |
| is non-numeric.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">byte? GetByteValue()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Byte</span>></td> |
| <td><p>The field value or <code>null</code> if the type is non-numeric.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetDoubleValue.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetDoubleValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L193">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetDoubleValue_" data-uid="Lucene.Net.Index.IIndexableField.GetDoubleValue*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetDoubleValue" data-uid="Lucene.Net.Index.IIndexableField.GetDoubleValue">GetDoubleValue()</h4> |
| <div class="markdown level1 summary"><p>Returns the field value as <span class="xref">System.Double</span> or <code>null</code> if the type |
| is non-numeric.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">double? GetDoubleValue()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Double</span>></td> |
| <td><p>The field value or <code>null</code> if the type is non-numeric.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetInt16Value.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetInt16Value%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L161">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetInt16Value_" data-uid="Lucene.Net.Index.IIndexableField.GetInt16Value*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetInt16Value" data-uid="Lucene.Net.Index.IIndexableField.GetInt16Value">GetInt16Value()</h4> |
| <div class="markdown level1 summary"><p>Returns the field value as <span class="xref">System.Int16</span> or <code>null</code> if the type |
| is non-numeric.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">short? GetInt16Value()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int16</span>></td> |
| <td><p>The field value or <code>null</code> if the type is non-numeric.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetInt32Value.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetInt32Value%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L169">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetInt32Value_" data-uid="Lucene.Net.Index.IIndexableField.GetInt32Value*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetInt32Value" data-uid="Lucene.Net.Index.IIndexableField.GetInt32Value">GetInt32Value()</h4> |
| <div class="markdown level1 summary"><p>Returns the field value as <span class="xref">System.Int32</span> or <code>null</code> if the type |
| is non-numeric.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">int? GetInt32Value()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td> |
| <td><p>The field value or <code>null</code> if the type is non-numeric.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetInt64Value.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetInt64Value%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L177">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetInt64Value_" data-uid="Lucene.Net.Index.IIndexableField.GetInt64Value*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetInt64Value" data-uid="Lucene.Net.Index.IIndexableField.GetInt64Value">GetInt64Value()</h4> |
| <div class="markdown level1 summary"><p>Returns the field value as <span class="xref">System.Int64</span> or <code>null</code> if the type |
| is non-numeric.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">long? GetInt64Value()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Int64</span>></td> |
| <td><p>The field value or <code>null</code> if the type is non-numeric.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetNumericValue.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetNumericValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L124">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetNumericValue_" data-uid="Lucene.Net.Index.IIndexableField.GetNumericValue*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetNumericValue" data-uid="Lucene.Net.Index.IIndexableField.GetNumericValue">GetNumericValue()</h4> |
| <div class="markdown level1 summary"><p>Non-null if this field has a numeric value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[Obsolete("In .NET, use of this method will cause boxing/unboxing. Instead, use the NumericType property to check the underlying type and call the appropriate GetXXXValue() method to retrieve the value.")] |
| object GetNumericValue()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Object</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetReaderValue.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetReaderValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L120">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetReaderValue_" data-uid="Lucene.Net.Index.IIndexableField.GetReaderValue*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetReaderValue" data-uid="Lucene.Net.Index.IIndexableField.GetReaderValue">GetReaderValue()</h4> |
| <div class="markdown level1 summary"><p>Non-null if this field has a <span class="xref">System.IO.TextReader</span> value </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">TextReader GetReaderValue()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.TextReader</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetSingleValue.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetSingleValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L185">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetSingleValue_" data-uid="Lucene.Net.Index.IIndexableField.GetSingleValue*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetSingleValue" data-uid="Lucene.Net.Index.IIndexableField.GetSingleValue">GetSingleValue()</h4> |
| <div class="markdown level1 summary"><p>Returns the field value as <span class="xref">System.Single</span> or <code>null</code> if the type |
| is non-numeric.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">float? GetSingleValue()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Nullable</span><<span class="xref">System.Single</span>></td> |
| <td><p>The field value or <code>null</code> if the type is non-numeric.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetStringValue.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetStringValue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L84">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetStringValue_" data-uid="Lucene.Net.Index.IIndexableField.GetStringValue*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetStringValue" data-uid="Lucene.Net.Index.IIndexableField.GetStringValue">GetStringValue()</h4> |
| <div class="markdown level1 summary"><p>Non-null if this field has a string value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string GetStringValue()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><p>The string representation of the value if it is either a <span class="xref">System.String</span> or numeric type.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetStringValue_System_IFormatProvider_.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetStringValue(System.IFormatProvider)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L94">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetStringValue_" data-uid="Lucene.Net.Index.IIndexableField.GetStringValue*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetStringValue_System_IFormatProvider_" data-uid="Lucene.Net.Index.IIndexableField.GetStringValue(System.IFormatProvider)">GetStringValue(IFormatProvider)</h4> |
| <div class="markdown level1 summary"><p>The value of the field as a <span class="xref">System.String</span>, or <code>null</code>. If <code>null</code>, the <span class="xref">System.IO.TextReader</span> value or |
| binary value is used. Exactly one of <a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetStringValue">GetStringValue()</a>, <a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetReaderValue">GetReaderValue()</a>, and |
| <a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetBinaryValue">GetBinaryValue()</a> must be set.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string GetStringValue(IFormatProvider provider)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IFormatProvider</span></td> |
| <td><span class="parametername">provider</span></td> |
| <td><p>An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><p>The string representation of the value if it is either a <span class="xref">System.String</span> or numeric type.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetStringValue_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetStringValue(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L104">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetStringValue_" data-uid="Lucene.Net.Index.IIndexableField.GetStringValue*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetStringValue_System_String_" data-uid="Lucene.Net.Index.IIndexableField.GetStringValue(System.String)">GetStringValue(String)</h4> |
| <div class="markdown level1 summary"><p>The value of the field as a <span class="xref">System.String</span>, or <code>null</code>. If <code>null</code>, the <span class="xref">System.IO.TextReader</span> value or |
| binary value is used. Exactly one of <a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetStringValue">GetStringValue()</a>, <a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetReaderValue">GetReaderValue()</a>, and |
| <a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetBinaryValue">GetBinaryValue()</a> must be set.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string GetStringValue(string format)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">format</span></td> |
| <td><p>A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><p>The string representation of the value if it is either a <span class="xref">System.String</span> or numeric type.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetStringValue_System_String_System_IFormatProvider_.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetStringValue(System.String%2CSystem.IFormatProvider)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L115">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetStringValue_" data-uid="Lucene.Net.Index.IIndexableField.GetStringValue*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetStringValue_System_String_System_IFormatProvider_" data-uid="Lucene.Net.Index.IIndexableField.GetStringValue(System.String,System.IFormatProvider)">GetStringValue(String, IFormatProvider)</h4> |
| <div class="markdown level1 summary"><p>The value of the field as a <span class="xref">System.String</span>, or <code>null</code>. If <code>null</code>, the <span class="xref">System.IO.TextReader</span> value or |
| binary value is used. Exactly one of <a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetStringValue">GetStringValue()</a>, <a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetReaderValue">GetReaderValue()</a>, and |
| <a class="xref" href="Lucene.Net.Index.IIndexableField.html#Lucene_Net_Index_IIndexableField_GetBinaryValue">GetBinaryValue()</a> must be set.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string GetStringValue(string format, IFormatProvider provider)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">format</span></td> |
| <td><p>A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.IFormatProvider</span></td> |
| <td><span class="parametername">provider</span></td> |
| <td><p>An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><p>The string representation of the value if it is either a <span class="xref">System.String</span> or numeric type.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField_GetTokenStream_Lucene_Net_Analysis_Analyzer_.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField.GetTokenStream(Lucene.Net.Analysis.Analyzer)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L203">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_IIndexableField_GetTokenStream_" data-uid="Lucene.Net.Index.IIndexableField.GetTokenStream*"></a> |
| <h4 id="Lucene_Net_Index_IIndexableField_GetTokenStream_Lucene_Net_Analysis_Analyzer_" data-uid="Lucene.Net.Index.IIndexableField.GetTokenStream(Lucene.Net.Analysis.Analyzer)">GetTokenStream(Analyzer)</h4> |
| <div class="markdown level1 summary"><p>Creates the <a class="xref" href="Lucene.Net.Analysis.TokenStream.html">TokenStream</a> used for indexing this field. If appropriate, |
| implementations should use the given <a class="xref" href="Lucene.Net.Analysis.Analyzer.html">Analyzer</a> to create the <a class="xref" href="Lucene.Net.Analysis.TokenStream.html">TokenStream</a>s.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">TokenStream GetTokenStream(Analyzer analyzer)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Analyzer.html">Analyzer</a></td> |
| <td><span class="parametername">analyzer</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Analysis.Analyzer.html">Analyzer</a> that should be used to create the <a class="xref" href="Lucene.Net.Analysis.TokenStream.html">TokenStream</a>s from </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.TokenStream.html">TokenStream</a></td> |
| <td><p><a class="xref" href="Lucene.Net.Analysis.TokenStream.html">TokenStream</a> value for indexing the document. Should always return |
| a non-null value if the field is to be indexed </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>Can be thrown while creating the <a class="xref" href="Lucene.Net.Analysis.TokenStream.html">TokenStream</a> </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="extensionmethods">Extension Methods</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Documents.Extensions.IndexableFieldExtensions.html#Lucene_Net_Documents_Extensions_IndexableFieldExtensions_GetByteValueOrDefault_Lucene_Net_Index_IIndexableField_">IndexableFieldExtensions.GetByteValueOrDefault(IIndexableField)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Documents.Extensions.IndexableFieldExtensions.html#Lucene_Net_Documents_Extensions_IndexableFieldExtensions_GetInt16ValueOrDefault_Lucene_Net_Index_IIndexableField_">IndexableFieldExtensions.GetInt16ValueOrDefault(IIndexableField)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Documents.Extensions.IndexableFieldExtensions.html#Lucene_Net_Documents_Extensions_IndexableFieldExtensions_GetInt32ValueOrDefault_Lucene_Net_Index_IIndexableField_">IndexableFieldExtensions.GetInt32ValueOrDefault(IIndexableField)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Documents.Extensions.IndexableFieldExtensions.html#Lucene_Net_Documents_Extensions_IndexableFieldExtensions_GetInt64ValueOrDefault_Lucene_Net_Index_IIndexableField_">IndexableFieldExtensions.GetInt64ValueOrDefault(IIndexableField)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Documents.Extensions.IndexableFieldExtensions.html#Lucene_Net_Documents_Extensions_IndexableFieldExtensions_GetSingleValueOrDefault_Lucene_Net_Index_IIndexableField_">IndexableFieldExtensions.GetSingleValueOrDefault(IIndexableField)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Documents.Extensions.IndexableFieldExtensions.html#Lucene_Net_Documents_Extensions_IndexableFieldExtensions_GetDoubleValueOrDefault_Lucene_Net_Index_IIndexableField_">IndexableFieldExtensions.GetDoubleValueOrDefault(IIndexableField)</a> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_IIndexableField.md&value=---%0Auid%3A%20Lucene.Net.Index.IIndexableField%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Index/IndexableField.cs/#L38" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
