| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class WeightedSpanTermExtractor |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class WeightedSpanTermExtractor |
| | 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.Highlight.WeightedSpanTermExtractor"> |
| |
| |
| <h1 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor" class="text-break">Class WeightedSpanTermExtractor |
| </h1> |
| <div class="markdown level0 summary"><p>Class used to extract <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>s from a <span class="xref">Lucene.Net.Search.Query</span> based on whether |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Index.Term.html">Term</a>s from the <span class="xref">Lucene.Net.Search.Query</span> are contained in a supplied <span class="xref">Lucene.Net.Analysis.TokenStream</span>.</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">WeightedSpanTermExtractor</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.Highlight.html">Lucene.Net.Search.Highlight</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Highlighter.dll</h6> |
| <h5 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class WeightedSpanTermExtractor</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_Highlight_WeightedSpanTermExtractor__ctor.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.%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/Highlight/WeightedSpanTermExtractor.cs/#L48">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor__ctor_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor__ctor" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.#ctor">WeightedSpanTermExtractor()</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 WeightedSpanTermExtractor()</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_Highlight_WeightedSpanTermExtractor__ctor_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.%23ctor(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.Highlighter/Highlight/WeightedSpanTermExtractor.cs/#L52">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor__ctor_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor__ctor_System_String_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.#ctor(System.String)">WeightedSpanTermExtractor(String)</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 WeightedSpanTermExtractor(string defaultField)</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">defaultField</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_Highlight_WeightedSpanTermExtractor_ExpandMultiTermQuery.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExpandMultiTermQuery%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/Highlight/WeightedSpanTermExtractor.cs/#L725">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_ExpandMultiTermQuery_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExpandMultiTermQuery*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_ExpandMultiTermQuery" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExpandMultiTermQuery">ExpandMultiTermQuery</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 virtual bool ExpandMultiTermQuery { 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.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_Highlight_WeightedSpanTermExtractor_IsCachedTokenStream.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.IsCachedTokenStream%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/Highlight/WeightedSpanTermExtractor.cs/#L731">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_IsCachedTokenStream_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.IsCachedTokenStream*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_IsCachedTokenStream" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.IsCachedTokenStream">IsCachedTokenStream</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 virtual bool IsCachedTokenStream { 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_Highlight_WeightedSpanTermExtractor_TokenStream.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.TokenStream%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/Highlight/WeightedSpanTermExtractor.cs/#L733">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_TokenStream_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.TokenStream*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_TokenStream" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.TokenStream">TokenStream</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 virtual TokenStream TokenStream { 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">Lucene.Net.Analysis.TokenStream</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_Highlight_WeightedSpanTermExtractor_CollectSpanQueryFields_Lucene_Net_Search_Spans_SpanQuery_System_Collections_Generic_ISet_System_String__.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.CollectSpanQueryFields(Lucene.Net.Search.Spans.SpanQuery%2CSystem.Collections.Generic.ISet%7BSystem.String%7D)%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/Highlight/WeightedSpanTermExtractor.cs/#L543">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_CollectSpanQueryFields_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.CollectSpanQueryFields*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_CollectSpanQueryFields_Lucene_Net_Search_Spans_SpanQuery_System_Collections_Generic_ISet_System_String__" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.CollectSpanQueryFields(Lucene.Net.Search.Spans.SpanQuery,System.Collections.Generic.ISet{System.String})">CollectSpanQueryFields(SpanQuery, ISet<String>)</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">protected virtual void CollectSpanQueryFields(SpanQuery spanQuery, ISet<string> fieldNames)</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.Spans.SpanQuery</span></td> |
| <td><span class="parametername">spanQuery</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.ISet</span><<span class="xref">System.String</span>></td> |
| <td><span class="parametername">fieldNames</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_Highlight_WeightedSpanTermExtractor_Extract_Lucene_Net_Search_Query_System_Collections_Generic_IDictionary_System_String_Lucene_Net_Search_Highlight_WeightedSpanTerm__.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.Extract(Lucene.Net.Search.Query%2CSystem.Collections.Generic.IDictionary%7BSystem.String%2CLucene.Net.Search.Highlight.WeightedSpanTerm%7D)%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/Highlight/WeightedSpanTermExtractor.cs/#L66">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_Extract_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.Extract*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_Extract_Lucene_Net_Search_Query_System_Collections_Generic_IDictionary_System_String_Lucene_Net_Search_Highlight_WeightedSpanTerm__" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.Extract(Lucene.Net.Search.Query,System.Collections.Generic.IDictionary{System.String,Lucene.Net.Search.Highlight.WeightedSpanTerm})">Extract(Query, IDictionary<String, WeightedSpanTerm>)</h4> |
| <div class="markdown level1 summary"><p>Fills a <see cref="T:IDictionary{string, WeightedSpanTerm}"></see> with <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>s using the terms from the supplied <code data-dev-comment-type="paramref" class="paramref">query</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void Extract(Query query, IDictionary<string, WeightedSpanTerm> terms)</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><span class="xref">Lucene.Net.Search.Query</span> to extract Terms from</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>></td> |
| <td><span class="parametername">terms</span></td> |
| <td><p>Map to place created <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>s in</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_Highlight_WeightedSpanTermExtractor_ExtractUnknownQuery_Lucene_Net_Search_Query_System_Collections_Generic_IDictionary_System_String_Lucene_Net_Search_Highlight_WeightedSpanTerm__.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExtractUnknownQuery(Lucene.Net.Search.Query%2CSystem.Collections.Generic.IDictionary%7BSystem.String%2CLucene.Net.Search.Highlight.WeightedSpanTerm%7D)%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/Highlight/WeightedSpanTermExtractor.cs/#L235">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_ExtractUnknownQuery_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExtractUnknownQuery*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_ExtractUnknownQuery_Lucene_Net_Search_Query_System_Collections_Generic_IDictionary_System_String_Lucene_Net_Search_Highlight_WeightedSpanTerm__" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExtractUnknownQuery(Lucene.Net.Search.Query,System.Collections.Generic.IDictionary{System.String,Lucene.Net.Search.Highlight.WeightedSpanTerm})">ExtractUnknownQuery(Query, IDictionary<String, WeightedSpanTerm>)</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">protected virtual void ExtractUnknownQuery(Query query, IDictionary<string, WeightedSpanTerm> terms)</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></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>></td> |
| <td><span class="parametername">terms</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_Highlight_WeightedSpanTermExtractor_ExtractWeightedSpanTerms_System_Collections_Generic_IDictionary_System_String_Lucene_Net_Search_Highlight_WeightedSpanTerm__Lucene_Net_Search_Spans_SpanQuery_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExtractWeightedSpanTerms(System.Collections.Generic.IDictionary%7BSystem.String%2CLucene.Net.Search.Highlight.WeightedSpanTerm%7D%2CLucene.Net.Search.Spans.SpanQuery)%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/Highlight/WeightedSpanTermExtractor.cs/#L247">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_ExtractWeightedSpanTerms_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExtractWeightedSpanTerms*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_ExtractWeightedSpanTerms_System_Collections_Generic_IDictionary_System_String_Lucene_Net_Search_Highlight_WeightedSpanTerm__Lucene_Net_Search_Spans_SpanQuery_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExtractWeightedSpanTerms(System.Collections.Generic.IDictionary{System.String,Lucene.Net.Search.Highlight.WeightedSpanTerm},Lucene.Net.Search.Spans.SpanQuery)">ExtractWeightedSpanTerms(IDictionary<String, WeightedSpanTerm>, SpanQuery)</h4> |
| <div class="markdown level1 summary"><p>Fills a <see cref="T:IDictionary{string, WeightedSpanTerm}"></see> with <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>s using the terms from the supplied <span class="xref">Lucene.Net.Search.Spans.SpanQuery</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void ExtractWeightedSpanTerms(IDictionary<string, WeightedSpanTerm> terms, SpanQuery spanQuery)</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.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>></td> |
| <td><span class="parametername">terms</span></td> |
| <td><p><see cref="T:IDictionary{string, WeightedSpanTerm}"></see> to place created <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>s in</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Spans.SpanQuery</span></td> |
| <td><span class="parametername">spanQuery</span></td> |
| <td><p><span class="xref">Lucene.Net.Search.Spans.SpanQuery</span> to extract Terms from</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_Highlight_WeightedSpanTermExtractor_ExtractWeightedTerms_System_Collections_Generic_IDictionary_System_String_Lucene_Net_Search_Highlight_WeightedSpanTerm__Lucene_Net_Search_Query_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExtractWeightedTerms(System.Collections.Generic.IDictionary%7BSystem.String%2CLucene.Net.Search.Highlight.WeightedSpanTerm%7D%2CLucene.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/Highlight/WeightedSpanTermExtractor.cs/#L348">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_ExtractWeightedTerms_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExtractWeightedTerms*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_ExtractWeightedTerms_System_Collections_Generic_IDictionary_System_String_Lucene_Net_Search_Highlight_WeightedSpanTerm__Lucene_Net_Search_Query_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExtractWeightedTerms(System.Collections.Generic.IDictionary{System.String,Lucene.Net.Search.Highlight.WeightedSpanTerm},Lucene.Net.Search.Query)">ExtractWeightedTerms(IDictionary<String, WeightedSpanTerm>, Query)</h4> |
| <div class="markdown level1 summary"><p>Fills a <see cref="T:IDictionary{string, WeightedSpanTerm}"></see> with <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>s using the terms from |
| the supplied <span class="xref">Lucene.Net.Search.Spans.SpanQuery</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void ExtractWeightedTerms(IDictionary<string, WeightedSpanTerm> terms, 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">System.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>></td> |
| <td><span class="parametername">terms</span></td> |
| <td><p><see cref="T:IDictionary{string, WeightedSpanTerm}"></see> to place created <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>s in</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">query</span></td> |
| <td><p><span class="xref">Lucene.Net.Search.Query</span> to extract Terms from</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_Highlight_WeightedSpanTermExtractor_FieldNameComparer_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.FieldNameComparer(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.Highlighter/Highlight/WeightedSpanTermExtractor.cs/#L367">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_FieldNameComparer_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.FieldNameComparer*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_FieldNameComparer_System_String_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.FieldNameComparer(System.String)">FieldNameComparer(String)</h4> |
| <div class="markdown level1 summary"><p>Necessary to implement matches for queries against <span class="xref">Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.defaultField</span></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual bool FieldNameComparer(string fieldNameToCheck)</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">fieldNameToCheck</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><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_Highlight_WeightedSpanTermExtractor_GetLeafContext.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetLeafContext%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/Highlight/WeightedSpanTermExtractor.cs/#L374">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_GetLeafContext_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetLeafContext*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_GetLeafContext" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetLeafContext">GetLeafContext()</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">protected virtual AtomicReaderContext GetLeafContext()</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">Lucene.Net.Index.AtomicReaderContext</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_Highlight_WeightedSpanTermExtractor_GetWeightedSpanTerms_Lucene_Net_Search_Query_Lucene_Net_Analysis_TokenStream_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTerms(Lucene.Net.Search.Query%2CLucene.Net.Analysis.TokenStream)%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/Highlight/WeightedSpanTermExtractor.cs/#L460">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_GetWeightedSpanTerms_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTerms*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_GetWeightedSpanTerms_Lucene_Net_Search_Query_Lucene_Net_Analysis_TokenStream_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTerms(Lucene.Net.Search.Query,Lucene.Net.Analysis.TokenStream)">GetWeightedSpanTerms(Query, TokenStream)</h4> |
| <div class="markdown level1 summary"><p>Creates an <see cref="T:IDictionary{string, WeightedSpanTerm}"></see> from the given <span class="xref">Lucene.Net.Search.Query</span> and <span class="xref">Lucene.Net.Analysis.TokenStream</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IDictionary<string, WeightedSpanTerm> GetWeightedSpanTerms(Query query, TokenStream tokenStream)</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><span class="xref">Lucene.Net.Search.Query</span> that caused hit</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.TokenStream</span></td> |
| <td><span class="parametername">tokenStream</span></td> |
| <td><p><span class="xref">Lucene.Net.Analysis.TokenStream</span> of text to be highlighted</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.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>></td> |
| <td><p>Map containing <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>s</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_Highlight_WeightedSpanTermExtractor_GetWeightedSpanTerms_Lucene_Net_Search_Query_Lucene_Net_Analysis_TokenStream_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTerms(Lucene.Net.Search.Query%2CLucene.Net.Analysis.TokenStream%2CSystem.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.Highlighter/Highlight/WeightedSpanTermExtractor.cs/#L474">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_GetWeightedSpanTerms_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTerms*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_GetWeightedSpanTerms_Lucene_Net_Search_Query_Lucene_Net_Analysis_TokenStream_System_String_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTerms(Lucene.Net.Search.Query,Lucene.Net.Analysis.TokenStream,System.String)">GetWeightedSpanTerms(Query, TokenStream, String)</h4> |
| <div class="markdown level1 summary"><p>Creates an <see cref="T:IDictionary{string, WeightedSpanTerm}"></see> from the given <span class="xref">Lucene.Net.Search.Query</span> and <span class="xref">Lucene.Net.Analysis.TokenStream</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IDictionary<string, WeightedSpanTerm> GetWeightedSpanTerms(Query query, TokenStream tokenStream, string fieldName)</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><span class="xref">Lucene.Net.Search.Query</span> that caused hit</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.TokenStream</span></td> |
| <td><span class="parametername">tokenStream</span></td> |
| <td><p><span class="xref">Lucene.Net.Analysis.TokenStream</span> of text to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td><p>restricts Term's used based on field name</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.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>></td> |
| <td><p>Map containing <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>s</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_Highlight_WeightedSpanTermExtractor_GetWeightedSpanTermsWithScores_Lucene_Net_Search_Query_Lucene_Net_Analysis_TokenStream_System_String_Lucene_Net_Index_IndexReader_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTermsWithScores(Lucene.Net.Search.Query%2CLucene.Net.Analysis.TokenStream%2CSystem.String%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/Highlight/WeightedSpanTermExtractor.cs/#L510">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_GetWeightedSpanTermsWithScores_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTermsWithScores*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_GetWeightedSpanTermsWithScores_Lucene_Net_Search_Query_Lucene_Net_Analysis_TokenStream_System_String_Lucene_Net_Index_IndexReader_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTermsWithScores(Lucene.Net.Search.Query,Lucene.Net.Analysis.TokenStream,System.String,Lucene.Net.Index.IndexReader)">GetWeightedSpanTermsWithScores(Query, TokenStream, String, IndexReader)</h4> |
| <div class="markdown level1 summary"><p>Creates an <see cref="T:IDictionary{string, WeightedSpanTerm}"></see> from the given <span class="xref">Lucene.Net.Search.Query</span> and <span class="xref">Lucene.Net.Analysis.TokenStream</span>. Uses a supplied |
| <span class="xref">Lucene.Net.Index.IndexReader</span> to properly Weight terms (for gradient highlighting).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IDictionary<string, WeightedSpanTerm> GetWeightedSpanTermsWithScores(Query query, TokenStream tokenStream, string fieldName, 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><span class="xref">Lucene.Net.Search.Query</span> that caused hit</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.TokenStream</span></td> |
| <td><span class="parametername">tokenStream</span></td> |
| <td><p><span class="xref">Lucene.Net.Analysis.TokenStream</span> of text to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td><p>restricts Term's used based on field name</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p>to use for scoring</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.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>></td> |
| <td><p>Map of <a class="xref" href="Lucene.Net.Search.Highlight.WeightedSpanTerm.html">WeightedSpanTerm</a>s with quasi tf/idf scores</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_Highlight_WeightedSpanTermExtractor_MustRewriteQuery_Lucene_Net_Search_Spans_SpanQuery_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.MustRewriteQuery(Lucene.Net.Search.Spans.SpanQuery)%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/Highlight/WeightedSpanTermExtractor.cs/#L577">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_MustRewriteQuery_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.MustRewriteQuery*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_MustRewriteQuery_Lucene_Net_Search_Spans_SpanQuery_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.MustRewriteQuery(Lucene.Net.Search.Spans.SpanQuery)">MustRewriteQuery(SpanQuery)</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">protected virtual bool MustRewriteQuery(SpanQuery spanQuery)</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.Spans.SpanQuery</span></td> |
| <td><span class="parametername">spanQuery</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><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_Highlight_WeightedSpanTermExtractor_SetMaxDocCharsToAnalyze_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.SetMaxDocCharsToAnalyze(System.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/Highlight/WeightedSpanTermExtractor.cs/#L746">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_SetMaxDocCharsToAnalyze_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.SetMaxDocCharsToAnalyze*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_SetMaxDocCharsToAnalyze_System_Int32_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.SetMaxDocCharsToAnalyze(System.Int32)">SetMaxDocCharsToAnalyze(Int32)</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">protected void SetMaxDocCharsToAnalyze(int maxDocCharsToAnalyze)</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.Int32</span></td> |
| <td><span class="parametername">maxDocCharsToAnalyze</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_Highlight_WeightedSpanTermExtractor_SetWrapIfNotCachingTokenFilter_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.SetWrapIfNotCachingTokenFilter(System.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/Highlight/WeightedSpanTermExtractor.cs/#L741">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_SetWrapIfNotCachingTokenFilter_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.SetWrapIfNotCachingTokenFilter*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_WeightedSpanTermExtractor_SetWrapIfNotCachingTokenFilter_System_Boolean_" data-uid="Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.SetWrapIfNotCachingTokenFilter(System.Boolean)">SetWrapIfNotCachingTokenFilter(Boolean)</h4> |
| <div class="markdown level1 summary"><p>By default, <span class="xref">Lucene.Net.Analysis.TokenStream</span>s that are not of the type |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CachingTokenFilter.html">CachingTokenFilter</a> are wrapped in a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.CachingTokenFilter.html">CachingTokenFilter</a> to |
| <span class="xref">Lucene.Net.Analysis.TokenStream</span> impl and you don't want it to be wrapped, set this to |
| false.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetWrapIfNotCachingTokenFilter(bool wrap)</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">wrap</span></td> |
| <td></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_Highlight_WeightedSpanTermExtractor.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.WeightedSpanTermExtractor%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/Highlight/WeightedSpanTermExtractor.cs/#L37" 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> |
