| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class ColognePhonetic |
| | Apache Lucene.NET 4.8.0-beta00011 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class ColognePhonetic |
| | Apache Lucene.NET 4.8.0-beta00011 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.ColognePhonetic"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic" data-uid="Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic" class="text-break">Class ColognePhonetic |
| </h1> |
| <div class="markdown level0 summary"><p>Encodes a string into a Cologne Phonetic value.</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">ColognePhonetic</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.IStringEncoder.html">IStringEncoder</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.Phonetic.Language.html">Lucene.Net.Analysis.Phonetic.Language</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Phonetic.dll</h6> |
| <h5 id="Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class ColognePhonetic : IStringEncoder</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>Implements the <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">KÖlner Phonetik</a> |
| (Cologne Phonetic) algorithm issued by Hans Joachim Postel in 1969. |
| <p> |
| The <em>KÖlner Phonetik</em> is a phonetic algorithm which is optimized for the German language. |
| It is related to the well-known soundex algorithm. |
| <p> |
| <h2>Algorithm</h2> |
| <ul><li>Step 1: |
| After preprocessing (conversion to upper case, transcription of <a href="http://en.wikipedia.org/wiki/Germanic_umlaut">germanic umlauts</a>, removal of non alphabetical characters) the |
| letters of the supplied text are replaced by their phonetic code according to the following table. |
| <table><thead><tr><th>LetterContextCode</th><th></th></tr></thead><tbody><tr><td>A, E, I, J, O, U, Y0</td><td></td></tr><tr><td>H-</td><td></td></tr><tr><td>B1</td><td></td></tr><tr><td>Pnot before H1</td><td></td></tr><tr><td>D, Tnot before C, S, Z2</td><td></td></tr><tr><td>F, V, W3</td><td></td></tr><tr><td>Pbefore H3</td><td></td></tr><tr><td>G, K, Q4</td><td></td></tr><tr><td>Ct onset before A, H, K, L, O, Q, R, U, X <p>OR</p> |
| before A, H, K, O, Q, U, X except after S, Z4</td><td></td></tr><tr><td>Xnot after C, K, Q48</td><td></td></tr><tr><td>L5</td><td></td></tr><tr><td>M, N6</td><td></td></tr><tr><td>R7</td><td></td></tr><tr><td>S, Z8</td><td></td></tr><tr><td>Cafter S, Z <p>OR</p> |
| at onset except before A, H, K, L, O, Q, R, U, X <p>OR</p> |
| not before A, H, K, O, Q, U, X |
| 8</td><td></td></tr><tr><td>D, Tbefore C, S, Z8</td><td></td></tr><tr><td>Xafter C, K, Q8</td><td></td></tr></tbody></table> |
| <p> |
| <small><em>(Source: <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik#Buchstabencodes">Wikipedia (de): |
| KÖlner Phonetik -- Buchstabencodes</a>)</em></small> |
| </p> |
| <h4>Example:</h4> |
| <code>"MÜller-LÜdenscheidt" => "MULLERLUDENSCHEIDT" => "6005507500206880022"</code> |
| </li><li>Step 2: |
| Collapse of all multiple consecutive code digits. |
| <h4>Example:</h4> |
| <code>"6005507500206880022" => "6050750206802"</code> |
| </li><li>Step 3: |
| Removal of all codes "0" except at the beginning. This means that two or more identical consecutive digits can occur |
| if they occur after removing the "0" digits. |
| <h4>Example:</h4> |
| <code>"6050750206802" => "65752682"</code> |
| </li></ul> |
| <p> |
| This class is thread-safe. |
| <p> |
| See: <a href="http://de.wikipedia.org/wiki/K%C3%B6lner_Phonetik">Wikipedia (de): Kölner Phonetik (in German)</a> |
| <p> |
| since 1.5</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_Encode_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic.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_beta00011/src/Lucene.Net.Analysis.Phonetic/Language/ColognePhonetic.cs/#L463">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_Encode_" data-uid="Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic.Encode*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_Encode_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic.Encode(System.String)">Encode(String)</h4> |
| <div class="markdown level1 summary"></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 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></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></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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_GetColognePhonetic_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic.GetColognePhonetic(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_beta00011/src/Lucene.Net.Analysis.Phonetic/Language/ColognePhonetic.cs/#L319">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_GetColognePhonetic_" data-uid="Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic.GetColognePhonetic*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_GetColognePhonetic_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic.GetColognePhonetic(System.String)">GetColognePhonetic(String)</h4> |
| <div class="markdown level1 summary"><p> |
| Implements the <em>Kölner Phonetik</em> algorithm. |
| </p> |
| <p> |
| In contrast to the initial description of the algorithm, this implementation does the encoding in one pass. |
| </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 GetColognePhonetic(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></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 corresponding encoding according to the <em>Kölner Phonetik</em> algorithm</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_IsEncodeEqual_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic.IsEncodeEqual(System.String%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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net.Analysis.Phonetic/Language/ColognePhonetic.cs/#L468">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_IsEncodeEqual_" data-uid="Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic.IsEncodeEqual*"></a> |
| <h4 id="Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic_IsEncodeEqual_System_String_System_String_" data-uid="Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic.IsEncodeEqual(System.String,System.String)">IsEncodeEqual(String, String)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool IsEncodeEqual(string text1, string text2)</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">text1</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">text2</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.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Phonetic.Language.IStringEncoder.html">IStringEncoder</a> |
| </div> |
| </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Phonetic_Language_ColognePhonetic.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Phonetic.Language.ColognePhonetic%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_beta00011/src/Lucene.Net.Analysis.Phonetic/Language/ColognePhonetic.cs/#L171" 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> |