blob: 21d192555918d1842d09416347eaeb3d583fd63a [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.Ja
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.Analysis.Ja
| 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-kuromoji/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.Ja">
<h1 id="Lucene_Net_Analysis_Ja" data-uid="Lucene.Net.Analysis.Ja" class="text-break">Namespace Lucene.Net.Analysis.Ja
</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> Kuromoji is a morphological analyzer for Japanese text. </p>
<p> This module provides support for Japanese text analysis, including features such as part-of-speech tagging, lemmatization, and compound word analysis. </p>
<p> For an introduction to Lucene&#39;s analysis API, see the &lt;xref:Lucene.Net.Analysis&gt; package documentation. </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.Ja.GraphvizFormatter.html">GraphvizFormatter</a></h4>
<section><p>Outputs the dot (graphviz) string for the viterbi lattice.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseAnalyzer.html">JapaneseAnalyzer</a></h4>
<section><p>Analyzer for Japanese that uses morphological analysis.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseBaseFormFilter.html">JapaneseBaseFormFilter</a></h4>
<section><p>Replaces term text with the <a class="xref" href="Lucene.Net.Analysis.Ja.TokenAttributes.IBaseFormAttribute.html">IBaseFormAttribute</a>.
<p>
This acts as a lemmatizer for verbs and adjectives.
To prevent terms from being stemmed use an instance of
<span class="xref">Lucene.Net.Analysis.Miscellaneous.SetKeywordMarkerFilter</span> 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.IKeywordAttribute.html">IKeywordAttribute</a> before this <span class="xref">Lucene.Net.Analysis.TokenStream</span>.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseBaseFormFilterFactory.html">JapaneseBaseFormFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseBaseFormFilter.html">JapaneseBaseFormFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_ja&quot; class=&quot;solr.TextField&quot;>
&lt;analyzer>
&lt;tokenizer class=&quot;solr.JapaneseTokenizerFactory&quot;/>
&lt;filter class=&quot;solr.JapaneseBaseFormFilterFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.html">JapaneseIterationMarkCharFilter</a></h4>
<section><p>Normalizes Japanese horizontal iteration marks (odoriji) to their expanded form.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilterFactory.html">JapaneseIterationMarkCharFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseIterationMarkCharFilter.html">JapaneseIterationMarkCharFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_ja&quot; class=&quot;solr.TextField&quot; positionIncrementGap=&quot;100&quot; autoGeneratePhraseQueries=&quot;false&quot;>
&lt;analyzer>
&lt;charFilter class=&quot;solr.JapaneseIterationMarkCharFilterFactory normalizeKanji=&quot;true&quot; normalizeKana=&quot;true&quot;/>
&lt;tokenizer class=&quot;solr.JapaneseTokenizerFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseKatakanaStemFilter.html">JapaneseKatakanaStemFilter</a></h4>
<section><p>A <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that normalizes common katakana spelling variations
ending in a long sound character by removing this character (U+30FC). Only
katakana words longer than a minimum length are stemmed (default is four).</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseKatakanaStemFilterFactory.html">JapaneseKatakanaStemFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseKatakanaStemFilter.html">JapaneseKatakanaStemFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_ja&quot; class=&quot;solr.TextField&quot;>
&lt;analyzer>
&lt;tokenizer class=&quot;solr.JapaneseTokenizerFactory&quot;/>
&lt;filter class=&quot;solr.JapaneseKatakanaStemFilterFactory&quot;
minimumLength=&quot;4&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapanesePartOfSpeechStopFilter.html">JapanesePartOfSpeechStopFilter</a></h4>
<section><p>Removes tokens that match a set of part-of-speech tags.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapanesePartOfSpeechStopFilterFactory.html">JapanesePartOfSpeechStopFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Ja.JapanesePartOfSpeechStopFilter.html">JapanesePartOfSpeechStopFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_ja&quot; class=&quot;solr.TextField&quot;>
&lt;analyzer>
&lt;tokenizer class=&quot;solr.JapaneseTokenizerFactory&quot;/>
&lt;filter class=&quot;solr.JapanesePartOfSpeechStopFilterFactory&quot;
tags=&quot;stopTags.txt&quot;
enablePositionIncrements=&quot;true&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseReadingFormFilter.html">JapaneseReadingFormFilter</a></h4>
<section><p>A <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that replaces the term
attribute with the reading of a token in either katakana or romaji form.
The default reading form is katakana.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseReadingFormFilterFactory.html">JapaneseReadingFormFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseReadingFormFilter.html">JapaneseReadingFormFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_ja&quot; class=&quot;solr.TextField&quot;>
&lt;analyzer>
&lt;tokenizer class=&quot;solr.JapaneseTokenizerFactory&quot;/>
&lt;filter class=&quot;solr.JapaneseReadingFormFilterFactory&quot;
useRomaji=&quot;false&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseTokenizer.html">JapaneseTokenizer</a></h4>
<section><p>Tokenizer for Japanese that uses morphological analysis.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseTokenizerFactory.html">JapaneseTokenizerFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseTokenizer.html">JapaneseTokenizer</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_ja&quot; class=&quot;solr.TextField&quot;>
&lt;analyzer>
&lt;tokenizer class=&quot;solr.JapaneseTokenizerFactory&quot;
mode=&quot;NORMAL&quot;
userDictionary=&quot;user.txt&quot;
userDictionaryEncoding=&quot;UTF-8&quot;
discardPunctuation=&quot;true&quot;
/>
&lt;filter class=&quot;solr.JapaneseBaseFormFilterFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.Token.html">Token</a></h4>
<section><p>Analyzed token with morphological data from its dictionary.</p>
</section>
<h3 id="enums">Enums
</h3>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseTokenizerMode.html">JapaneseTokenizerMode</a></h4>
<section><p>Tokenization mode: this determines how the tokenizer handles
compound and unknown words.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Ja.JapaneseTokenizerType.html">JapaneseTokenizerType</a></h4>
<section><p>Token type reflecting the original source of this token</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.Kuromoji/overview.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>