Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_analysis_1_1_mapping_char_filter.html
blob: a7dc5c1ca7d1dc5cdcf774caf4b679c27a7d85ee [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.Analysis.MappingCharFilter 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_analysis.html">Analysis</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_mapping_char_filter.html">MappingCharFilter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_analysis_1_1_mapping_char_filter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Analysis.MappingCharFilter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Simplistic <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html" title="Subclasses of CharFilter can be chained to filter CharStream. They can be used as System...">CharFilter</a> that applies the mappings contained in a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_normalize_char_map.html" title="Holds a map of String input to String output, to be used with MappingCharFilter. ">NormalizeCharMap</a> to the character stream, and correcting the resulting changes to the offsets.
<a href="class_lucene_1_1_net_1_1_analysis_1_1_mapping_char_filter.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter.html">Lucene.Net.Analysis.BaseCharFilter</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:ab0d57b08d5c7420c68172d7c30816f56"><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_analysis_1_1_mapping_char_filter.html#ab0d57b08d5c7420c68172d7c30816f56">MappingCharFilter</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_normalize_char_map.html">NormalizeCharMap</a> normMap, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html">CharStream</a> @in)</td></tr>
<tr class="memdesc:ab0d57b08d5c7420c68172d7c30816f56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor that takes a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html" title="CharStream adds CorrectOffset functionality over System.IO.TextReader. All Tokenizers accept a CharSt...">CharStream</a>. <a href="#ab0d57b08d5c7420c68172d7c30816f56"></a><br/></td></tr>
<tr class="separator:ab0d57b08d5c7420c68172d7c30816f56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4541be021d86123f8bc9fea9f554828"><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_analysis_1_1_mapping_char_filter.html#ad4541be021d86123f8bc9fea9f554828">MappingCharFilter</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_normalize_char_map.html">NormalizeCharMap</a> normMap, System.IO.TextReader @in)</td></tr>
<tr class="memdesc:ad4541be021d86123f8bc9fea9f554828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Easy-use constructor that takes a System.IO.TextReader. <a href="#ad4541be021d86123f8bc9fea9f554828"></a><br/></td></tr>
<tr class="separator:ad4541be021d86123f8bc9fea9f554828"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d8e380c5d561d228d3c5ad5d855c58b"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_mapping_char_filter.html#a1d8e380c5d561d228d3c5ad5d855c58b">Read</a> ()</td></tr>
<tr class="separator:a1d8e380c5d561d228d3c5ad5d855c58b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cf53909c4777c1fb1fc25d985d1c867"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_mapping_char_filter.html#a9cf53909c4777c1fb1fc25d985d1c867">Read</a> (System.Char[] cbuf, int off, int len)</td></tr>
<tr class="separator:a9cf53909c4777c1fb1fc25d985d1c867"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter.html">Lucene.Net.Analysis.BaseCharFilter</a></td></tr>
<tr class="memitem:afea05f46762da22f6e7caa0995d9827e inherit pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter"><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_analysis_1_1_base_char_filter.html#afea05f46762da22f6e7caa0995d9827e">BaseCharFilter</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html">CharStream</a> @in)</td></tr>
<tr class="separator:afea05f46762da22f6e7caa0995d9827e inherit pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca9138da444f13867449fc39a63365dd inherit pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter"><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_analysis_1_1_base_char_filter.html#aca9138da444f13867449fc39a63365dd">GetLastCumulativeDiff</a> ()</td></tr>
<tr class="separator:aca9138da444f13867449fc39a63365dd inherit pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08320b1e3a2f037dcc7ba7d75973ebca inherit pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter"><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_analysis_1_1_base_char_filter.html#a08320b1e3a2f037dcc7ba7d75973ebca">AddOffCorrectMap</a> (int off, int cumulativeDiff)</td></tr>
<tr class="separator:a08320b1e3a2f037dcc7ba7d75973ebca inherit pro_methods_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter.html">Lucene.Net.Analysis.BaseCharFilter</a></td></tr>
<tr class="memitem:a6342200c7a6c2bdbf05e383f3006f175 inherit properties_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter"><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_analysis_1_1_base_char_filter.html#a6342200c7a6c2bdbf05e383f3006f175">LastCumulativeDiff</a><code> [get]</code></td></tr>
<tr class="separator:a6342200c7a6c2bdbf05e383f3006f175 inherit properties_class_lucene_1_1_net_1_1_analysis_1_1_base_char_filter"><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>Simplistic <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_filter.html" title="Subclasses of CharFilter can be chained to filter CharStream. They can be used as System...">CharFilter</a> that applies the mappings contained in a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_normalize_char_map.html" title="Holds a map of String input to String output, to be used with MappingCharFilter. ">NormalizeCharMap</a> to the character stream, and correcting the resulting changes to the offsets. </p>
<p>Definition at line <a class="el" href="_mapping_char_filter_8cs_source.html#l00028">28</a> of file <a class="el" href="_mapping_char_filter_8cs_source.html">MappingCharFilter.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab0d57b08d5c7420c68172d7c30816f56"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Analysis.MappingCharFilter.MappingCharFilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_normalize_char_map.html">NormalizeCharMap</a>&#160;</td>
<td class="paramname"><em>normMap</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_char_stream.html">CharStream</a> @&#160;</td>
<td class="paramname"><em>in</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor that takes a <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_char_stream.html" title="CharStream adds CorrectOffset functionality over System.IO.TextReader. All Tokenizers accept a CharSt...">CharStream</a>. </p>
<p>Definition at line <a class="el" href="_mapping_char_filter_8cs_source.html#l00037">37</a> of file <a class="el" href="_mapping_char_filter_8cs_source.html">MappingCharFilter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ad4541be021d86123f8bc9fea9f554828"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Analysis.MappingCharFilter.MappingCharFilter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_normalize_char_map.html">NormalizeCharMap</a>&#160;</td>
<td class="paramname"><em>normMap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.IO.TextReader @&#160;</td>
<td class="paramname"><em>in</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Easy-use constructor that takes a System.IO.TextReader. </p>
<p>Definition at line <a class="el" href="_mapping_char_filter_8cs_source.html#l00044">44</a> of file <a class="el" href="_mapping_char_filter_8cs_source.html">MappingCharFilter.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1d8e380c5d561d228d3c5ad5d855c58b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Analysis.MappingCharFilter.Read </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="_mapping_char_filter_8cs_source.html#l00050">50</a> of file <a class="el" href="_mapping_char_filter_8cs_source.html">MappingCharFilter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a9cf53909c4777c1fb1fc25d985d1c867"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Analysis.MappingCharFilter.Read </td>
<td>(</td>
<td class="paramtype">System.Char[]&#160;</td>
<td class="paramname"><em>cbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>off</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>len</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="_mapping_char_filter_8cs_source.html#l00145">145</a> of file <a class="el" href="_mapping_char_filter_8cs_source.html">MappingCharFilter.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Analysis/<a class="el" href="_mapping_char_filter_8cs_source.html">MappingCharFilter.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:48 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>