| <!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.TokenSources Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Lucene.Net |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.3 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="Index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Packages</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search.html">Search</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search_1_1_highlight.html">Highlight</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources.html">TokenSources</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.Highlight.TokenSources Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Hides implementation issues associated with obtaining a TokenStream for use with the higlighter - can obtain from TermFreqVectors with offsets and (optionally) positions or from Analyzer class reparsing the stored content. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources_1_1_stored_token_stream.html">StoredTokenStream</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a1ddd5210a9ba3c62890187a65532ab67"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources.html#a1ddd5210a9ba3c62890187a65532ab67">GetAnyTokenStream</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, String field, <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html">Document</a> doc, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> analyzer)</td></tr> |
| <tr class="memdesc:a1ddd5210a9ba3c62890187a65532ab67"><td class="mdescLeft"> </td><td class="mdescRight">A convenience method that tries to first get a TermPositionVector for the specified docId, then, falls back to using the passed in <a class="el" href="_searcher_8cs.html#a2ad6aef8641c7b7a6cf9277f7d54b2cd">org.apache.lucene.document.Document</a> to retrieve the TokenStream. This is useful when you already have the document, but would prefer to use the vector first. <a href="#a1ddd5210a9ba3c62890187a65532ab67"></a><br/></td></tr> |
| <tr class="separator:a1ddd5210a9ba3c62890187a65532ab67"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad23a6d9a669e4fcf8a312fc805326d36"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources.html#ad23a6d9a669e4fcf8a312fc805326d36">GetAnyTokenStream</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, String field, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> analyzer)</td></tr> |
| <tr class="memdesc:ad23a6d9a669e4fcf8a312fc805326d36"><td class="mdescLeft"> </td><td class="mdescRight">A convenience method that tries a number of approaches to getting a token stream. The cost of finding there are no termVectors in the index is minimal (1000 invocations still registers 0 ms). So this "lazy" (flexible?) approach to coding is probably acceptable <a href="#ad23a6d9a669e4fcf8a312fc805326d36"></a><br/></td></tr> |
| <tr class="separator:ad23a6d9a669e4fcf8a312fc805326d36"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2b49326ca7301a888db5b696b3bd9ff9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources.html#a2b49326ca7301a888db5b696b3bd9ff9">GetTokenStream</a> (<a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_position_vector.html">TermPositionVector</a> tpv)</td></tr> |
| <tr class="separator:a2b49326ca7301a888db5b696b3bd9ff9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a77e1ffdfd6fbaa619f69a9a6a3eaecdc"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources.html#a77e1ffdfd6fbaa619f69a9a6a3eaecdc">GetTokenStream</a> (<a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_position_vector.html">TermPositionVector</a> tpv, bool tokenPositionsGuaranteedContiguous)</td></tr> |
| <tr class="memdesc:a77e1ffdfd6fbaa619f69a9a6a3eaecdc"><td class="mdescLeft"> </td><td class="mdescRight">Low level api. Returns a token stream or null if no offset info available in index. This can be used to feed the highlighter with a pre-parsed token stream <a href="#a77e1ffdfd6fbaa619f69a9a6a3eaecdc"></a><br/></td></tr> |
| <tr class="separator:a77e1ffdfd6fbaa619f69a9a6a3eaecdc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aca08f3b1f6029695716d9a33c0ba8903"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources.html#aca08f3b1f6029695716d9a33c0ba8903">GetTokenStream</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, System.String field)</td></tr> |
| <tr class="separator:aca08f3b1f6029695716d9a33c0ba8903"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab7f36fbbbc70b9a9d8ffaa78552a1c42"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources.html#ab7f36fbbbc70b9a9d8ffaa78552a1c42">GetTokenStream</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, int docId, String field, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> analyzer)</td></tr> |
| <tr class="separator:ab7f36fbbbc70b9a9d8ffaa78552a1c42"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a356b40956ea4a7bdec0a96f156b8a84c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources.html#a356b40956ea4a7bdec0a96f156b8a84c">GetTokenStream</a> (<a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html">Document</a> doc, String field, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> analyzer)</td></tr> |
| <tr class="separator:a356b40956ea4a7bdec0a96f156b8a84c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad91941c8a0bb901e71b032ae8de2c420"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_sources.html#ad91941c8a0bb901e71b032ae8de2c420">GetTokenStream</a> (String field, String contents, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_analyzer.html">Analyzer</a> analyzer)</td></tr> |
| <tr class="separator:ad91941c8a0bb901e71b032ae8de2c420"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Hides implementation issues associated with obtaining a TokenStream for use with the higlighter - can obtain from TermFreqVectors with offsets and (optionally) positions or from Analyzer class reparsing the stored content. </p> |
| |
| <p>Definition at line <a class="el" href="_token_sources_8cs_source.html#l00038">38</a> of file <a class="el" href="_token_sources_8cs_source.html">TokenSources.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a1ddd5210a9ba3c62890187a65532ab67"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Search.Highlight.TokenSources.GetAnyTokenStream </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>field</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_document.html">Document</a> </td> |
| <td class="paramname"><em>doc</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_analyzer.html">Analyzer</a> </td> |
| <td class="paramname"><em>analyzer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></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>A convenience method that tries to first get a TermPositionVector for the specified docId, then, falls back to using the passed in <a class="el" href="_searcher_8cs.html#a2ad6aef8641c7b7a6cf9277f7d54b2cd">org.apache.lucene.document.Document</a> to retrieve the TokenStream. This is useful when you already have the document, but would prefer to use the vector first. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reader</td><td>The <a class="el" href="_reader_util_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> to use to try and get the vector from</td></tr> |
| <tr><td class="paramname">docId</td><td>The docId to retrieve.</td></tr> |
| <tr><td class="paramname">field</td><td>The field to retrieve on the document</td></tr> |
| <tr><td class="paramname">doc</td><td>The document to fall back on</td></tr> |
| <tr><td class="paramname">analyzer</td><td>The analyzer to use for creating the TokenStream if the vector doesn't exist</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> for the IFieldable on the <a class="el" href="_searcher_8cs.html#a2ad6aef8641c7b7a6cf9277f7d54b2cd">Document</a></dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname">IOException</td><td>if there was an error loading</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_token_sources_8cs_source.html#l00085">85</a> of file <a class="el" href="_token_sources_8cs_source.html">TokenSources.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad23a6d9a669e4fcf8a312fc805326d36"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Search.Highlight.TokenSources.GetAnyTokenStream </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>field</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_analyzer.html">Analyzer</a> </td> |
| <td class="paramname"><em>analyzer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></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>A convenience method that tries a number of approaches to getting a token stream. The cost of finding there are no termVectors in the index is minimal (1000 invocations still registers 0 ms). So this "lazy" (flexible?) approach to coding is probably acceptable </p> |
| <dl class="section return"><dt>Returns</dt><dd>null if field not stored correctly</dd></dl> |
| |
| <p>Definition at line <a class="el" href="_token_sources_8cs_source.html#l00109">109</a> of file <a class="el" href="_token_sources_8cs_source.html">TokenSources.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2b49326ca7301a888db5b696b3bd9ff9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Search.Highlight.TokenSources.GetTokenStream </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_position_vector.html">TermPositionVector</a> </td> |
| <td class="paramname"><em>tpv</em></td><td>)</td> |
| <td></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="_token_sources_8cs_source.html#l00126">126</a> of file <a class="el" href="_token_sources_8cs_source.html">TokenSources.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a77e1ffdfd6fbaa619f69a9a6a3eaecdc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Search.Highlight.TokenSources.GetTokenStream </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_position_vector.html">TermPositionVector</a> </td> |
| <td class="paramname"><em>tpv</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>tokenPositionsGuaranteedContiguous</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></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>Low level api. Returns a token stream or null if no offset info available in index. This can be used to feed the highlighter with a pre-parsed token stream </p> |
| <p>In my tests the speeds to recreate 1000 token streams using this method are:</p> |
| <ul> |
| <li>with TermVector offset only data stored - 420 milliseconds</li> |
| <li>with TermVector offset AND position data stored - 271 milliseconds (nb timings for TermVector with position data are based on a tokenizer with contiguous positions - no overlaps or gaps) The cost of not using TermPositionVector to store pre-parsed content and using an analyzer to re-parse the original content:</li> |
| <li>reanalyzing the original content - 980 milliseconds</li> |
| </ul> |
| <p>The re-analyze timings will typically vary depending on - 1) The complexity of the analyzer code (timings above were using a stemmer/lowercaser/stopword combo) 2) The number of other fields (<a class="el" href="namespace_lucene.html">Lucene</a> reads ALL fields off the disk when accessing just one document field - can cost dear!) 3) Use of compression on field storage - could be faster due to compression (less disk IO) or slower (more CPU burn) depending on the content. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">tpv</td><td><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">tokenPositionsGuaranteedContiguous</td><td>true if the token position numbers have no overlaps or gaps. If looking to eek out the last drops of performance, set to true. If in doubt, set to false.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_token_sources_8cs_source.html#l00157">157</a> of file <a class="el" href="_token_sources_8cs_source.html">TokenSources.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aca08f3b1f6029695716d9a33c0ba8903"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Search.Highlight.TokenSources.GetTokenStream </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">System.String </td> |
| <td class="paramname"><em>field</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></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="_token_sources_8cs_source.html#l00227">227</a> of file <a class="el" href="_token_sources_8cs_source.html">TokenSources.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab7f36fbbbc70b9a9d8ffaa78552a1c42"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Search.Highlight.TokenSources.GetTokenStream </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>field</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_analyzer.html">Analyzer</a> </td> |
| <td class="paramname"><em>analyzer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></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="_token_sources_8cs_source.html#l00245">245</a> of file <a class="el" href="_token_sources_8cs_source.html">TokenSources.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a356b40956ea4a7bdec0a96f156b8a84c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Search.Highlight.TokenSources.GetTokenStream </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html">Document</a> </td> |
| <td class="paramname"><em>doc</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>field</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_analyzer.html">Analyzer</a> </td> |
| <td class="paramname"><em>analyzer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></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="_token_sources_8cs_source.html#l00251">251</a> of file <a class="el" href="_token_sources_8cs_source.html">TokenSources.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad91941c8a0bb901e71b032ae8de2c420"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> Lucene.Net.Search.Highlight.TokenSources.GetTokenStream </td> |
| <td>(</td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>field</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">String </td> |
| <td class="paramname"><em>contents</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_analyzer.html">Analyzer</a> </td> |
| <td class="paramname"><em>analyzer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></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="_token_sources_8cs_source.html#l00262">262</a> of file <a class="el" href="_token_sources_8cs_source.html">TokenSources.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="_token_sources_8cs_source.html">TokenSources.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> |
