| <!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.QueryParsers.FastCharStream 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_query_parsers.html">QueryParsers</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html">FastCharStream</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.QueryParsers.FastCharStream Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An efficient implementation of JavaCC's CharStream interface. Note that this does not do line-number counting, but instead keeps track of the character position of the token in the input, as required by <a class="el" href="namespace_lucene.html">Lucene</a>'s <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html" title="A Token is an occurrence of a term from the text of a field. It consists of a term's text...">Lucene.Net.Analysis.Token</a> API. |
| <a href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html">Lucene.Net.QueryParsers.ICharStream</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:ad38a213fb04546746c901baa7b45f160"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#ad38a213fb04546746c901baa7b45f160">FastCharStream</a> (System.IO.TextReader r)</td></tr> |
| <tr class="memdesc:ad38a213fb04546746c901baa7b45f160"><td class="mdescLeft"> </td><td class="mdescRight">Constructs from a Reader. <a href="#ad38a213fb04546746c901baa7b45f160"></a><br/></td></tr> |
| <tr class="separator:ad38a213fb04546746c901baa7b45f160"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a70e53d6f61fef3c374bda81b3d9ccef6"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#a70e53d6f61fef3c374bda81b3d9ccef6">ReadChar</a> ()</td></tr> |
| <tr class="memdesc:a70e53d6f61fef3c374bda81b3d9ccef6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the next character from the selected input. The method of selecting the input is the responsibility of the class implementing this interface. Can throw any java.io.IOException. <a href="#a70e53d6f61fef3c374bda81b3d9ccef6"></a><br/></td></tr> |
| <tr class="separator:a70e53d6f61fef3c374bda81b3d9ccef6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1285984b33fc6842c57372f465a4d184"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#a1285984b33fc6842c57372f465a4d184">BeginToken</a> ()</td></tr> |
| <tr class="memdesc:a1285984b33fc6842c57372f465a4d184"><td class="mdescLeft"> </td><td class="mdescRight">Returns the next character that marks the beginning of the next token. All characters must remain in the buffer between two successive calls to this method to implement backup correctly. <a href="#a1285984b33fc6842c57372f465a4d184"></a><br/></td></tr> |
| <tr class="separator:a1285984b33fc6842c57372f465a4d184"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab6dacd91f3d90577920ad5ba53c0d3cb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#ab6dacd91f3d90577920ad5ba53c0d3cb">Backup</a> (int amount)</td></tr> |
| <tr class="memdesc:ab6dacd91f3d90577920ad5ba53c0d3cb"><td class="mdescLeft"> </td><td class="mdescRight">Backs up the input stream by amount steps. Lexer calls this method if it had already read some characters, but could not use them to match a (longer) token. So, they will be used again as the prefix of the next token and it is the implemetation's responsibility to do this right. <a href="#ab6dacd91f3d90577920ad5ba53c0d3cb"></a><br/></td></tr> |
| <tr class="separator:ab6dacd91f3d90577920ad5ba53c0d3cb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a942ddfa6f81cf6667808c28d6bcc09da"><td class="memItemLeft" align="right" valign="top">char[] </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#a942ddfa6f81cf6667808c28d6bcc09da">GetSuffix</a> (int len)</td></tr> |
| <tr class="memdesc:a942ddfa6f81cf6667808c28d6bcc09da"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of characters that make up the suffix of length 'len' for the currently matched token. This is used to build up the matched string for use in actions in the case of MORE. A simple and inefficient implementation of this is as follows : <a href="#a942ddfa6f81cf6667808c28d6bcc09da"></a><br/></td></tr> |
| <tr class="separator:a942ddfa6f81cf6667808c28d6bcc09da"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1992fe087b99d12448f95fbe2907c988"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#a1992fe087b99d12448f95fbe2907c988">Done</a> ()</td></tr> |
| <tr class="memdesc:a1992fe087b99d12448f95fbe2907c988"><td class="mdescLeft"> </td><td class="mdescRight">The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class. Again, the body of this function can be just empty and it will not affect the lexer's operation. <a href="#a1992fe087b99d12448f95fbe2907c988"></a><br/></td></tr> |
| <tr class="separator:a1992fe087b99d12448f95fbe2907c988"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:a818d58b1e38dde1d0294765013b0ecf7"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#a818d58b1e38dde1d0294765013b0ecf7">Image</a><code> [get]</code></td></tr> |
| <tr class="separator:a818d58b1e38dde1d0294765013b0ecf7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adffe2aa07ef73feb0f8ab8fc87ffc7f0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#adffe2aa07ef73feb0f8ab8fc87ffc7f0">Column</a><code> [get]</code></td></tr> |
| <tr class="separator:adffe2aa07ef73feb0f8ab8fc87ffc7f0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab620c095e820c5c9ca0bc2da75c8176e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#ab620c095e820c5c9ca0bc2da75c8176e">Line</a><code> [get]</code></td></tr> |
| <tr class="separator:ab620c095e820c5c9ca0bc2da75c8176e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abdcc5ed2d50d95b80121d441168499a8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#abdcc5ed2d50d95b80121d441168499a8">EndColumn</a><code> [get]</code></td></tr> |
| <tr class="separator:abdcc5ed2d50d95b80121d441168499a8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa64b884b62b38192151e69f00b333ace"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#aa64b884b62b38192151e69f00b333ace">EndLine</a><code> [get]</code></td></tr> |
| <tr class="separator:aa64b884b62b38192151e69f00b333ace"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a42932cf6d68318bf05b7ff57dbb34598"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#a42932cf6d68318bf05b7ff57dbb34598">BeginColumn</a><code> [get]</code></td></tr> |
| <tr class="separator:a42932cf6d68318bf05b7ff57dbb34598"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a868fa9a261b569cf72e8a583dc3bf900"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_query_parsers_1_1_fast_char_stream.html#a868fa9a261b569cf72e8a583dc3bf900">BeginLine</a><code> [get]</code></td></tr> |
| <tr class="separator:a868fa9a261b569cf72e8a583dc3bf900"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html">Lucene.Net.QueryParsers.ICharStream</a></td></tr> |
| <tr class="memitem:a18a384cf4faf3522d925bb2e37cb1601 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#a18a384cf4faf3522d925bb2e37cb1601">Column</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a18a384cf4faf3522d925bb2e37cb1601 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="mdescLeft"> </td><td class="mdescRight">Returns the column position of the character last read. <a href="#a18a384cf4faf3522d925bb2e37cb1601"></a><br/></td></tr> |
| <tr class="separator:a18a384cf4faf3522d925bb2e37cb1601 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a503ed3236d45dbcdff61693e067520b9 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#a503ed3236d45dbcdff61693e067520b9">Line</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a503ed3236d45dbcdff61693e067520b9 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="mdescLeft"> </td><td class="mdescRight">Returns the line number of the character last read. <a href="#a503ed3236d45dbcdff61693e067520b9"></a><br/></td></tr> |
| <tr class="separator:a503ed3236d45dbcdff61693e067520b9 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af8d560d57df9d0457595f0fe74bfb150 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#af8d560d57df9d0457595f0fe74bfb150">EndColumn</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af8d560d57df9d0457595f0fe74bfb150 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="mdescLeft"> </td><td class="mdescRight">Returns the column number of the last character for current token (being matched after the last call to BeginTOken). <a href="#af8d560d57df9d0457595f0fe74bfb150"></a><br/></td></tr> |
| <tr class="separator:af8d560d57df9d0457595f0fe74bfb150 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5888d082e197f2f627d7ce4bd8bf1d4b inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#a5888d082e197f2f627d7ce4bd8bf1d4b">EndLine</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5888d082e197f2f627d7ce4bd8bf1d4b inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="mdescLeft"> </td><td class="mdescRight">Returns the line number of the last character for current token (being matched after the last call to BeginTOken). <a href="#a5888d082e197f2f627d7ce4bd8bf1d4b"></a><br/></td></tr> |
| <tr class="separator:a5888d082e197f2f627d7ce4bd8bf1d4b inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5623f5d1871289b551008dc53ff1a9fe inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#a5623f5d1871289b551008dc53ff1a9fe">BeginColumn</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a5623f5d1871289b551008dc53ff1a9fe inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="mdescLeft"> </td><td class="mdescRight">Returns the column number of the first character for current token (being matched after the last call to BeginTOken). <a href="#a5623f5d1871289b551008dc53ff1a9fe"></a><br/></td></tr> |
| <tr class="separator:a5623f5d1871289b551008dc53ff1a9fe inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2129c81118dfb09ccbb125c6dca13325 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#a2129c81118dfb09ccbb125c6dca13325">BeginLine</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a2129c81118dfb09ccbb125c6dca13325 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="mdescLeft"> </td><td class="mdescRight">Returns the line number of the first character for current token (being matched after the last call to BeginTOken). <a href="#a2129c81118dfb09ccbb125c6dca13325"></a><br/></td></tr> |
| <tr class="separator:a2129c81118dfb09ccbb125c6dca13325 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad8a9ccaaaf371ecb98876eb91a8d7a52 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><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_query_parsers_1_1_i_char_stream.html#ad8a9ccaaaf371ecb98876eb91a8d7a52">Image</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ad8a9ccaaaf371ecb98876eb91a8d7a52 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string made up of characters from the marked token beginning to the current buffer position. Implementations have the choice of returning anything that they want to. For example, for efficiency, one might decide to just return null, which is a valid implementation. <a href="#ad8a9ccaaaf371ecb98876eb91a8d7a52"></a><br/></td></tr> |
| <tr class="separator:ad8a9ccaaaf371ecb98876eb91a8d7a52 inherit properties_interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An efficient implementation of JavaCC's CharStream interface. </p> |
| <p>Note that this does not do line-number counting, but instead keeps track of the character position of the token in the input, as required by <a class="el" href="namespace_lucene.html">Lucene</a>'s <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html" title="A Token is an occurrence of a term from the text of a field. It consists of a term's text...">Lucene.Net.Analysis.Token</a> API. </p> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00031">31</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="ad38a213fb04546746c901baa7b45f160"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.QueryParsers.FastCharStream.FastCharStream </td> |
| <td>(</td> |
| <td class="paramtype">System.IO.TextReader </td> |
| <td class="paramname"><em>r</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs from a Reader. </p> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00044">44</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ab6dacd91f3d90577920ad5ba53c0d3cb"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.QueryParsers.FastCharStream.Backup </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>amount</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Backs up the input stream by amount steps. Lexer calls this method if it had already read some characters, but could not use them to match a (longer) token. So, they will be used again as the prefix of the next token and it is the implemetation's responsibility to do this right. </p> |
| |
| <p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#a44ca5302facf15b0272fe2656620ddc9">Lucene.Net.QueryParsers.ICharStream</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00100">100</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1285984b33fc6842c57372f465a4d184"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">char Lucene.Net.QueryParsers.FastCharStream.BeginToken </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the next character that marks the beginning of the next token. All characters must remain in the buffer between two successive calls to this method to implement backup correctly. </p> |
| |
| <p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#a9774828c51fee85b6b17275f017b9b8a">Lucene.Net.QueryParsers.ICharStream</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00094">94</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1992fe087b99d12448f95fbe2907c988"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.QueryParsers.FastCharStream.Done </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class. Again, the body of this function can be just empty and it will not affect the lexer's operation. </p> |
| |
| <p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#a4fb763fcef007b1b700a178229360267">Lucene.Net.QueryParsers.ICharStream</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00117">117</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a942ddfa6f81cf6667808c28d6bcc09da"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">char [] Lucene.Net.QueryParsers.FastCharStream.GetSuffix </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>len</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns an array of characters that make up the suffix of length 'len' for the currently matched token. This is used to build up the matched string for use in actions in the case of MORE. A simple and inefficient implementation of this is as follows : </p> |
| <p>{ String t = GetImage(); return t.substring(t.length() - len, t.length()).toCharArray(); } </p> |
| |
| <p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#a09ec404a46a04ec0568abc837f83a429">Lucene.Net.QueryParsers.ICharStream</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00110">110</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a70e53d6f61fef3c374bda81b3d9ccef6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">char Lucene.Net.QueryParsers.FastCharStream.ReadChar </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the next character from the selected input. The method of selecting the input is the responsibility of the class implementing this interface. Can throw any java.io.IOException. </p> |
| |
| <p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_query_parsers_1_1_i_char_stream.html#a4432a2a90e6602d2b0f3baec66ae9053">Lucene.Net.QueryParsers.ICharStream</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00049">49</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a42932cf6d68318bf05b7ff57dbb34598"></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.QueryParsers.FastCharStream.BeginColumn</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00150">150</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a868fa9a261b569cf72e8a583dc3bf900"></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.QueryParsers.FastCharStream.BeginLine</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00155">155</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="adffe2aa07ef73feb0f8ab8fc87ffc7f0"></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.QueryParsers.FastCharStream.Column</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00130">130</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abdcc5ed2d50d95b80121d441168499a8"></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.QueryParsers.FastCharStream.EndColumn</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00140">140</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa64b884b62b38192151e69f00b333ace"></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.QueryParsers.FastCharStream.EndLine</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00145">145</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a818d58b1e38dde1d0294765013b0ecf7"></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.QueryParsers.FastCharStream.Image</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00106">106</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab620c095e820c5c9ca0bc2da75c8176e"></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.QueryParsers.FastCharStream.Line</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_fast_char_stream_8cs_source.html#l00135">135</a> of file <a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/QueryParser/<a class="el" href="_fast_char_stream_8cs_source.html">FastCharStream.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:55 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> |
