blob: b25c256455168af8a96270ffec34516d50422293 [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>Namespace Lucene.Net.Analysis.Ar
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.Analysis.Ar
| Apache Lucene.NET 4.8.0-beta00010 Documentation ">
<meta name="generator" content="docfx 2.56.0.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">
<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.Ar">
<h1 id="Lucene_Net_Analysis_Ar" data-uid="Lucene.Net.Analysis.Ar" class="text-break">Namespace Lucene.Net.Analysis.Ar
</h1>
<div class="markdown level0 summary"><!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<p>Analyzer for Arabic.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicAnalyzer.html">ArabicAnalyzer</a></h4>
<section><p><span class="xref">Lucene.Net.Analysis.Analyzer</span> for Arabic.
<p>
This analyzer implements light-stemming as specified by:
<code>Light Stemming for Arabic Information Retrieval</code><br><a href="http://www.mtholyoke.edu/~lballest/Pubs/arab_stem05.pdf">http://www.mtholyoke.edu/~lballest/Pubs/arab_stem05.pdf</a>
<p>
The analysis package contains three primary components:
<ul><li><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicNormalizationFilter.html">ArabicNormalizationFilter</a>: Arabic orthographic normalization.</li><li><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicStemFilter.html">ArabicStemFilter</a>: Arabic light stemming</li><li>Arabic stop words file: a set of default Arabic stop words.</li></ul></p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicLetterTokenizer.html">ArabicLetterTokenizer</a></h4>
<section><p>Tokenizer that breaks text into runs of letters and diacritics.
<p>
The problem with the standard Letter tokenizer is that it fails on diacritics.
Handling similar to this is necessary for Indic Scripts, Hebrew, Thaana, etc.
</p>
<p>
You must specify the required <span class="xref">Lucene.Net.Util.LuceneVersion</span> compatibility when creating
<a class="xref" href="Lucene.Net.Analysis.Ar.ArabicLetterTokenizer.html">ArabicLetterTokenizer</a>:
<ul><li>As of 3.1, <a class="xref" href="Lucene.Net.Analysis.Util.CharTokenizer.html">CharTokenizer</a> uses an int based API to normalize and
detect token characters. See <a class="xref" href="Lucene.Net.Analysis.Ar.ArabicLetterTokenizer.html#Lucene_Net_Analysis_Ar_ArabicLetterTokenizer_IsTokenChar_System_Int32_">IsTokenChar(Int32)</a> and
<a class="xref" href="Lucene.Net.Analysis.Util.CharTokenizer.html#Lucene_Net_Analysis_Util_CharTokenizer_Normalize_System_Int32_">Normalize(Int32)</a> for details.</li></ul>
</p></p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicLetterTokenizerFactory.html">ArabicLetterTokenizerFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Ar.ArabicLetterTokenizer.html">ArabicLetterTokenizer</a> </p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicNormalizationFilter.html">ArabicNormalizationFilter</a></h4>
<section><p>A <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that applies <a class="xref" href="Lucene.Net.Analysis.Ar.ArabicNormalizer.html">ArabicNormalizer</a> to normalize the orthography.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicNormalizationFilterFactory.html">ArabicNormalizationFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Ar.ArabicNormalizationFilter.html">ArabicNormalizationFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_arnormal&quot; class=&quot;solr.TextField&quot; positionIncrementGap=&quot;100&quot;>
&lt;analyzer>
&lt;tokenizer class=&quot;solr.StandardTokenizerFactory&quot;/>
&lt;filter class=&quot;solr.ArabicNormalizationFilterFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicNormalizer.html">ArabicNormalizer</a></h4>
<section><p>Normalizer for Arabic.
<p>
Normalization is done in-place for efficiency, operating on a termbuffer.
<p>
Normalization is defined as:
<ul><li> Normalization of hamza with alef seat to a bare alef.</li><li> Normalization of teh marbuta to heh</li><li> Normalization of dotless yeh (alef maksura) to yeh.</li><li> Removal of Arabic diacritics (the harakat)</li><li> Removal of tatweel (stretching character).</li></ul></p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicStemFilter.html">ArabicStemFilter</a></h4>
<section><p>A <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that applies <a class="xref" href="Lucene.Net.Analysis.Ar.ArabicStemmer.html">ArabicStemmer</a> to stem Arabic words..
<p>
To prevent terms from being stemmed use an instance of
<a class="xref" href="Lucene.Net.Analysis.Miscellaneous.SetKeywordMarkerFilter.html">SetKeywordMarkerFilter</a> or a custom <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that sets
the <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html">KeywordAttribute</a> before this <span class="xref">Lucene.Net.Analysis.TokenStream</span>.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicStemFilterFactory.html">ArabicStemFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Ar.ArabicStemFilter.html">ArabicStemFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_arstem&quot; class=&quot;solr.TextField&quot; positionIncrementGap=&quot;100&quot;>
&lt;analyzer>
&lt;tokenizer class=&quot;solr.StandardTokenizerFactory&quot;/>
&lt;filter class=&quot;solr.ArabicNormalizationFilterFactory&quot;/>
&lt;filter class=&quot;solr.ArabicStemFilterFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicStemmer.html">ArabicStemmer</a></h4>
<section><p>Stemmer for Arabic.
<p>
Stemming is done in-place for efficiency, operating on a termbuffer.
<p>
Stemming is defined as:
<ul><li> Removal of attached definite article, conjunction, and prepositions.</li><li> Stemming of common suffixes.</li></ul></p>
</section>
</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/blob/docs/4.8.0-beta00010/src/Lucene.Net.Analysis.Common/Analysis/Ar/package.md/#L2" class="contribution-link">Improve this Doc</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 Licensed to the Apache Software Foundation (ASF)
</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>