| <!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.Vectorhighlight.FastVectorHighlighter 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_vectorhighlight.html">Vectorhighlight</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fast_vector_highlighter.html">FastVectorHighlighter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fast_vector_highlighter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.Vectorhighlight.FastVectorHighlighter Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <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:a1a24d4b0dfe26c2326a7fb38b2538a85"><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_vectorhighlight_1_1_fast_vector_highlighter.html#a1a24d4b0dfe26c2326a7fb38b2538a85">FastVectorHighlighter</a> ()</td></tr> |
| <tr class="memdesc:a1a24d4b0dfe26c2326a7fb38b2538a85"><td class="mdescLeft"> </td><td class="mdescRight">the default constructor. <a href="#a1a24d4b0dfe26c2326a7fb38b2538a85"></a><br/></td></tr> |
| <tr class="separator:a1a24d4b0dfe26c2326a7fb38b2538a85"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a34f1234268720be75837487acc455ba7"><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_vectorhighlight_1_1_fast_vector_highlighter.html#a34f1234268720be75837487acc455ba7">FastVectorHighlighter</a> (bool phraseHighlight, bool fieldMatch)</td></tr> |
| <tr class="memdesc:a34f1234268720be75837487acc455ba7"><td class="mdescLeft"> </td><td class="mdescRight">a constructor. Using <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_simple_frag_list_builder.html" title="A simple implementation of FragListBuilder. ">SimpleFragListBuilder</a> and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_score_order_fragments_builder.html">ScoreOrderFragmentsBuilder</a>. <a href="#a34f1234268720be75837487acc455ba7"></a><br/></td></tr> |
| <tr class="separator:a34f1234268720be75837487acc455ba7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acb4892e9a34ac62be7e69fada11d1cf3"><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_vectorhighlight_1_1_fast_vector_highlighter.html#acb4892e9a34ac62be7e69fada11d1cf3">FastVectorHighlighter</a> (bool phraseHighlight, bool fieldMatch, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_frag_list_builder.html">FragListBuilder</a> fragListBuilder, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html">FragmentsBuilder</a> fragmentsBuilder)</td></tr> |
| <tr class="memdesc:acb4892e9a34ac62be7e69fada11d1cf3"><td class="mdescLeft"> </td><td class="mdescRight">a constructor. A <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_frag_list_builder.html">FragListBuilder</a> and a <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html" title="FragmentsBuilder is an interface for fragments (snippets) builder classes. A FragmentsBuilder class c...">FragmentsBuilder</a> can be specified (plugins). <a href="#acb4892e9a34ac62be7e69fada11d1cf3"></a><br/></td></tr> |
| <tr class="separator:acb4892e9a34ac62be7e69fada11d1cf3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af2fd778887cd701154ef717d82935168"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fast_vector_highlighter.html#af2fd778887cd701154ef717d82935168">GetFieldQuery</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query)</td></tr> |
| <tr class="memdesc:af2fd778887cd701154ef717d82935168"><td class="mdescLeft"> </td><td class="mdescRight">create a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> object. <a href="#af2fd778887cd701154ef717d82935168"></a><br/></td></tr> |
| <tr class="separator:af2fd778887cd701154ef717d82935168"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a220e7a66943b9772bc94cacfb036ff97"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fast_vector_highlighter.html#a220e7a66943b9772bc94cacfb036ff97">GetBestFragment</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> fieldQuery, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, String fieldName, int fragCharSize)</td></tr> |
| <tr class="memdesc:a220e7a66943b9772bc94cacfb036ff97"><td class="mdescLeft"> </td><td class="mdescRight">return the best fragment. <a href="#a220e7a66943b9772bc94cacfb036ff97"></a><br/></td></tr> |
| <tr class="separator:a220e7a66943b9772bc94cacfb036ff97"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6744b2918170b295dfd65f8e6c522149"><td class="memItemLeft" align="right" valign="top">String[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fast_vector_highlighter.html#a6744b2918170b295dfd65f8e6c522149">GetBestFragments</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> fieldQuery, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, String fieldName, int fragCharSize, int maxNumFragments)</td></tr> |
| <tr class="memdesc:a6744b2918170b295dfd65f8e6c522149"><td class="mdescLeft"> </td><td class="mdescRight">return the best fragments. <a href="#a6744b2918170b295dfd65f8e6c522149"></a><br/></td></tr> |
| <tr class="separator:a6744b2918170b295dfd65f8e6c522149"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1bec9500dd39dc44375102fddc40b8f4"><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_vectorhighlight_1_1_fast_vector_highlighter.html#a1bec9500dd39dc44375102fddc40b8f4">IsPhraseHighlight</a> ()</td></tr> |
| <tr class="memdesc:a1bec9500dd39dc44375102fddc40b8f4"><td class="mdescLeft"> </td><td class="mdescRight">return whether phraseHighlight or not. <a href="#a1bec9500dd39dc44375102fddc40b8f4"></a><br/></td></tr> |
| <tr class="separator:a1bec9500dd39dc44375102fddc40b8f4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae3f0876c6e5918709c9895bd5bf27e8b"><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_vectorhighlight_1_1_fast_vector_highlighter.html#ae3f0876c6e5918709c9895bd5bf27e8b">IsFieldMatch</a> ()</td></tr> |
| <tr class="memdesc:ae3f0876c6e5918709c9895bd5bf27e8b"><td class="mdescLeft"> </td><td class="mdescRight">return whether fieldMatch or not. <a href="#ae3f0876c6e5918709c9895bd5bf27e8b"></a><br/></td></tr> |
| <tr class="separator:ae3f0876c6e5918709c9895bd5bf27e8b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:aca1ca48b257a9513976ff0cf6490567b"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fast_vector_highlighter.html#aca1ca48b257a9513976ff0cf6490567b">DEFAULT_PHRASE_HIGHLIGHT</a> = true</td></tr> |
| <tr class="separator:aca1ca48b257a9513976ff0cf6490567b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa64e93e485b7c3ef91e74c2212d037c3"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fast_vector_highlighter.html#aa64e93e485b7c3ef91e74c2212d037c3">DEFAULT_FIELD_MATCH</a> = true</td></tr> |
| <tr class="separator:aa64e93e485b7c3ef91e74c2212d037c3"><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:ac9a45a4e32391a62c1d4c4487a7ab73c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fast_vector_highlighter.html#ac9a45a4e32391a62c1d4c4487a7ab73c">PhraseLimit</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:ac9a45a4e32391a62c1d4c4487a7ab73c"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of phrases to analyze when searching for the highest-scoring phrase. The default is 5000. To ensure that all phrases are analyzed, use a negative number or Integer.MAX_VALUE. <a href="#ac9a45a4e32391a62c1d4c4487a7ab73c"></a><br/></td></tr> |
| <tr class="separator:ac9a45a4e32391a62c1d4c4487a7ab73c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"> |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00026">26</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a1a24d4b0dfe26c2326a7fb38b2538a85"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.Vectorhighlight.FastVectorHighlighter.FastVectorHighlighter </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>the default constructor. </p> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00040">40</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a34f1234268720be75837487acc455ba7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.Vectorhighlight.FastVectorHighlighter.FastVectorHighlighter </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>phraseHighlight</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>fieldMatch</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>a constructor. Using <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_simple_frag_list_builder.html" title="A simple implementation of FragListBuilder. ">SimpleFragListBuilder</a> and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_score_order_fragments_builder.html">ScoreOrderFragmentsBuilder</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">phraseHighlight</td><td>true or false for phrase highlighting</td></tr> |
| <tr><td class="paramname">fieldMatch</td><td>true of false for field matching</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00049">49</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acb4892e9a34ac62be7e69fada11d1cf3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.Vectorhighlight.FastVectorHighlighter.FastVectorHighlighter </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>phraseHighlight</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>fieldMatch</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_frag_list_builder.html">FragListBuilder</a> </td> |
| <td class="paramname"><em>fragListBuilder</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html">FragmentsBuilder</a> </td> |
| <td class="paramname"><em>fragmentsBuilder</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>a constructor. A <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_frag_list_builder.html">FragListBuilder</a> and a <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html" title="FragmentsBuilder is an interface for fragments (snippets) builder classes. A FragmentsBuilder class c...">FragmentsBuilder</a> can be specified (plugins). </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">phraseHighlight</td><td>true of false for phrase highlighting</td></tr> |
| <tr><td class="paramname">fieldMatch</td><td>true of false for field matching</td></tr> |
| <tr><td class="paramname">fragListBuilder</td><td>an instance of <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_frag_list_builder.html">FragListBuilder</a></td></tr> |
| <tr><td class="paramname">fragmentsBuilder</td><td>an instance of <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html" title="FragmentsBuilder is an interface for fragments (snippets) builder classes. A FragmentsBuilder class c...">FragmentsBuilder</a></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00060">60</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a220e7a66943b9772bc94cacfb036ff97"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String Lucene.Net.Search.Vectorhighlight.FastVectorHighlighter.GetBestFragment </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> </td> |
| <td class="paramname"><em>fieldQuery</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 class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>docId</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">int </td> |
| <td class="paramname"><em>fragCharSize</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>return the best fragment. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fieldQuery</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> object</td></tr> |
| <tr><td class="paramname">reader</td><td>IndexReader of the index</td></tr> |
| <tr><td class="paramname">docId</td><td>document id to be highlighted</td></tr> |
| <tr><td class="paramname">fieldName</td><td>field of the document to be highlighted</td></tr> |
| <tr><td class="paramname">fragCharSize</td><td>the length (number of chars) of a fragment</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the best fragment (snippet) string</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00089">89</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6744b2918170b295dfd65f8e6c522149"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String [] Lucene.Net.Search.Vectorhighlight.FastVectorHighlighter.GetBestFragments </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> </td> |
| <td class="paramname"><em>fieldQuery</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 class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>docId</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">int </td> |
| <td class="paramname"><em>fragCharSize</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>maxNumFragments</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>return the best fragments. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fieldQuery</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> object</td></tr> |
| <tr><td class="paramname">reader</td><td>IndexReader of the index</td></tr> |
| <tr><td class="paramname">docId</td><td>document id to be highlighted</td></tr> |
| <tr><td class="paramname">fieldName</td><td>field of the document to be highlighted</td></tr> |
| <tr><td class="paramname">fragCharSize</td><td>the length (number of chars) of a fragment</td></tr> |
| <tr><td class="paramname">maxNumFragments</td><td>maximum number of fragments</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>created fragments or null when no fragments created. Size of the array can be less than maxNumFragments</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00106">106</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af2fd778887cd701154ef717d82935168"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> Lucene.Net.Search.Vectorhighlight.FastVectorHighlighter.GetFieldQuery </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><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>create a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> object. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">query</td><td>a query</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the created <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_query.html">FieldQuery</a> object</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00074">74</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ae3f0876c6e5918709c9895bd5bf27e8b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Search.Vectorhighlight.FastVectorHighlighter.IsFieldMatch </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>return whether fieldMatch or not. </p> |
| <dl class="section return"><dt>Returns</dt><dd>return whether fieldMatch or not.</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00134">134</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1bec9500dd39dc44375102fddc40b8f4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Lucene.Net.Search.Vectorhighlight.FastVectorHighlighter.IsPhraseHighlight </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>return whether phraseHighlight or not. </p> |
| <dl class="section return"><dt>Returns</dt><dd>return whether phraseHighlight or not.</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00125">125</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="aa64e93e485b7c3ef91e74c2212d037c3"></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.Vectorhighlight.FastVectorHighlighter.DEFAULT_FIELD_MATCH = true</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00030">30</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aca1ca48b257a9513976ff0cf6490567b"></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.Vectorhighlight.FastVectorHighlighter.DEFAULT_PHRASE_HIGHLIGHT = true</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00029">29</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="ac9a45a4e32391a62c1d4c4487a7ab73c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Search.Vectorhighlight.FastVectorHighlighter.PhraseLimit</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>The maximum number of phrases to analyze when searching for the highest-scoring phrase. The default is 5000. To ensure that all phrases are analyzed, use a negative number or Integer.MAX_VALUE. </p> |
| |
| <p>Definition at line <a class="el" href="_fast_vector_highlighter_8cs_source.html#l00145">145</a> of file <a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>contrib/FastVectorHighlighter/<a class="el" href="_fast_vector_highlighter_8cs_source.html">FastVectorHighlighter.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> |
