blob: 7479edd861632d95a849fb9fd97a422ed5756015 [file] [log] [blame]
<!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.BaseFragmentsBuilder 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
&#160;<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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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_base_fragments_builder.html">BaseFragmentsBuilder</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html">Lucene.Net.Search.Vectorhighlight.FragmentsBuilder</a>.</p>
<p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_score_order_fragments_builder.html">Lucene.Net.Search.Vectorhighlight.ScoreOrderFragmentsBuilder</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_simple_fragments_builder.html">Lucene.Net.Search.Vectorhighlight.SimpleFragmentsBuilder</a>.</p>
<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:afd29cdd2860c32bda1f3b67ae044ec81"><td class="memItemLeft" align="right" valign="top">abstract List&lt; <a class="el" href="_base_fragments_builder_8cs.html#ab288a20d2b23dc203f5900ea8fa0407c">WeightedFragInfo</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#afd29cdd2860c32bda1f3b67ae044ec81">GetWeightedFragInfoList</a> (List&lt; <a class="el" href="_base_fragments_builder_8cs.html#ab288a20d2b23dc203f5900ea8fa0407c">WeightedFragInfo</a> &gt; src)</td></tr>
<tr class="separator:afd29cdd2860c32bda1f3b67ae044ec81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a981ea69d9dae2d33e366654cd2d89cdd"><td class="memItemLeft" align="right" valign="top">virtual String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#a981ea69d9dae2d33e366654cd2d89cdd">CreateFragment</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, String fieldName, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_frag_list.html">FieldFragList</a> fieldFragList)</td></tr>
<tr class="memdesc:a981ea69d9dae2d33e366654cd2d89cdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">create a fragment. <a href="#a981ea69d9dae2d33e366654cd2d89cdd"></a><br/></td></tr>
<tr class="separator:a981ea69d9dae2d33e366654cd2d89cdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac664a26874590d22387cf5fac4e1ce34"><td class="memItemLeft" align="right" valign="top">virtual String[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#ac664a26874590d22387cf5fac4e1ce34">CreateFragments</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, String fieldName, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_frag_list.html">FieldFragList</a> fieldFragList, int maxNumFragments)</td></tr>
<tr class="memdesc:ac664a26874590d22387cf5fac4e1ce34"><td class="mdescLeft">&#160;</td><td class="mdescRight">create multiple fragments. <a href="#ac664a26874590d22387cf5fac4e1ce34"></a><br/></td></tr>
<tr class="separator:ac664a26874590d22387cf5fac4e1ce34"><td class="memSeparator" colspan="2">&#160;</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:a380372c1a0dce502789920cd993ae5bd"><td class="memItemLeft" align="right" valign="top">static String[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#a380372c1a0dce502789920cd993ae5bd">COLORED_PRE_TAGS</a></td></tr>
<tr class="separator:a380372c1a0dce502789920cd993ae5bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe38a49e3ac3229ef67ac660ba153e1"><td class="memItemLeft" align="right" valign="top">static String[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#abfe38a49e3ac3229ef67ac660ba153e1">COLORED_POST_TAGS</a> = { &quot;&lt;/b&gt;&quot; }</td></tr>
<tr class="separator:abfe38a49e3ac3229ef67ac660ba153e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a336e3b1528cf83d97d3453f37f686e99"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#a336e3b1528cf83d97d3453f37f686e99">BaseFragmentsBuilder</a> ()</td></tr>
<tr class="separator:a336e3b1528cf83d97d3453f37f686e99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24304d8eb97814162cea1b7fbbeebec5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#a24304d8eb97814162cea1b7fbbeebec5">BaseFragmentsBuilder</a> (String[] <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#aecf765be544584c6186144202e6037a9">preTags</a>, String[] postTags)</td></tr>
<tr class="separator:a24304d8eb97814162cea1b7fbbeebec5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4982f150ad79ed129ce04e5cd71f919"><td class="memItemLeft" align="right" valign="top">virtual String[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#ae4982f150ad79ed129ce04e5cd71f919">GetFieldValues</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, String fieldName)</td></tr>
<tr class="separator:ae4982f150ad79ed129ce04e5cd71f919"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ffc0fdd4c49de75b4deab3ed78903c0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a>[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#a6ffc0fdd4c49de75b4deab3ed78903c0">GetFields</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, String fieldName)</td></tr>
<tr class="separator:a6ffc0fdd4c49de75b4deab3ed78903c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb55418ffc95fb60a0541ec31bbb98b3"><td class="memItemLeft" align="right" valign="top">virtual String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#acb55418ffc95fb60a0541ec31bbb98b3">MakeFragment</a> (StringBuilder buffer, int[] index, String[] values, <a class="el" href="_base_fragments_builder_8cs.html#ab288a20d2b23dc203f5900ea8fa0407c">WeightedFragInfo</a> fragInfo)</td></tr>
<tr class="separator:acb55418ffc95fb60a0541ec31bbb98b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af8649cf9aa560e9cca780eaa57453535"><td class="memItemLeft" align="right" valign="top">virtual String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#af8649cf9aa560e9cca780eaa57453535">MakeFragment</a> (StringBuilder buffer, int[] index, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a>[] values, <a class="el" href="_base_fragments_builder_8cs.html#ab288a20d2b23dc203f5900ea8fa0407c">WeightedFragInfo</a> fragInfo)</td></tr>
<tr class="separator:af8649cf9aa560e9cca780eaa57453535"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6608acf391a2824196ff9493bb7c6f7c"><td class="memItemLeft" align="right" valign="top">virtual String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#a6608acf391a2824196ff9493bb7c6f7c">GetFragmentSource</a> (StringBuilder buffer, int[] index, String[] values, int startOffset, int endOffset)</td></tr>
<tr class="separator:a6608acf391a2824196ff9493bb7c6f7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa600e2148a26e4bdde87e9b682b14ab0"><td class="memItemLeft" align="right" valign="top">virtual String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#aa600e2148a26e4bdde87e9b682b14ab0">GetFragmentSource</a> (StringBuilder buffer, int[] index, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a>[] values, int startOffset, int endOffset)</td></tr>
<tr class="separator:aa600e2148a26e4bdde87e9b682b14ab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17630ebec8d2b1c10fc2aa40aadd8f0c"><td class="memItemLeft" align="right" valign="top">virtual String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#a17630ebec8d2b1c10fc2aa40aadd8f0c">GetPreTag</a> (int num)</td></tr>
<tr class="separator:a17630ebec8d2b1c10fc2aa40aadd8f0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acede132a16774d415ec68798b9721e04"><td class="memItemLeft" align="right" valign="top">virtual String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#acede132a16774d415ec68798b9721e04">GetPostTag</a> (int num)</td></tr>
<tr class="separator:acede132a16774d415ec68798b9721e04"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:aecf765be544584c6186144202e6037a9"><td class="memItemLeft" align="right" valign="top">String[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#aecf765be544584c6186144202e6037a9">preTags</a></td></tr>
<tr class="separator:aecf765be544584c6186144202e6037a9"><td class="memSeparator" colspan="2">&#160;</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="_base_fragments_builder_8cs_source.html#l00032">32</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a336e3b1528cf83d97d3453f37f686e99"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.BaseFragmentsBuilder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00047">47</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a24304d8eb97814162cea1b7fbbeebec5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.BaseFragmentsBuilder </td>
<td>(</td>
<td class="paramtype">String[]&#160;</td>
<td class="paramname"><em>preTags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String[]&#160;</td>
<td class="paramname"><em>postTags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00053">53</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a981ea69d9dae2d33e366654cd2d89cdd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.CreateFragment </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>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>docId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</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_search_1_1_vectorhighlight_1_1_field_frag_list.html">FieldFragList</a>&#160;</td>
<td class="paramname"><em>fieldFragList</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>create a fragment. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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">fieldFragList</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_frag_list.html" title="FieldFragList has a list of &quot;frag info&quot; that is used by FragmentsBuilder class to create fragments (s...">FieldFragList</a> object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a created fragment or null when no fragment created</dd></dl>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html#a494e1dc1085f0b4e5f156d5be0c7d745">Lucene.Net.Search.Vectorhighlight.FragmentsBuilder</a>.</p>
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00068">68</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ac664a26874590d22387cf5fac4e1ce34"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual String [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.CreateFragments </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>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>docId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</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_search_1_1_vectorhighlight_1_1_field_frag_list.html">FieldFragList</a>&#160;</td>
<td class="paramname"><em>fieldFragList</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>maxNumFragments</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>create multiple fragments. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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">fieldFragList</td><td>ieldFragList object</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>Implements <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html#a5002433151352197143a9f7c0f9b919d">Lucene.Net.Search.Vectorhighlight.FragmentsBuilder</a>.</p>
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00075">75</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6ffc0fdd4c49de75b4deab3ed78903c0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a> [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetFields </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>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>docId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>fieldName</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00102">102</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae4982f150ad79ed129ce04e5cd71f919"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual String [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetFieldValues </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>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>docId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>fieldName</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00096">96</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6608acf391a2824196ff9493bb7c6f7c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetFragmentSource </td>
<td>(</td>
<td class="paramtype">StringBuilder&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int[]&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String[]&#160;</td>
<td class="paramname"><em>values</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>startOffset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>endOffset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00163">163</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aa600e2148a26e4bdde87e9b682b14ab0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetFragmentSource </td>
<td>(</td>
<td class="paramtype">StringBuilder&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int[]&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a>[]&#160;</td>
<td class="paramname"><em>values</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>startOffset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>endOffset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00176">176</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="acede132a16774d415ec68798b9721e04"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetPostTag </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00195">195</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a17630ebec8d2b1c10fc2aa40aadd8f0c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetPreTag </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00189">189</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="afd29cdd2860c32bda1f3b67ae044ec81"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract List&lt;<a class="el" href="_base_fragments_builder_8cs.html#ab288a20d2b23dc203f5900ea8fa0407c">WeightedFragInfo</a>&gt; Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetWeightedFragInfoList </td>
<td>(</td>
<td class="paramtype">List&lt; <a class="el" href="_base_fragments_builder_8cs.html#ab288a20d2b23dc203f5900ea8fa0407c">WeightedFragInfo</a> &gt;&#160;</td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_simple_fragments_builder.html#aedc69064e3abeba741cf0a2d3773795a">Lucene.Net.Search.Vectorhighlight.SimpleFragmentsBuilder</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_score_order_fragments_builder.html#af443f6b43b575a578ab546a5ba5fb475">Lucene.Net.Search.Vectorhighlight.ScoreOrderFragmentsBuilder</a>.</p>
</div>
</div>
<a class="anchor" id="acb55418ffc95fb60a0541ec31bbb98b3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.MakeFragment </td>
<td>(</td>
<td class="paramtype">StringBuilder&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int[]&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String[]&#160;</td>
<td class="paramname"><em>values</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_base_fragments_builder_8cs.html#ab288a20d2b23dc203f5900ea8fa0407c">WeightedFragInfo</a>&#160;</td>
<td class="paramname"><em>fragInfo</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00110">110</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af8649cf9aa560e9cca780eaa57453535"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.MakeFragment </td>
<td>(</td>
<td class="paramtype">StringBuilder&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int[]&#160;</td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html">Field</a>[]&#160;</td>
<td class="paramname"><em>values</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_base_fragments_builder_8cs.html#ab288a20d2b23dc203f5900ea8fa0407c">WeightedFragInfo</a>&#160;</td>
<td class="paramname"><em>fragInfo</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00116">116</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="abfe38a49e3ac3229ef67ac660ba153e1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">String [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.COLORED_POST_TAGS = { &quot;&lt;/b&gt;&quot; }</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="_base_fragments_builder_8cs_source.html#l00045">45</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a380372c1a0dce502789920cd993ae5bd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">String [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.COLORED_PRE_TAGS</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
<div class="line"> <span class="stringliteral">&quot;&lt;b style=\&quot;background:yellow\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:lawngreen\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:aquamarine\&quot;&gt;&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;&lt;b style=\&quot;background:magenta\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:palegreen\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:coral\&quot;&gt;&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;&lt;b style=\&quot;background:wheat\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:khaki\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:lime\&quot;&gt;&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;&lt;b style=\&quot;background:deepskyblue\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:deeppink\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:salmon\&quot;&gt;&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;&lt;b style=\&quot;background:peachpuff\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:violet\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:mediumpurple\&quot;&gt;&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;&lt;b style=\&quot;background:palegoldenrod\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:darkkhaki\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:springgreen\&quot;&gt;&quot;</span>,</div>
<div class="line"> <span class="stringliteral">&quot;&lt;b style=\&quot;background:turquoise\&quot;&gt;&quot;</span>, <span class="stringliteral">&quot;&lt;b style=\&quot;background:powderblue\&quot;&gt;&quot;</span></div>
<div class="line"> }</div>
</div><!-- fragment -->
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00035">35</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.cs</a>.</p>
</div>
</div>
<a class="anchor" id="aecf765be544584c6186144202e6037a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">String [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.preTags</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_base_fragments_builder_8cs_source.html#l00034">34</a> of file <a class="el" href="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.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="_base_fragments_builder_8cs_source.html">BaseFragmentsBuilder.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>