Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_simple_fragmenter.html
blob: 2e1e6a191bf57fd9dc41e190ccf59db7316ee100 [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.Highlight.SimpleFragmenter 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_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_simple_fragmenter.html">SimpleFragmenter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_simple_fragmenter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Highlight.SimpleFragmenter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter.html" title="Implements the policy for breaking text into multiple fragments for consideration by the Highlighter ...">IFragmenter</a> implementation which breaks text up into same-size fragments with no concerns over spotting sentence boundaries.
<a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_simple_fragmenter.html#details">More...</a></p>
<p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter.html">Lucene.Net.Search.Highlight.IFragmenter</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:a3373ab85c54959d6ddd0d7b23fd971e7"><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_highlight_1_1_simple_fragmenter.html#a3373ab85c54959d6ddd0d7b23fd971e7">SimpleFragmenter</a> ()</td></tr>
<tr class="separator:a3373ab85c54959d6ddd0d7b23fd971e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab295f929c469906c2902321b1540cabe"><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_highlight_1_1_simple_fragmenter.html#ab295f929c469906c2902321b1540cabe">SimpleFragmenter</a> (int fragmentSize)</td></tr>
<tr class="separator:ab295f929c469906c2902321b1540cabe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89a6d514840aebcb41ae892ebff675f1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_simple_fragmenter.html#a89a6d514840aebcb41ae892ebff675f1">Start</a> (String originalText, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> stream)</td></tr>
<tr class="separator:a89a6d514840aebcb41ae892ebff675f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a986f137c7c7015746d9a95e10ce88b6d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_simple_fragmenter.html#a986f137c7c7015746d9a95e10ce88b6d">IsNewFragment</a> ()</td></tr>
<tr class="memdesc:a986f137c7c7015746d9a95e10ce88b6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test to see if this token from the stream should be held in a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html" title="Low-level class used to record information about a section of a document with a score. ">TextFragment</a>. Every time this is called, the TokenStream passed to start(String, TokenStream) will have been incremented. <a href="#a986f137c7c7015746d9a95e10ce88b6d"></a><br/></td></tr>
<tr class="separator:a986f137c7c7015746d9a95e10ce88b6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter.html">Lucene.Net.Search.Highlight.IFragmenter</a></td></tr>
<tr class="memitem:a6b53966802470cae3c828cc58a5d74f4 inherit pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter.html#a6b53966802470cae3c828cc58a5d74f4">Start</a> (string originalText, <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:a6b53966802470cae3c828cc58a5d74f4 inherit pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the Fragmenter. You can grab references to the Attributes you are interested in from tokenStream and then access the values in <a class="el" href="">isNewFragment()</a>. <a href="#a6b53966802470cae3c828cc58a5d74f4"></a><br/></td></tr>
<tr class="separator:a6b53966802470cae3c828cc58a5d74f4 inherit pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter"><td class="memSeparator" colspan="2">&#160;</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:a0421fd6d23ebc28f8508188aae0f236f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_simple_fragmenter.html#a0421fd6d23ebc28f8508188aae0f236f">FragmentSize</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a0421fd6d23ebc28f8508188aae0f236f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the size in number of characters of each fragment <a href="#a0421fd6d23ebc28f8508188aae0f236f"></a><br/></td></tr>
<tr class="separator:a0421fd6d23ebc28f8508188aae0f236f"><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><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter.html" title="Implements the policy for breaking text into multiple fragments for consideration by the Highlighter ...">IFragmenter</a> implementation which breaks text up into same-size fragments with no concerns over spotting sentence boundaries. </p>
<p>&lt;author&gt; <a href="#" onclick="location.href='mai'+'lto:'+'mar'+'k@'+'sea'+'rc'+'har'+'ea'+'.co'+'.u'+'k'; return false;">mark@<span style="display: none;">.nosp@m.</span>sear<span style="display: none;">.nosp@m.</span>chare<span style="display: none;">.nosp@m.</span>a.co<span style="display: none;">.nosp@m.</span>.uk</a> &lt;/author&gt; </p>
<p>Definition at line <a class="el" href="_simple_fragmenter_8cs_source.html#l00030">30</a> of file <a class="el" href="_simple_fragmenter_8cs_source.html">SimpleFragmenter.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a3373ab85c54959d6ddd0d7b23fd971e7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.SimpleFragmenter.SimpleFragmenter </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="_simple_fragmenter_8cs_source.html#l00037">37</a> of file <a class="el" href="_simple_fragmenter_8cs_source.html">SimpleFragmenter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab295f929c469906c2902321b1540cabe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.SimpleFragmenter.SimpleFragmenter </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fragmentSize</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_simple_fragmenter_8cs_source.html#l00047">47</a> of file <a class="el" href="_simple_fragmenter_8cs_source.html">SimpleFragmenter.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a986f137c7c7015746d9a95e10ce88b6d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Lucene.Net.Search.Highlight.SimpleFragmenter.IsNewFragment </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test to see if this token from the stream should be held in a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html" title="Low-level class used to record information about a section of a document with a score. ">TextFragment</a>. Every time this is called, the TokenStream passed to start(String, TokenStream) will have been incremented. </p>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter.html#a50e1fce5302387ce4da249b8fe06c394">Lucene.Net.Search.Highlight.IFragmenter</a>.</p>
<p>Definition at line <a class="el" href="_simple_fragmenter_8cs_source.html#l00068">68</a> of file <a class="el" href="_simple_fragmenter_8cs_source.html">SimpleFragmenter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a89a6d514840aebcb41ae892ebff675f1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.Highlight.SimpleFragmenter.Start </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>originalText</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>&#160;</td>
<td class="paramname"><em>stream</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_simple_fragmenter_8cs_source.html#l00057">57</a> of file <a class="el" href="_simple_fragmenter_8cs_source.html">SimpleFragmenter.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a0421fd6d23ebc28f8508188aae0f236f"></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.Highlight.SimpleFragmenter.FragmentSize</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>Gets or sets the size in number of characters of each fragment </p>
<p>Definition at line <a class="el" href="_simple_fragmenter_8cs_source.html#l00082">82</a> of file <a class="el" href="_simple_fragmenter_8cs_source.html">SimpleFragmenter.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="_simple_fragmenter_8cs_source.html">SimpleFragmenter.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>