| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class Lang |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class Lang |
| | 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.Lang"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Lang" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang" class="text-break">Class Lang |
| </h1> |
| <div class="markdown level0 summary"><p>Language guessing utility.</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">Lang</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_Lang_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class Lang</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>This class encapsulates rules used to guess the possible languages that a word originates from. This is |
| done by reference to a whole series of rules distributed in resource files. |
| <p> |
| Instances of this class are typically managed through the static factory method <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_GetInstance_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_">GetInstance(NameType)</a>. |
| Unless you are developing your own language guessing rules, you will not need to interact with this class directly. |
| <p> |
| This class is intended to be immutable and thread-safe. |
| <p> |
| <strong>Lang resources</strong> |
| <p> |
| Language guessing rules are typically loaded from resource files. These are UTF-8 encoded text files. |
| They are systematically named following the pattern: |
| <code>Lucene.Net.Analysis.Phonetic.Language.Bm.lang.txt</code> |
| The format of these resources is the following: |
| <table><tbody><tr><td>Rules:</td><td> |
| Whitespace separated strings. |
| There should be 3 columns to each row, and these will be interpreted as: |
| <ol><li>pattern:a regular expression.</li><li>languages:a '+'-separated list of languages.</li><li>acceptOnMatch:'true' or 'false' indicating if a match rules in or rules out the language.</li></ol> |
| </td></tr><tr><td>End-of-line comments:</td><td>Any occurrence of '//' will cause all text following on that line to be discarded as a comment.</td></tr><tr><td>Multi-line comments:</td><td>Any line starting with '/<em>' will start multi-line commenting mode. This will skip all content until a line ending in '</em>' and '/' is found.</td></tr><tr><td>Blank lines:</td><td>All blank lines will be skipped.</td></tr></tbody></table> |
| <p> |
| Port of lang.php |
| <p> |
| since 1.6</p> |
| </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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_GetInstance_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.GetInstance(Lucene.Net.Analysis.Phonetic.Language.Bm.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/Lang.cs/#L132">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_GetInstance_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.GetInstance*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_GetInstance_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.GetInstance(Lucene.Net.Analysis.Phonetic.Language.Bm.NameType)">GetInstance(NameType)</h4> |
| <div class="markdown level1 summary"><p>Gets a Lang instance for one of the supported <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a>s.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static Lang GetInstance(NameType nameType)</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 <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.NameType.html">NameType</a> to look up.</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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.html">Lang</a></td> |
| <td><p>A Lang encapsulating the language guessing rules for that name type.</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_Lang_GuessLanguage_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.GuessLanguage(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/Lang.cs/#L231">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_GuessLanguage_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.GuessLanguage*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_GuessLanguage_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.GuessLanguage(System.String)">GuessLanguage(String)</h4> |
| <div class="markdown level1 summary"><p>Guesses the language of a word.</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 GuessLanguage(string text)</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">text</span></td> |
| <td><p>The word.</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 language that the word originates from or <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Languages.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Languages_ANY">ANY</a> if there was no unique match.</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_Lang_GuessLanguages_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.GuessLanguages(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/Lang.cs/#L242">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_GuessLanguages_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.GuessLanguages*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_GuessLanguages_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.GuessLanguages(System.String)">GuessLanguages(String)</h4> |
| <div class="markdown level1 summary"><p>Guesses the languages of a word.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual LanguageSet GuessLanguages(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 word.</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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.LanguageSet.html">LanguageSet</a></td> |
| <td><p>A Set of Strings of language names that are potential matches for the input word.</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_Lang_LoadFromResource_System_String_Lucene_Net_Analysis_Phonetic_Language_Bm_Languages_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.LoadFromResource(System.String%2CLucene.Net.Analysis.Phonetic.Language.Bm.Languages)%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/Lang.cs/#L148">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_LoadFromResource_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.LoadFromResource*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_LoadFromResource_System_String_Lucene_Net_Analysis_Phonetic_Language_Bm_Languages_" data-uid="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.LoadFromResource(System.String,Lucene.Net.Analysis.Phonetic.Language.Bm.Languages)">LoadFromResource(String, Languages)</h4> |
| <div class="markdown level1 summary"><p>Loads language rules from a resource. |
| <p> |
| In normal use, you will obtain instances of Lang through the <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.html#Lucene_Net_Analysis_Phonetic_Language_Bm_Lang_GetInstance_Lucene_Net_Analysis_Phonetic_Language_Bm_NameType_">GetInstance(NameType)</a> method. |
| You will only need to call this yourself if you are developing custom language mapping rules.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static Lang LoadFromResource(string languageRulesResourceName, Languages languages)</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">languageRulesResourceName</span></td> |
| <td><p>The fully-qualified or partially-qualified resource name to load.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Languages.html">Languages</a></td> |
| <td><span class="parametername">languages</span></td> |
| <td><p>The languages that these rules will support.</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><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.Bm.Lang.html">Lang</a></td> |
| <td><p>A Lang encapsulating the loaded language-guessing rules.</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_Lang.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.Bm.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" 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/Lang.cs/#L79" 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> |
