| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class FastVectorHighlighter |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class FastVectorHighlighter |
| | 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="highlighter/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.Search.VectorHighlight.FastVectorHighlighter"> |
| |
| |
| <h1 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter" class="text-break">Class FastVectorHighlighter |
| </h1> |
| <div class="markdown level0 summary"><p>Another highlighter implementation.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">FastVectorHighlighter</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.VectorHighlight.html">Lucene.Net.Search.VectorHighlight</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Highlighter.dll</h6> |
| <h5 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class FastVectorHighlighter</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </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_Search_VectorHighlight_FastVectorHighlighter__ctor.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.%23ctor%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L42">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter__ctor_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter__ctor" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.#ctor">FastVectorHighlighter()</h4> |
| <div class="markdown level1 summary"><p>the default constructor.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FastVectorHighlighter()</code></pre> |
| </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_Search_VectorHighlight_FastVectorHighlighter__ctor_System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.%23ctor(System.Boolean%2CSystem.Boolean)%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L52">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter__ctor_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter__ctor_System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.#ctor(System.Boolean,System.Boolean)">FastVectorHighlighter(Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>a constructor. Using <a class="xref" href="Lucene.Net.Search.VectorHighlight.SimpleFragListBuilder.html">SimpleFragListBuilder</a> and <a class="xref" href="Lucene.Net.Search.VectorHighlight.ScoreOrderFragmentsBuilder.html">ScoreOrderFragmentsBuilder</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FastVectorHighlighter(bool phraseHighlight, bool fieldMatch)</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.Boolean</span></td> |
| <td><span class="parametername">phraseHighlight</span></td> |
| <td><p>true or false for phrase highlighting</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">fieldMatch</span></td> |
| <td><p>true of false for field matching</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_Search_VectorHighlight_FastVectorHighlighter__ctor_System_Boolean_System_Boolean_Lucene_Net_Search_VectorHighlight_IFragListBuilder_Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.%23ctor(System.Boolean%2CSystem.Boolean%2CLucene.Net.Search.VectorHighlight.IFragListBuilder%2CLucene.Net.Search.VectorHighlight.IFragmentsBuilder)%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L64">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter__ctor_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter__ctor_System_Boolean_System_Boolean_Lucene_Net_Search_VectorHighlight_IFragListBuilder_Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.#ctor(System.Boolean,System.Boolean,Lucene.Net.Search.VectorHighlight.IFragListBuilder,Lucene.Net.Search.VectorHighlight.IFragmentsBuilder)">FastVectorHighlighter(Boolean, Boolean, IFragListBuilder, IFragmentsBuilder)</h4> |
| <div class="markdown level1 summary"><p>a constructor. A <a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragListBuilder.html">IFragListBuilder</a> and a <a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a> can be specified (plugins).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FastVectorHighlighter(bool phraseHighlight, bool fieldMatch, IFragListBuilder fragListBuilder, IFragmentsBuilder fragmentsBuilder)</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.Boolean</span></td> |
| <td><span class="parametername">phraseHighlight</span></td> |
| <td><p>true of false for phrase highlighting</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">fieldMatch</span></td> |
| <td><p>true of false for field matching</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragListBuilder.html">IFragListBuilder</a></td> |
| <td><span class="parametername">fragListBuilder</span></td> |
| <td><p>an instance of <a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a></p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a></td> |
| <td><span class="parametername">fragmentsBuilder</span></td> |
| <td><p>an instance of <a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a></p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="fields">Fields |
| </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_Search_VectorHighlight_FastVectorHighlighter_DEFAULT_FIELD_MATCH.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.DEFAULT_FIELD_MATCH%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L32">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_DEFAULT_FIELD_MATCH" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.DEFAULT_FIELD_MATCH">DEFAULT_FIELD_MATCH</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly bool DEFAULT_FIELD_MATCH</code></pre> |
| </div> |
| <h5 class="fieldValue">Field 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.Boolean</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_Search_VectorHighlight_FastVectorHighlighter_DEFAULT_PHRASE_HIGHLIGHT.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.DEFAULT_PHRASE_HIGHLIGHT%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L31">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_DEFAULT_PHRASE_HIGHLIGHT" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.DEFAULT_PHRASE_HIGHLIGHT">DEFAULT_PHRASE_HIGHLIGHT</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly bool DEFAULT_PHRASE_HIGHLIGHT</code></pre> |
| </div> |
| <h5 class="fieldValue">Field 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.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_Search_VectorHighlight_FastVectorHighlighter_IsFieldMatch.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.IsFieldMatch%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L275">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_IsFieldMatch_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.IsFieldMatch*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_IsFieldMatch" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.IsFieldMatch">IsFieldMatch</h4> |
| <div class="markdown level1 summary"><p>return whether fieldMatch or not.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool IsFieldMatch { 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.Boolean</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_Search_VectorHighlight_FastVectorHighlighter_IsPhraseHighlight.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.IsPhraseHighlight%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L270">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_IsPhraseHighlight_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.IsPhraseHighlight*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_IsPhraseHighlight" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.IsPhraseHighlight">IsPhraseHighlight</h4> |
| <div class="markdown level1 summary"><p>return whether phraseHighlight or not.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool IsPhraseHighlight { 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.Boolean</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_Search_VectorHighlight_FastVectorHighlighter_PhraseLimit.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.PhraseLimit%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L281">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_PhraseLimit_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.PhraseLimit*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_PhraseLimit" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.PhraseLimit">PhraseLimit</h4> |
| <div class="markdown level1 summary"><p>Gets or Sets the maximum number of phrases to analyze when searching for the highest-scoring phrase. |
| The default is unlimited (int.MaxValue).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int PhraseLimit { get; set; }</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.Int32</span></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_Search_VectorHighlight_FastVectorHighlighter_GetBestFragment_Lucene_Net_Search_VectorHighlight_FieldQuery_Lucene_Net_Index_IndexReader_System_Int32_System_String_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragment(Lucene.Net.Search.VectorHighlight.FieldQuery%2CLucene.Net.Index.IndexReader%2CSystem.Int32%2CSystem.String%2CSystem.Int32)%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L114">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetBestFragment_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragment*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetBestFragment_Lucene_Net_Search_VectorHighlight_FieldQuery_Lucene_Net_Index_IndexReader_System_Int32_System_String_System_Int32_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragment(Lucene.Net.Search.VectorHighlight.FieldQuery,Lucene.Net.Index.IndexReader,System.Int32,System.String,System.Int32)">GetBestFragment(FieldQuery, IndexReader, Int32, String, Int32)</h4> |
| <div class="markdown level1 summary"><p>return the best fragment.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string GetBestFragment(FieldQuery fieldQuery, IndexReader reader, int docId, string fieldName, int fragCharSize)</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.Search.VectorHighlight.FieldQuery.html">FieldQuery</a></td> |
| <td><span class="parametername">fieldQuery</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldQuery.html">FieldQuery</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p><span class="xref">Lucene.Net.Index.IndexReader</span> of the index</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docId</span></td> |
| <td><p>document id to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td><p>field of the document to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">fragCharSize</span></td> |
| <td><p>the length (number of chars) of a fragment</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 best fragment (snippet) string</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>If there is a low-level I/O error</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_Search_VectorHighlight_FastVectorHighlighter_GetBestFragment_Lucene_Net_Search_VectorHighlight_FieldQuery_Lucene_Net_Index_IndexReader_System_Int32_System_String_System_Int32_Lucene_Net_Search_VectorHighlight_IFragListBuilder_Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_System_String___System_String___Lucene_Net_Search_Highlight_IEncoder_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragment(Lucene.Net.Search.VectorHighlight.FieldQuery%2CLucene.Net.Index.IndexReader%2CSystem.Int32%2CSystem.String%2CSystem.Int32%2CLucene.Net.Search.VectorHighlight.IFragListBuilder%2CLucene.Net.Search.VectorHighlight.IFragmentsBuilder%2CSystem.String%5B%5D%2CSystem.String%5B%5D%2CLucene.Net.Search.Highlight.IEncoder)%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L159">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetBestFragment_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragment*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetBestFragment_Lucene_Net_Search_VectorHighlight_FieldQuery_Lucene_Net_Index_IndexReader_System_Int32_System_String_System_Int32_Lucene_Net_Search_VectorHighlight_IFragListBuilder_Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_System_String___System_String___Lucene_Net_Search_Highlight_IEncoder_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragment(Lucene.Net.Search.VectorHighlight.FieldQuery,Lucene.Net.Index.IndexReader,System.Int32,System.String,System.Int32,Lucene.Net.Search.VectorHighlight.IFragListBuilder,Lucene.Net.Search.VectorHighlight.IFragmentsBuilder,System.String[],System.String[],Lucene.Net.Search.Highlight.IEncoder)">GetBestFragment(FieldQuery, IndexReader, Int32, String, Int32, IFragListBuilder, IFragmentsBuilder, String[], String[], IEncoder)</h4> |
| <div class="markdown level1 summary"><p>return the best fragment.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string GetBestFragment(FieldQuery fieldQuery, IndexReader reader, int docId, string fieldName, int fragCharSize, IFragListBuilder fragListBuilder, IFragmentsBuilder fragmentsBuilder, string[] preTags, string[] postTags, IEncoder encoder)</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.Search.VectorHighlight.FieldQuery.html">FieldQuery</a></td> |
| <td><span class="parametername">fieldQuery</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldQuery.html">FieldQuery</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p><span class="xref">Lucene.Net.Index.IndexReader</span> of the index</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docId</span></td> |
| <td><p>document id to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td><p>field of the document to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">fragCharSize</span></td> |
| <td><p>the length (number of chars) of a fragment</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragListBuilder.html">IFragListBuilder</a></td> |
| <td><span class="parametername">fragListBuilder</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragListBuilder.html">IFragListBuilder</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a></td> |
| <td><span class="parametername">fragmentsBuilder</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">preTags</span></td> |
| <td><p>pre-tags to be used to highlight terms</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">postTags</span></td> |
| <td><p>post-tags to be used to highlight terms</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Highlight.IEncoder.html">IEncoder</a></td> |
| <td><span class="parametername">encoder</span></td> |
| <td><p>an encoder that generates encoded text</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 best fragment (snippet) string</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>If there is a low-level I/O error</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_Search_VectorHighlight_FastVectorHighlighter_GetBestFragments_Lucene_Net_Search_VectorHighlight_FieldQuery_Lucene_Net_Index_IndexReader_System_Int32_System_String_System_Collections_Generic_ISet_System_String__System_Int32_System_Int32_Lucene_Net_Search_VectorHighlight_IFragListBuilder_Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_System_String___System_String___Lucene_Net_Search_Highlight_IEncoder_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragments(Lucene.Net.Search.VectorHighlight.FieldQuery%2CLucene.Net.Index.IndexReader%2CSystem.Int32%2CSystem.String%2CSystem.Collections.Generic.ISet%7BSystem.String%7D%2CSystem.Int32%2CSystem.Int32%2CLucene.Net.Search.VectorHighlight.IFragListBuilder%2CLucene.Net.Search.VectorHighlight.IFragmentsBuilder%2CSystem.String%5B%5D%2CSystem.String%5B%5D%2CLucene.Net.Search.Highlight.IEncoder)%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L222">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetBestFragments_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragments*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetBestFragments_Lucene_Net_Search_VectorHighlight_FieldQuery_Lucene_Net_Index_IndexReader_System_Int32_System_String_System_Collections_Generic_ISet_System_String__System_Int32_System_Int32_Lucene_Net_Search_VectorHighlight_IFragListBuilder_Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_System_String___System_String___Lucene_Net_Search_Highlight_IEncoder_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragments(Lucene.Net.Search.VectorHighlight.FieldQuery,Lucene.Net.Index.IndexReader,System.Int32,System.String,System.Collections.Generic.ISet{System.String},System.Int32,System.Int32,Lucene.Net.Search.VectorHighlight.IFragListBuilder,Lucene.Net.Search.VectorHighlight.IFragmentsBuilder,System.String[],System.String[],Lucene.Net.Search.Highlight.IEncoder)">GetBestFragments(FieldQuery, IndexReader, Int32, String, ISet<String>, Int32, Int32, IFragListBuilder, IFragmentsBuilder, String[], String[], IEncoder)</h4> |
| <div class="markdown level1 summary"><p>Return the best fragments. Matches are scanned from <code data-dev-comment-type="paramref" class="paramref">matchedFields</code> and turned into fragments against |
| <code data-dev-comment-type="paramref" class="paramref">storedField</code>. The highlighting may not make sense if <code data-dev-comment-type="paramref" class="paramref">matchedFields</code> has matches with offsets that don't |
| correspond features in <code data-dev-comment-type="paramref" class="paramref">storedField</code>. It will outright throw a <span class="xref">System.IndexOutOfRangeException</span> |
| if <code data-dev-comment-type="paramref" class="paramref">matchedFields</code> produces offsets outside of <code data-dev-comment-type="paramref" class="paramref">storedField</code>. As such it is advisable that all |
| <code data-dev-comment-type="paramref" class="paramref">matchedFields</code> share the same source as <code data-dev-comment-type="paramref" class="paramref">storedField</code> or are at least a prefix of it.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string[] GetBestFragments(FieldQuery fieldQuery, IndexReader reader, int docId, string storedField, ISet<string> matchedFields, int fragCharSize, int maxNumFragments, IFragListBuilder fragListBuilder, IFragmentsBuilder fragmentsBuilder, string[] preTags, string[] postTags, IEncoder encoder)</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.Search.VectorHighlight.FieldQuery.html">FieldQuery</a></td> |
| <td><span class="parametername">fieldQuery</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldQuery.html">FieldQuery</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p><span class="xref">Lucene.Net.Index.IndexReader</span> of the index</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docId</span></td> |
| <td><p>document id to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">storedField</span></td> |
| <td><p>field of the document that stores the text</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.ISet</span><<span class="xref">System.String</span>></td> |
| <td><span class="parametername">matchedFields</span></td> |
| <td><p>fields of the document to scan for matches</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">fragCharSize</span></td> |
| <td><p>the length (number of chars) of a fragment</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxNumFragments</span></td> |
| <td><p>maximum number of fragments</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragListBuilder.html">IFragListBuilder</a></td> |
| <td><span class="parametername">fragListBuilder</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragListBuilder.html">IFragListBuilder</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a></td> |
| <td><span class="parametername">fragmentsBuilder</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">preTags</span></td> |
| <td><p>pre-tags to be used to highlight terms</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">postTags</span></td> |
| <td><p>post-tags to be used to highlight terms</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Highlight.IEncoder.html">IEncoder</a></td> |
| <td><span class="parametername">encoder</span></td> |
| <td><p>an encoder that generates encoded text</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>created fragments or null when no fragments created. |
| size of the array can be less than <code data-dev-comment-type="paramref" class="paramref">maxNumFragments</code></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>If there is a low-level I/O error</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_Search_VectorHighlight_FastVectorHighlighter_GetBestFragments_Lucene_Net_Search_VectorHighlight_FieldQuery_Lucene_Net_Index_IndexReader_System_Int32_System_String_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragments(Lucene.Net.Search.VectorHighlight.FieldQuery%2CLucene.Net.Index.IndexReader%2CSystem.Int32%2CSystem.String%2CSystem.Int32%2CSystem.Int32)%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L136">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetBestFragments_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragments*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetBestFragments_Lucene_Net_Search_VectorHighlight_FieldQuery_Lucene_Net_Index_IndexReader_System_Int32_System_String_System_Int32_System_Int32_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragments(Lucene.Net.Search.VectorHighlight.FieldQuery,Lucene.Net.Index.IndexReader,System.Int32,System.String,System.Int32,System.Int32)">GetBestFragments(FieldQuery, IndexReader, Int32, String, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>return the best fragments.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string[] GetBestFragments(FieldQuery fieldQuery, IndexReader reader, int docId, string fieldName, int fragCharSize, int maxNumFragments)</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.Search.VectorHighlight.FieldQuery.html">FieldQuery</a></td> |
| <td><span class="parametername">fieldQuery</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldQuery.html">FieldQuery</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p><span class="xref">Lucene.Net.Index.IndexReader</span> of the index</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docId</span></td> |
| <td><p>document id to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td><p>field of the document to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">fragCharSize</span></td> |
| <td><p>the length (number of chars) of a fragment</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxNumFragments</span></td> |
| <td><p>maximum number of fragments</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>created fragments or null when no fragments created. |
| size of the array can be less than maxNumFragments</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>If there is a low-level I/O error</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_Search_VectorHighlight_FastVectorHighlighter_GetBestFragments_Lucene_Net_Search_VectorHighlight_FieldQuery_Lucene_Net_Index_IndexReader_System_Int32_System_String_System_Int32_System_Int32_Lucene_Net_Search_VectorHighlight_IFragListBuilder_Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_System_String___System_String___Lucene_Net_Search_Highlight_IEncoder_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragments(Lucene.Net.Search.VectorHighlight.FieldQuery%2CLucene.Net.Index.IndexReader%2CSystem.Int32%2CSystem.String%2CSystem.Int32%2CSystem.Int32%2CLucene.Net.Search.VectorHighlight.IFragListBuilder%2CLucene.Net.Search.VectorHighlight.IFragmentsBuilder%2CSystem.String%5B%5D%2CSystem.String%5B%5D%2CLucene.Net.Search.Highlight.IEncoder)%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L187">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetBestFragments_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragments*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetBestFragments_Lucene_Net_Search_VectorHighlight_FieldQuery_Lucene_Net_Index_IndexReader_System_Int32_System_String_System_Int32_System_Int32_Lucene_Net_Search_VectorHighlight_IFragListBuilder_Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_System_String___System_String___Lucene_Net_Search_Highlight_IEncoder_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetBestFragments(Lucene.Net.Search.VectorHighlight.FieldQuery,Lucene.Net.Index.IndexReader,System.Int32,System.String,System.Int32,System.Int32,Lucene.Net.Search.VectorHighlight.IFragListBuilder,Lucene.Net.Search.VectorHighlight.IFragmentsBuilder,System.String[],System.String[],Lucene.Net.Search.Highlight.IEncoder)">GetBestFragments(FieldQuery, IndexReader, Int32, String, Int32, Int32, IFragListBuilder, IFragmentsBuilder, String[], String[], IEncoder)</h4> |
| <div class="markdown level1 summary"><p>return the best fragments.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string[] GetBestFragments(FieldQuery fieldQuery, IndexReader reader, int docId, string fieldName, int fragCharSize, int maxNumFragments, IFragListBuilder fragListBuilder, IFragmentsBuilder fragmentsBuilder, string[] preTags, string[] postTags, IEncoder encoder)</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.Search.VectorHighlight.FieldQuery.html">FieldQuery</a></td> |
| <td><span class="parametername">fieldQuery</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldQuery.html">FieldQuery</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p><span class="xref">Lucene.Net.Index.IndexReader</span> of the index</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docId</span></td> |
| <td><p>document id to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td><p>field of the document to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">fragCharSize</span></td> |
| <td><p>the length (number of chars) of a fragment</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxNumFragments</span></td> |
| <td><p>maximum number of fragments</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragListBuilder.html">IFragListBuilder</a></td> |
| <td><span class="parametername">fragListBuilder</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragListBuilder.html">IFragListBuilder</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a></td> |
| <td><span class="parametername">fragmentsBuilder</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">preTags</span></td> |
| <td><p>pre-tags to be used to highlight terms</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">postTags</span></td> |
| <td><p>post-tags to be used to highlight terms</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Highlight.IEncoder.html">IEncoder</a></td> |
| <td><span class="parametername">encoder</span></td> |
| <td><p>an encoder that generates encoded text</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>created fragments or null when no fragments created. |
| size of the array can be less than maxNumFragments</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>If there is a low-level I/O error</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_Search_VectorHighlight_FastVectorHighlighter_GetFieldQuery_Lucene_Net_Search_Query_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetFieldQuery(Lucene.Net.Search.Query)%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L78">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetFieldQuery_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetFieldQuery*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetFieldQuery_Lucene_Net_Search_Query_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetFieldQuery(Lucene.Net.Search.Query)">GetFieldQuery(Query)</h4> |
| <div class="markdown level1 summary"><p>create a <a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldQuery.html">FieldQuery</a> object.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual FieldQuery GetFieldQuery(Query query)</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">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p>a query</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.Search.VectorHighlight.FieldQuery.html">FieldQuery</a></td> |
| <td><p>the created <a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldQuery.html">FieldQuery</a> object</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_Search_VectorHighlight_FastVectorHighlighter_GetFieldQuery_Lucene_Net_Search_Query_Lucene_Net_Index_IndexReader_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetFieldQuery(Lucene.Net.Search.Query%2CLucene.Net.Index.IndexReader)%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L99">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetFieldQuery_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetFieldQuery*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_FastVectorHighlighter_GetFieldQuery_Lucene_Net_Search_Query_Lucene_Net_Index_IndexReader_" data-uid="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.GetFieldQuery(Lucene.Net.Search.Query,Lucene.Net.Index.IndexReader)">GetFieldQuery(Query, IndexReader)</h4> |
| <div class="markdown level1 summary"><p>create a <a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldQuery.html">FieldQuery</a> object.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual FieldQuery GetFieldQuery(Query query, IndexReader reader)</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">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p>a query</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td></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.Search.VectorHighlight.FieldQuery.html">FieldQuery</a></td> |
| <td><p>the created <a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldQuery.html">FieldQuery</a> object</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </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_Search_VectorHighlight_FastVectorHighlighter.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.FastVectorHighlighter%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.Highlighter/VectorHighlight/FastVectorHighlighter.cs/#L29" 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> |
