| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class PhoneticEngine |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class PhoneticEngine |
| | 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-phonetic/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.Phonetic.Language.Bm.PhoneticEngine"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine" class="text-break">Class PhoneticEngine |
| </h1> |
| <div class="markdown level0 summary"><p>Converts words into potential phonetic representations.</p> |
| </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">PhoneticEngine</span></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.Phonetic.Language.Bm.html">Lucene.Net.Analysis.Phonetic.Language.Bm</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Phonetic.dll</h6> |
| <h5 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class PhoneticEngine</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>This is a two-stage process. Firstly, the word is converted into a phonetic representation that takes |
| into account the likely source language. Next, this phonetic representation is converted into a |
| pan-European 'average' representation, allowing comparison between different versions of essentially |
| the same word from different languages. |
| <p> |
| This class is intentionally immutable and thread-safe. |
| If you wish to alter the settings for a PhoneticEngine, you |
| must make a new one with the updated settings. |
| <p> |
| Ported from phoneticengine.php |
| <p> |
| since 1.6</p> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine__ctor_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.%23ctor(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType%2CLucene.Net.Analysis.Phonetic.Language.Bm.RuleType%2CSystem.Boolean)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/Bm/PhoneticEngine.cs/#L325">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine__ctor_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine__ctor_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_System_Boolean_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.#ctor(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType,Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType,System.Boolean)">PhoneticEngine(NameType, RuleType, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Generates a new, fully-configured phonetic engine.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public PhoneticEngine(NameType nameType, RuleType ruleType, bool concat)</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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a></td> |
| <td><span class="parametername">nameType</span></td> |
| <td><p>The type of names it will use.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a></td> |
| <td><span class="parametername">ruleType</span></td> |
| <td><p>The type of rules it will apply.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">concat</span></td> |
| <td><p>If it will concatenate multiple encodings.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine__ctor_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_System_Boolean_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.%23ctor(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType%2CLucene.Net.Analysis.Phonetic.Language.Bm.RuleType%2CSystem.Boolean%2CSystem.Int32)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/Bm/PhoneticEngine.cs/#L339">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine__ctor_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine__ctor_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_Lucene_Net_Analysis_Phonetic_Language_Bm_RuleType_System_Boolean_System_Int32_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.#ctor(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType,Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType,System.Boolean,System.Int32)">PhoneticEngine(NameType, RuleType, Boolean, Int32)</h4> |
| <div class="markdown level1 summary"><p>Generates a new, fully-configured phonetic engine. |
| <p> |
| since 1.7</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public PhoneticEngine(NameType nameType, RuleType ruleType, bool concat, int maxPhonemes)</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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a></td> |
| <td><span class="parametername">nameType</span></td> |
| <td><p>The type of names it will use.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a></td> |
| <td><span class="parametername">ruleType</span></td> |
| <td><p>The type of rules it will apply.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">concat</span></td> |
| <td><p>If it will concatenate multiple encodings.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxPhonemes</span></td> |
| <td><p>The maximum number of phonemes that will be handled.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_IsConcat.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.IsConcat%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/Bm/PhoneticEngine.cs/#L538">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_IsConcat_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.IsConcat*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_IsConcat" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.IsConcat">IsConcat</h4> |
| <div class="markdown level1 summary"><p>Gets if multiple phonetic encodings are concatenated or if just the first one is kept. |
| Returns <code>true</code> if multiple phonetic encodings are returned, <code>false</code> if just the first is.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool IsConcat { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</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.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_Lang.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.Lang%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/Bm/PhoneticEngine.cs/#L522">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_Lang_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.Lang*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_Lang" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.Lang">Lang</h4> |
| <div class="markdown level1 summary"><p>Gets the Lang language guessing rules being used.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Lang Lang { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.html">Lang</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_MaxPhonemes.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.MaxPhonemes%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/Bm/PhoneticEngine.cs/#L545">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_MaxPhonemes_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.MaxPhonemes*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_MaxPhonemes" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.MaxPhonemes">MaxPhonemes</h4> |
| <div class="markdown level1 summary"><p>Gets the maximum number of phonemes the engine will calculate for a given input. |
| <p> |
| since 1.7</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int MaxPhonemes { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</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.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_NameType.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.NameType%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/Bm/PhoneticEngine.cs/#L527">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_NameType_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.NameType*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_NameType" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.NameType">NameType</h4> |
| <div class="markdown level1 summary"><p>Gets the <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a> being used.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual NameType NameType { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_RuleType.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.RuleType%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/Bm/PhoneticEngine.cs/#L532">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_RuleType_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.RuleType*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_RuleType" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.RuleType">RuleType</h4> |
| <div class="markdown level1 summary"><p>Gets the <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a> being used.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual RuleType RuleType { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.RuleType.html">RuleType</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_Encode_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.Encode(System.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/Bm/PhoneticEngine.cs/#L406">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_Encode_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.Encode*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_Encode_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.Encode(System.String)">Encode(String)</h4> |
| <div class="markdown level1 summary"><p>Encodes a string to its phonetic representation.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string Encode(string input)</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.String</span></td> |
| <td><span class="parametername">input</span></td> |
| <td><p>The string to encode.</p> |
| </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.String</span></td> |
| <td><p>The encoding of the input.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_Encode_System_String_Lucene_Net_Analysis_Phonetic_Language_Bm_LanguageSet_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.Encode(System.String%2CLucene.Net.Analysis.Phonetic.Language.Bm.LanguageSet)%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/Bm/PhoneticEngine.cs/#L418">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_Encode_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.Encode*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine_Encode_System_String_Lucene_Net_Analysis_Phonetic_Language_Bm_LanguageSet_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine.Encode(System.String,Lucene.Net.Analysis.Phonetic.Language.Bm.LanguageSet)">Encode(String, LanguageSet)</h4> |
| <div class="markdown level1 summary"><p>Encodes an input string into an output phonetic representation, given a set of possible origin languages.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string Encode(string input, LanguageSet languageSet)</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.String</span></td> |
| <td><span class="parametername">input</span></td> |
| <td><p>String to phoneticise; a string with dashes or spaces separating each word.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.LanguageSet.html">LanguageSet</a></td> |
| <td><span class="parametername">languageSet</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.String</span></td> |
| <td><p>A phonetic representation of the input; a string containing '-'-separated phonetic representations of the input.</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_PhoneticEngine.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.PhoneticEngine%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Phonetic/Language/Bm/PhoneticEngine.cs/#L50" 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 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> |
