blob: 67540e16392eb57e0ff5efa151e93a5e97bc63b3 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class RSLPStemmerBase
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class RSLPStemmerBase
| Apache Lucene.NET 4.8.0-beta00013 Documentation ">
<meta name="generator" content="docfx 2.56.2.0">
<link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="analysis-common/toc.html">
<meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span>
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search">
<ul class="level0 breadcrumb">
<li>
<a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a>
<span id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</span>
</li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Lucene.Net.Analysis.Pt.RSLPStemmerBase">
<h1 id="Lucene_Net_Analysis_Pt_RSLPStemmerBase" data-uid="Lucene.Net.Analysis.Pt.RSLPStemmerBase" class="text-break">Class RSLPStemmerBase
</h1>
<div class="markdown level0 summary"><p>Base class for stemmers that use a set of RSLP-like stemming steps.
<p>
RSLP (Removedor de Sufixos da Lingua Portuguesa) is an algorithm designed
originally for stemming the Portuguese language, described in the paper
<code>A Stemming Algorithm for the Portuguese Language</code>, Orengo et. al.
</p>
<p>
Since this time a plural-only modification (RSLP-S) as well as a modification
for the Galician language have been implemented. This class parses a configuration
file that describes <a class="xref" href="Lucene.Net.Analysis.Pt.RSLPStemmerBase.Step.html">RSLPStemmerBase.Step</a>s, where each <a class="xref" href="Lucene.Net.Analysis.Pt.RSLPStemmerBase.Step.html">RSLPStemmerBase.Step</a> contains a set of <a class="xref" href="Lucene.Net.Analysis.Pt.RSLPStemmerBase.Rule.html">RSLPStemmerBase.Rule</a>s.
</p>
<p>
The general rule format is: </p>
<pre><code>{ &quot;suffix&quot;, N, &quot;replacement&quot;, { &quot;exception1&quot;, &quot;exception2&quot;, ...}}</code></pre>
<p>where:
<ul><li><code>suffix</code> is the suffix to be removed (such as &quot;inho&quot;).</li><li><code>N</code> is the min stem size, where stem is defined as the candidate stem
after removing the suffix (but before appending the replacement!)</li><li><code>replacement</code> is an optimal string to append after removing the suffix.
This can be the empty string.</li><li><code>exceptions</code> is an optional list of exceptions, patterns that should
not be stemmed. These patterns can be specified as whole word or suffix (ends-with)
patterns, depending upon the exceptions format flag in the step header.</li></ul>
</p>
<p>
A step is an ordered list of rules, with a structure in this format:
<blockquote>{ &quot;name&quot;, N, B, { &quot;cond1&quot;, &quot;cond2&quot;, ... }
... rules ... };
</blockquote>
where:
<ul><li><code>name</code> is a name for the step (such as &quot;Plural&quot;).</li><li><code>N</code> is the min word size. Words that are less than this length bypass
the step completely, as an optimization. Note: N can be zero, in this case this
implementation will automatically calculate the appropriate value from the underlying
rules.</li><li><code>B</code> is a &quot;boolean&quot; flag specifying how exceptions in the rules are matched.
A value of 1 indicates whole-word pattern matching, a value of 0 indicates that
exceptions are actually suffixes and should be matched with ends-with.</li><li><code>conds</code> are an optional list of conditions to enter the step at all. If
the list is non-empty, then a word must end with one of these conditions or it will
bypass the step completely as an optimization.</li></ul>
</p>
<a href="http://www.inf.ufrgs.br/~viviane/rslp/index.htm">RSLP description</a></p>
<div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">RSLPStemmerBase</span></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.Gl.GalicianMinimalStemmer.html">GalicianMinimalStemmer</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.Gl.GalicianStemmer.html">GalicianStemmer</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.Pt.PortugueseMinimalStemmer.html">PortugueseMinimalStemmer</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Analysis.Pt.PortugueseStemmer.html">PortugueseStemmer</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.Pt.html">Lucene.Net.Analysis.Pt</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6>
<h5 id="Lucene_Net_Analysis_Pt_RSLPStemmerBase_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class RSLPStemmerBase</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Pt_RSLPStemmerBase_Parse_System_Type_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Pt.RSLPStemmerBase.Parse(System.Type%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Pt/RSLPStemmerBase.cs/#L280">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Pt_RSLPStemmerBase_Parse_" data-uid="Lucene.Net.Analysis.Pt.RSLPStemmerBase.Parse*"></a>
<h4 id="Lucene_Net_Analysis_Pt_RSLPStemmerBase_Parse_System_Type_System_String_" data-uid="Lucene.Net.Analysis.Pt.RSLPStemmerBase.Parse(System.Type,System.String)">Parse(Type, String)</h4>
<div class="markdown level1 summary"><p>Parse a resource file into an RSLP stemmer description. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected static IDictionary&lt;string, RSLPStemmerBase.Step&gt; Parse(Type clazz, string resource)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Type</span></td>
<td><span class="parametername">clazz</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">resource</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IDictionary</span>&lt;<span class="xref">System.String</span>, <a class="xref" href="Lucene.Net.Analysis.Pt.RSLPStemmerBase.Step.html">RSLPStemmerBase.Step</a>&gt;</td>
<td><p>a Map containing the named <a class="xref" href="Lucene.Net.Analysis.Pt.RSLPStemmerBase.Step.html">RSLPStemmerBase.Step</a>s in this description. </p>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Pt_RSLPStemmerBase.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Pt.RSLPStemmerBase%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/apache/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Pt/RSLPStemmerBase.cs/#L82" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2020 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script>
</body>
</html>