| <!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.FragmentsBuilder Interface 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="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html">FragmentsBuilder</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.Vectorhighlight.FragmentsBuilder Interface Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><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> is an interface for fragments (snippets) builder classes. 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> class can be plugged in to Highlighter. |
| <a href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html#details">More...</a></p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html">Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder</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:a494e1dc1085f0b4e5f156d5be0c7d745"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html#a494e1dc1085f0b4e5f156d5be0c7d745">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:a494e1dc1085f0b4e5f156d5be0c7d745"><td class="mdescLeft"> </td><td class="mdescRight">create a fragment. <a href="#a494e1dc1085f0b4e5f156d5be0c7d745"></a><br/></td></tr> |
| <tr class="separator:a494e1dc1085f0b4e5f156d5be0c7d745"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5002433151352197143a9f7c0f9b919d"><td class="memItemLeft" align="right" valign="top">String[] </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_fragments_builder.html#a5002433151352197143a9f7c0f9b919d">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:a5002433151352197143a9f7c0f9b919d"><td class="mdescLeft"> </td><td class="mdescRight">create multiple fragments. <a href="#a5002433151352197143a9f7c0f9b919d"></a><br/></td></tr> |
| <tr class="separator:a5002433151352197143a9f7c0f9b919d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><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> is an interface for fragments (snippets) builder classes. 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> class can be plugged in to Highlighter. </p> |
| |
| <p>Definition at line <a class="el" href="_fragments_builder_8cs_source.html#l00032">32</a> of file <a class="el" href="_fragments_builder_8cs_source.html">FragmentsBuilder.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a494e1dc1085f0b4e5f156d5be0c7d745"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String Lucene.Net.Search.Vectorhighlight.FragmentsBuilder.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> </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"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_frag_list.html">FieldFragList</a> </td> |
| <td class="paramname"><em>fieldFragList</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></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 "frag info" 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>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#a981ea69d9dae2d33e366654cd2d89cdd">Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5002433151352197143a9f7c0f9b919d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String [] Lucene.Net.Search.Vectorhighlight.FragmentsBuilder.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> </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"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_field_frag_list.html">FieldFragList</a> </td> |
| <td class="paramname"><em>fieldFragList</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>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>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_vectorhighlight_1_1_base_fragments_builder.html#ac664a26874590d22387cf5fac4e1ce34">Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this interface was generated from the following file:<ul> |
| <li>contrib/FastVectorHighlighter/<a class="el" href="_fragments_builder_8cs_source.html">FragmentsBuilder.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> |
