| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.3"/> |
| <title>Lucene.Net: Lucene.Net.Search.Highlight.WeightedSpanTermExtractor Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="Index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Packages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search.html">Search</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search_1_1_highlight.html">Highlight</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html">WeightedSpanTermExtractor</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.Highlight.WeightedSpanTermExtractor Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Class used to extract <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html" title="Lightweight class to hold term, Weight, and positions used for scoring this term. ...">WeightedSpanTerm</a>s from a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> based on whether <a class="el" href="_wildcard_term_enum_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a>s from the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> are contained in a supplied <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">Analysis.TokenStream</a>. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><b>FakeReader</b></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A fake IndexReader class to extract the field from a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_multi_term_query.html" title="An abstract Query that matches documents containing a subset of terms provided by a FilteredTermEnum ...">MultiTermQuery</a> <br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a1f14885287be2f4d4b5875836092022f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html#a1f14885287be2f4d4b5875836092022f">WeightedSpanTermExtractor</a> ()</td></tr> |
| <tr class="separator:a1f14885287be2f4d4b5875836092022f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac8c5e5f455ee70d694c521d3ed4e40a3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html#ac8c5e5f455ee70d694c521d3ed4e40a3">WeightedSpanTermExtractor</a> (String defaultField)</td></tr> |
| <tr class="separator:ac8c5e5f455ee70d694c521d3ed4e40a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acca0a80d054646ac0656ea53b9822358"><td class="memItemLeft" align="right" valign="top">IDictionary< String, <br class="typebreak"/> |
| <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html#acca0a80d054646ac0656ea53b9822358">GetWeightedSpanTerms</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> tokenStream)</td></tr> |
| <tr class="memdesc:acca0a80d054646ac0656ea53b9822358"><td class="mdescLeft"> </td><td class="mdescRight">Creates a Map of <code>WeightedSpanTerms</code> from the given <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a></code> and <code>TokenStream</code>. <a href="#acca0a80d054646ac0656ea53b9822358"></a><br/></td></tr> |
| <tr class="separator:acca0a80d054646ac0656ea53b9822358"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a258451e9a563cd1ee4b33dd17fa8a385"><td class="memItemLeft" align="right" valign="top">IDictionary< String, <br class="typebreak"/> |
| <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html#a258451e9a563cd1ee4b33dd17fa8a385">GetWeightedSpanTerms</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> tokenStream, String fieldName)</td></tr> |
| <tr class="memdesc:a258451e9a563cd1ee4b33dd17fa8a385"><td class="mdescLeft"> </td><td class="mdescRight">Creates a Map of <code>WeightedSpanTerms</code> from the given <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a></code> and <code>TokenStream</code>. <a href="#a258451e9a563cd1ee4b33dd17fa8a385"></a><br/></td></tr> |
| <tr class="separator:a258451e9a563cd1ee4b33dd17fa8a385"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af5836698c81fc84ff823fc8b8c41cc34"><td class="memItemLeft" align="right" valign="top">IDictionary< String, <br class="typebreak"/> |
| <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html#af5836698c81fc84ff823fc8b8c41cc34">GetWeightedSpanTermsWithScores</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> tokenStream, String fieldName, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader)</td></tr> |
| <tr class="memdesc:af5836698c81fc84ff823fc8b8c41cc34"><td class="mdescLeft"> </td><td class="mdescRight">Creates a Map of <code>WeightedSpanTerms</code> from the given <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a></code> and <code>TokenStream</code>. Uses a supplied <code>IndexReader</code> to properly <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a> terms (for gradient highlighting). <a href="#af5836698c81fc84ff823fc8b8c41cc34"></a><br/></td></tr> |
| <tr class="separator:af5836698c81fc84ff823fc8b8c41cc34"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a12ad83afd5a2d32ff999006ff878dc38"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html#a12ad83afd5a2d32ff999006ff878dc38">SetWrapIfNotCachingTokenFilter</a> (bool wrap)</td></tr> |
| <tr class="memdesc:a12ad83afd5a2d32ff999006ff878dc38"><td class="mdescLeft"> </td><td class="mdescRight">By default, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">Analysis.TokenStream</a>s that are not of the type <a class="el" href="_query_parser_8cs.html#a6b125de7dbff35724b7a50ca1188b182">CachingTokenFilter</a> are wrapped in a <a class="el" href="_query_parser_8cs.html#a6b125de7dbff35724b7a50ca1188b182">CachingTokenFilter</a> to <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">Analysis.TokenStream</a> impl and you don't want it to be wrapped, set this to false. <a href="#a12ad83afd5a2d32ff999006ff878dc38"></a><br/></td></tr> |
| <tr class="separator:a12ad83afd5a2d32ff999006ff878dc38"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a1b31a52f88204985178611c4b378094e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html#a1b31a52f88204985178611c4b378094e">ExpandMultiTermQuery</a><code> [get, set]</code></td></tr> |
| <tr class="separator:a1b31a52f88204985178611c4b378094e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acba59439ac03cf587714a685e7463f54"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html#acba59439ac03cf587714a685e7463f54">IsCachedTokenStream</a><code> [get]</code></td></tr> |
| <tr class="separator:acba59439ac03cf587714a685e7463f54"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a58dcf356bc1f1be929c8f22657f2d7ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term_extractor.html#a58dcf356bc1f1be929c8f22657f2d7ff">TokenStream</a><code> [get]</code></td></tr> |
| <tr class="separator:a58dcf356bc1f1be929c8f22657f2d7ff"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Class used to extract <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html" title="Lightweight class to hold term, Weight, and positions used for scoring this term. ...">WeightedSpanTerm</a>s from a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> based on whether <a class="el" href="_wildcard_term_enum_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a>s from the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> are contained in a supplied <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">Analysis.TokenStream</a>. </p> |
| |
| <p>Definition at line <a class="el" href="_weighted_span_term_extractor_8cs_source.html#l00041">41</a> of file <a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a1f14885287be2f4d4b5875836092022f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.WeightedSpanTermExtractor </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_weighted_span_term_extractor_8cs_source.html#l00051">51</a> of file <a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac8c5e5f455ee70d694c521d3ed4e40a3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.WeightedSpanTermExtractor </td> |
| <td>(</td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>defaultField</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_weighted_span_term_extractor_8cs_source.html#l00055">55</a> of file <a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="acca0a80d054646ac0656ea53b9822358"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IDictionary<String, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</a>> Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTerms </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> </td> |
| <td class="paramname"><em>query</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td> |
| <td class="paramname"><em>tokenStream</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a Map of <code>WeightedSpanTerms</code> from the given <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a></code> and <code>TokenStream</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">query</td><td>query that caused hit</td></tr> |
| <tr><td class="paramname">tokenStream</td><td>TokenStream of text to be highlighted</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Map containing WeightedSpanTerms</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_weighted_span_term_extractor_8cs_source.html#l00392">392</a> of file <a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a258451e9a563cd1ee4b33dd17fa8a385"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IDictionary<String, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</a>> Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTerms </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> </td> |
| <td class="paramname"><em>query</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td> |
| <td class="paramname"><em>tokenStream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>fieldName</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a Map of <code>WeightedSpanTerms</code> from the given <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a></code> and <code>TokenStream</code>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">query</td><td>query that caused hit</td></tr> |
| <tr><td class="paramname">tokenStream</td><td>tokenStream of text to be highlighted</td></tr> |
| <tr><td class="paramname">fieldName</td><td>restricts Term's used based on field name</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Map containing WeightedSpanTerms</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_weighted_span_term_extractor_8cs_source.html#l00405">405</a> of file <a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af5836698c81fc84ff823fc8b8c41cc34"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">IDictionary<String, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</a>> Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.GetWeightedSpanTermsWithScores </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> </td> |
| <td class="paramname"><em>query</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td> |
| <td class="paramname"><em>tokenStream</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>fieldName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> </td> |
| <td class="paramname"><em>reader</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a Map of <code>WeightedSpanTerms</code> from the given <code><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a></code> and <code>TokenStream</code>. Uses a supplied <code>IndexReader</code> to properly <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_weight.html" title="Expert: Calculate query weights and build query scorers. The purpose of Weight is to ensure searching...">Weight</a> terms (for gradient highlighting). </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">query</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> that caused hit</td></tr> |
| <tr><td class="paramname">tokenStream</td><td>Tokenstream of text to be highlighted</td></tr> |
| <tr><td class="paramname">fieldName</td><td>restricts Term's used based on field name</td></tr> |
| <tr><td class="paramname">reader</td><td>to use for scoring</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Map of WeightedSpanTerms with quasi tf/idf scores</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_weighted_span_term_extractor_8cs_source.html#l00440">440</a> of file <a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a12ad83afd5a2d32ff999006ff878dc38"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.SetWrapIfNotCachingTokenFilter </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>wrap</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>By default, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">Analysis.TokenStream</a>s that are not of the type <a class="el" href="_query_parser_8cs.html#a6b125de7dbff35724b7a50ca1188b182">CachingTokenFilter</a> are wrapped in a <a class="el" href="_query_parser_8cs.html#a6b125de7dbff35724b7a50ca1188b182">CachingTokenFilter</a> to <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html" title="A TokenStream enumerates the sequence of tokens, either from Fields of a Document or from query text...">Analysis.TokenStream</a> impl and you don't want it to be wrapped, set this to false. </p> |
| |
| <p>Definition at line <a class="el" href="_weighted_span_term_extractor_8cs_source.html#l00635">635</a> of file <a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a1b31a52f88204985178611c4b378094e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.ExpandMultiTermQuery</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_weighted_span_term_extractor_8cs_source.html#l00613">613</a> of file <a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acba59439ac03cf587714a685e7463f54"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.IsCachedTokenStream</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_weighted_span_term_extractor_8cs_source.html#l00619">619</a> of file <a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a58dcf356bc1f1be929c8f22657f2d7ff"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Search.Highlight.WeightedSpanTermExtractor.TokenStream</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_weighted_span_term_extractor_8cs_source.html#l00624">624</a> of file <a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>contrib/Highlighter/<a class="el" href="_weighted_span_term_extractor_8cs_source.html">WeightedSpanTermExtractor.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:58 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
