| <!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.Demo.Html.Token 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_demo.html">Demo</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_demo_1_1_html.html">Html</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html">Token</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Demo.Html.Token Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Describes the input token stream. |
| <a href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html#details">More...</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:a7d6453c112fd23e2219db103510f3347"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html#a7d6453c112fd23e2219db103510f3347">ToString</a> ()</td></tr> |
| <tr class="memdesc:a7d6453c112fd23e2219db103510f3347"><td class="mdescLeft"> </td><td class="mdescRight">Returns the image. <a href="#a7d6453c112fd23e2219db103510f3347"></a><br/></td></tr> |
| <tr class="separator:a7d6453c112fd23e2219db103510f3347"><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:aaafb7085b417cbca6b21df38afe90aaf"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html">Token</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html#aaafb7085b417cbca6b21df38afe90aaf">NewToken</a> (int ofKind)</td></tr> |
| <tr class="memdesc:aaafb7085b417cbca6b21df38afe90aaf"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new <a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html" title="Describes the input token stream.">Token</a> object, by default. However, if you want, you can create and return subclass objects based on the value of ofKind. Simply add the cases to the switch for all those special cases. For example, if you have a subclass of <a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html" title="Describes the input token stream.">Token</a> called IDToken that you want to create if ofKind is ID, simlpy add something like : <a href="#aaafb7085b417cbca6b21df38afe90aaf"></a><br/></td></tr> |
| <tr class="separator:aaafb7085b417cbca6b21df38afe90aaf"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:aace4ade58b2af1232adcc46ed8c96f59"><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_demo_1_1_html_1_1_token.html#aace4ade58b2af1232adcc46ed8c96f59">kind</a></td></tr> |
| <tr class="memdesc:aace4ade58b2af1232adcc46ed8c96f59"><td class="mdescLeft"> </td><td class="mdescRight">An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java. <a href="#aace4ade58b2af1232adcc46ed8c96f59"></a><br/></td></tr> |
| <tr class="separator:aace4ade58b2af1232adcc46ed8c96f59"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6af97c0e497dea34702fa3eba04abc3a"><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_demo_1_1_html_1_1_token.html#a6af97c0e497dea34702fa3eba04abc3a">beginLine</a></td></tr> |
| <tr class="memdesc:a6af97c0e497dea34702fa3eba04abc3a"><td class="mdescLeft"> </td><td class="mdescRight">beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token. <a href="#a6af97c0e497dea34702fa3eba04abc3a"></a><br/></td></tr> |
| <tr class="separator:a6af97c0e497dea34702fa3eba04abc3a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af0703e98d4a765467758250333ddd54c"><td class="memItemLeft" align="right" valign="top">System.String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html#af0703e98d4a765467758250333ddd54c">image</a></td></tr> |
| <tr class="memdesc:af0703e98d4a765467758250333ddd54c"><td class="mdescLeft"> </td><td class="mdescRight">The string image of the token. <a href="#af0703e98d4a765467758250333ddd54c"></a><br/></td></tr> |
| <tr class="separator:af0703e98d4a765467758250333ddd54c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afab59f61d7725b9699873edc9c871830"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html">Token</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html#afab59f61d7725b9699873edc9c871830">next</a></td></tr> |
| <tr class="memdesc:afab59f61d7725b9699873edc9c871830"><td class="mdescLeft"> </td><td class="mdescRight">A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field. <a href="#afab59f61d7725b9699873edc9c871830"></a><br/></td></tr> |
| <tr class="separator:afab59f61d7725b9699873edc9c871830"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8b2459e4dcdd640cbacdeb859c154fe2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html">Token</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html#a8b2459e4dcdd640cbacdeb859c154fe2">specialToken</a></td></tr> |
| <tr class="memdesc:a8b2459e4dcdd640cbacdeb859c154fe2"><td class="mdescLeft"> </td><td class="mdescRight">This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null. <a href="#a8b2459e4dcdd640cbacdeb859c154fe2"></a><br/></td></tr> |
| <tr class="separator:a8b2459e4dcdd640cbacdeb859c154fe2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Describes the input token stream.</p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html#l00027">27</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html">Token.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="aaafb7085b417cbca6b21df38afe90aaf"></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_demo_1_1_html_1_1_token.html">Token</a> Lucene.Net.Demo.Html.Token.NewToken </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>ofKind</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>Returns a new <a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html" title="Describes the input token stream.">Token</a> object, by default. However, if you want, you can create and return subclass objects based on the value of ofKind. Simply add the cases to the switch for all those special cases. For example, if you have a subclass of <a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html" title="Describes the input token stream.">Token</a> called IDToken that you want to create if ofKind is ID, simlpy add something like : </p> |
| <p>case MyParserConstants.ID : return new IDToken();</p> |
| <p>to the following switch statement. Then you can cast matchedToken variable to the appropriate type and use it in your lexical actions. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html#l00084">84</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html">Token.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a7d6453c112fd23e2219db103510f3347"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Demo.Html.Token.ToString </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the image.</p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html#l00068">68</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html">Token.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="a6af97c0e497dea34702fa3eba04abc3a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Demo.Html.Token.beginLine</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html#l00040">40</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html">Token.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="af0703e98d4a765467758250333ddd54c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">System.String Lucene.Net.Demo.Html.Token.image</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>The string image of the token.</p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html#l00043">43</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html">Token.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aace4ade58b2af1232adcc46ed8c96f59"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Lucene.Net.Demo.Html.Token.kind</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html#l00034">34</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html">Token.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="afab59f61d7725b9699873edc9c871830"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html">Token</a> Lucene.Net.Demo.Html.Token.next</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html#l00052">52</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html">Token.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8b2459e4dcdd640cbacdeb859c154fe2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_demo_1_1_html_1_1_token.html">Token</a> Lucene.Net.Demo.Html.Token.specialToken</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null. </p> |
| |
| <p>Definition at line <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html#l00065">65</a> of file <a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html">Token.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>demo/Demo.Common/HTML/<a class="el" href="demo_2_demo_8_common_2_h_t_m_l_2_token_8cs_source.html">Token.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:49 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> |
