| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class ICUCollationAttributeFactory |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class ICUCollationAttributeFactory |
| | 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="icu/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.Collation.ICUCollationAttributeFactory"> |
| |
| |
| <h1 id="Lucene_Net_Collation_ICUCollationAttributeFactory" data-uid="Lucene.Net.Collation.ICUCollationAttributeFactory" class="text-break">Class ICUCollationAttributeFactory |
| </h1> |
| <div class="markdown level0 summary"><p>Converts each token into its <span class="xref">ICU4N.Text.CollationKey</span>, and |
| then encodes bytes as an index term.</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">Lucene.Net.Util.AttributeSource.AttributeFactory</span></div> |
| <div class="level2"><span class="xref">ICUCollationAttributeFactory</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.AttributeFactory.DEFAULT_ATTRIBUTE_FACTORY</span> |
| </div> |
| <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.Collation.html">Lucene.Net.Collation</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.ICU.dll</h6> |
| <h5 id="Lucene_Net_Collation_ICUCollationAttributeFactory_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class ICUCollationAttributeFactory : AttributeSource.AttributeFactory</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Collation_ICUCollationAttributeFactory_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p><strong>WARNING:</strong> Make sure you use exactly the same <span class="xref">ICU4N.Text.Collator</span> at |
| index and query time -- <span class="xref">ICU4N.Text.CollationKey</span>s are only comparable when produced by |
| the same <span class="xref">ICU4N.Text.Collator</span>. <span class="xref">ICU4N.Text.RuleBasedCollator</span>s are |
| independently versioned, so it is safe to search against stored |
| <span class="xref">ICU4N.Text.CollationKey</span>s if the following are exactly the same (best practice is |
| to store this information with the index and check that they remain the |
| same at query time): |
| <p> |
| <ol><li>Collator version - see <span class="xref">ICU4N.Text.Collator</span> Version</li><li>The collation strength used - see <span class="xref">ICU4N.Text.Collator.Strength</span></li></ol> |
| <p> |
| <span class="xref">ICU4N.Text.CollationKey</span>s generated by ICU Collators are not compatible with those |
| generated by java.text.Collators. Specifically, if you use |
| <a class="xref" href="Lucene.Net.Collation.ICUCollationAttributeFactory.html">ICUCollationAttributeFactory</a> to generate index terms, do not use |
| CollationAttributeFactory on the query side, or vice versa. |
| <p> |
| <a class="xref" href="Lucene.Net.Collation.ICUCollationAttributeFactory.html">ICUCollationAttributeFactory</a> is significantly faster and generates significantly |
| shorter keys than CollationAttributeFactory. See |
| <a href="http://site.icu-project.org/charts/collation-icu4j-sun">http://site.icu-project.org/charts/collation-icu4j-sun</a> for key |
| generation timing and key length comparisons between ICU4J and |
| java.text.Collator over several languages.</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_Collation_ICUCollationAttributeFactory__ctor_ICU4N_Text_Collator_.md&value=---%0Auid%3A%20Lucene.Net.Collation.ICUCollationAttributeFactory.%23ctor(ICU4N.Text.Collator)%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.ICU/Collation/ICUCollationAttributeFactory.cs/#L69">View Source</a> |
| </span> |
| <a id="Lucene_Net_Collation_ICUCollationAttributeFactory__ctor_" data-uid="Lucene.Net.Collation.ICUCollationAttributeFactory.#ctor*"></a> |
| <h4 id="Lucene_Net_Collation_ICUCollationAttributeFactory__ctor_ICU4N_Text_Collator_" data-uid="Lucene.Net.Collation.ICUCollationAttributeFactory.#ctor(ICU4N.Text.Collator)">ICUCollationAttributeFactory(Collator)</h4> |
| <div class="markdown level1 summary"><p>Create an <a class="xref" href="Lucene.Net.Collation.ICUCollationAttributeFactory.html">ICUCollationAttributeFactory</a>, using |
| <span class="xref">Lucene.Net.Util.AttributeSource.AttributeFactory.DEFAULT_ATTRIBUTE_FACTORY</span> as the |
| factory for all other attributes.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ICUCollationAttributeFactory(Collator collator)</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">ICU4N.Text.Collator</span></td> |
| <td><span class="parametername">collator</span></td> |
| <td><p><span class="xref">ICU4N.Text.CollationKey</span> generator</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_Collation_ICUCollationAttributeFactory__ctor_Lucene_Net_Util_AttributeSource_AttributeFactory_ICU4N_Text_Collator_.md&value=---%0Auid%3A%20Lucene.Net.Collation.ICUCollationAttributeFactory.%23ctor(Lucene.Net.Util.AttributeSource.AttributeFactory%2CICU4N.Text.Collator)%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.ICU/Collation/ICUCollationAttributeFactory.cs/#L80">View Source</a> |
| </span> |
| <a id="Lucene_Net_Collation_ICUCollationAttributeFactory__ctor_" data-uid="Lucene.Net.Collation.ICUCollationAttributeFactory.#ctor*"></a> |
| <h4 id="Lucene_Net_Collation_ICUCollationAttributeFactory__ctor_Lucene_Net_Util_AttributeSource_AttributeFactory_ICU4N_Text_Collator_" data-uid="Lucene.Net.Collation.ICUCollationAttributeFactory.#ctor(Lucene.Net.Util.AttributeSource.AttributeFactory,ICU4N.Text.Collator)">ICUCollationAttributeFactory(AttributeSource.AttributeFactory, Collator)</h4> |
| <div class="markdown level1 summary"><p>Create an <a class="xref" href="Lucene.Net.Collation.ICUCollationAttributeFactory.html">ICUCollationAttributeFactory</a>, using the supplied Attribute |
| Factory as the factory for all other attributes.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ICUCollationAttributeFactory(AttributeSource.AttributeFactory delegate, Collator collator)</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">Lucene.Net.Util.AttributeSource.AttributeFactory</span></td> |
| <td><span class="parametername">delegate</span></td> |
| <td><p>Attribute Factory</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">ICU4N.Text.Collator</span></td> |
| <td><span class="parametername">collator</span></td> |
| <td><p><span class="xref">ICU4N.Text.CollationKey</span> generator</p> |
| </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_Collation_ICUCollationAttributeFactory_CreateAttributeInstance__1.md&value=---%0Auid%3A%20Lucene.Net.Collation.ICUCollationAttributeFactory.CreateAttributeInstance%60%601%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.ICU/Collation/ICUCollationAttributeFactory.cs/#L86">View Source</a> |
| </span> |
| <a id="Lucene_Net_Collation_ICUCollationAttributeFactory_CreateAttributeInstance_" data-uid="Lucene.Net.Collation.ICUCollationAttributeFactory.CreateAttributeInstance*"></a> |
| <h4 id="Lucene_Net_Collation_ICUCollationAttributeFactory_CreateAttributeInstance__1" data-uid="Lucene.Net.Collation.ICUCollationAttributeFactory.CreateAttributeInstance``1">CreateAttributeInstance<T>()</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 override Attribute CreateAttributeInstance<T>() |
| where T : IAttribute</code></pre> |
| </div> |
| <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">Lucene.Net.Util.Attribute</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Util.AttributeSource.AttributeFactory.CreateAttributeInstance<T>()</span></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Collation_ICUCollationAttributeFactory.md&value=---%0Auid%3A%20Lucene.Net.Collation.ICUCollationAttributeFactory%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.ICU/Collation/ICUCollationAttributeFactory.cs/#L57" 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> |