| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class HyphenationCompoundWordTokenFilter |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class HyphenationCompoundWordTokenFilter |
| | 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-common/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.Compound.HyphenationCompoundWordTokenFilter"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter" class="text-break">Class HyphenationCompoundWordTokenFilter |
| </h1> |
| <div class="markdown level0 summary"><p>A <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that decomposes compound words found in many Germanic languages. |
| <p> |
| "Donaudampfschiff" becomes Donau, dampf, schiff so that you can find |
| "Donaudampfschiff" even when you only enter "schiff". It uses a hyphenation |
| grammar and a word dictionary to achieve this. |
| </p> |
| <p> |
| You must specify the required <span class="xref">Lucene.Net.Util.LuceneVersion</span> compatibility when creating |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html">CompoundWordTokenFilterBase</a>: |
| <ul><li>As of 3.1, CompoundWordTokenFilterBase correctly handles Unicode 4.0 |
| supplementary characters in strings and char arrays provided as compound word |
| dictionaries.</li></ul> |
| </p></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</span></div> |
| <div class="level2"><span class="xref">Lucene.Net.Analysis.TokenStream</span></div> |
| <div class="level3"><span class="xref">Lucene.Net.Analysis.TokenFilter</span></div> |
| <div class="level4"><a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html">CompoundWordTokenFilterBase</a></div> |
| <div class="level5"><span class="xref">HyphenationCompoundWordTokenFilter</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">System.IDisposable</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_DEFAULT_MIN_WORD_SIZE">CompoundWordTokenFilterBase.DEFAULT_MIN_WORD_SIZE</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_DEFAULT_MIN_SUBWORD_SIZE">CompoundWordTokenFilterBase.DEFAULT_MIN_SUBWORD_SIZE</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_DEFAULT_MAX_SUBWORD_SIZE">CompoundWordTokenFilterBase.DEFAULT_MAX_SUBWORD_SIZE</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_m_matchVersion">CompoundWordTokenFilterBase.m_matchVersion</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_m_dictionary">CompoundWordTokenFilterBase.m_dictionary</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_m_tokens">CompoundWordTokenFilterBase.m_tokens</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_m_minWordSize">CompoundWordTokenFilterBase.m_minWordSize</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_m_minSubwordSize">CompoundWordTokenFilterBase.m_minSubwordSize</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_m_maxSubwordSize">CompoundWordTokenFilterBase.m_maxSubwordSize</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_m_onlyLongestMatch">CompoundWordTokenFilterBase.m_onlyLongestMatch</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_m_termAtt">CompoundWordTokenFilterBase.m_termAtt</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_m_offsetAtt">CompoundWordTokenFilterBase.m_offsetAtt</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_IncrementToken">CompoundWordTokenFilterBase.IncrementToken()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_Reset">CompoundWordTokenFilterBase.Reset()</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Analysis.TokenFilter.m_input</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Analysis.TokenFilter.End()</span> |
| </div> |
| <div> |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.TokenFilter.html#Lucene_Net_Analysis_TokenFilter_Dispose_System_Boolean_">TokenFilter.Dispose(Boolean)</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Analysis.TokenStream.Dispose()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttributeFactory()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttributeClassesEnumerator()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttributeImplsEnumerator()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.AddAttributeImpl(Lucene.Net.Util.Attribute)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.AddAttribute<T>()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.HasAttributes</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.HasAttribute<T>()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttribute<T>()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.ClearAttributes()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.CaptureState()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.RestoreState(Lucene.Net.Util.AttributeSource.State)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetHashCode()</span> |
| </div> |
| <div> |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_Equals_System_Object_">AttributeSource.Equals(Object)</a> |
| </div> |
| <div> |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ReflectAsString_System_Boolean_">AttributeSource.ReflectAsString(Boolean)</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.ReflectWith(Lucene.Net.Util.IAttributeReflector)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.CloneAttributes()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.CopyTo(Lucene.Net.Util.AttributeSource)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.ToString()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</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> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.Compound.html">Lucene.Net.Analysis.Compound</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6> |
| <h5 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class HyphenationCompoundWordTokenFilter : CompoundWordTokenFilterBase, IDisposable</code></pre> |
| </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_Compound_HyphenationCompoundWordTokenFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.%23ctor(Lucene.Net.Util.LuceneVersion%2CLucene.Net.Analysis.TokenStream%2CLucene.Net.Analysis.Compound.Hyphenation.HyphenationTree)%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L119">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter__ctor_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.#ctor(Lucene.Net.Util.LuceneVersion,Lucene.Net.Analysis.TokenStream,Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree)">HyphenationCompoundWordTokenFilter(LuceneVersion, TokenStream, HyphenationTree)</h4> |
| <div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.html">HyphenationCompoundWordTokenFilter</a> with no dictionary. |
| <p> |
| Calls <a class="xref" href="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.html#Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_System_Int32_System_Int32_System_Int32_">HyphenationCompoundWordTokenFilter(LuceneVersion, TokenStream, HyphenationTree, Int32, Int32, Int32)</a> |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public HyphenationCompoundWordTokenFilter(LuceneVersion matchVersion, TokenStream input, HyphenationTree hyphenator)</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.LuceneVersion</span></td> |
| <td><span class="parametername">matchVersion</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.TokenStream</span></td> |
| <td><span class="parametername">input</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.html">HyphenationTree</a></td> |
| <td><span class="parametername">hyphenator</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_Compound_HyphenationCompoundWordTokenFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Lucene_Net_Analysis_Util_CharArraySet_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.%23ctor(Lucene.Net.Util.LuceneVersion%2CLucene.Net.Analysis.TokenStream%2CLucene.Net.Analysis.Compound.Hyphenation.HyphenationTree%2CLucene.Net.Analysis.Util.CharArraySet)%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L61">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter__ctor_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Lucene_Net_Analysis_Util_CharArraySet_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.#ctor(Lucene.Net.Util.LuceneVersion,Lucene.Net.Analysis.TokenStream,Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree,Lucene.Net.Analysis.Util.CharArraySet)">HyphenationCompoundWordTokenFilter(LuceneVersion, TokenStream, HyphenationTree, CharArraySet)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.html">HyphenationCompoundWordTokenFilter</a> instance. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public HyphenationCompoundWordTokenFilter(LuceneVersion matchVersion, TokenStream input, HyphenationTree hyphenator, CharArraySet dictionary)</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.LuceneVersion</span></td> |
| <td><span class="parametername">matchVersion</span></td> |
| <td><p>Lucene version to enable correct Unicode 4.0 behavior in the |
| dictionaries if Version > 3.0. See <a href="CompoundWordTokenFilterBase.html#version">CompoundWordTokenFilterBase</a> for details. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.TokenStream</span></td> |
| <td><span class="parametername">input</span></td> |
| <td><p>the <span class="xref">Lucene.Net.Analysis.TokenStream</span> to process </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.html">HyphenationTree</a></td> |
| <td><span class="parametername">hyphenator</span></td> |
| <td><p>the hyphenation pattern tree to use for hyphenation </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a></td> |
| <td><span class="parametername">dictionary</span></td> |
| <td><p>the word dictionary to match against. </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_Compound_HyphenationCompoundWordTokenFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Lucene_Net_Analysis_Util_CharArraySet_System_Int32_System_Int32_System_Int32_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.%23ctor(Lucene.Net.Util.LuceneVersion%2CLucene.Net.Analysis.TokenStream%2CLucene.Net.Analysis.Compound.Hyphenation.HyphenationTree%2CLucene.Net.Analysis.Util.CharArraySet%2CSystem.Int32%2CSystem.Int32%2CSystem.Int32%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L90">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter__ctor_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Lucene_Net_Analysis_Util_CharArraySet_System_Int32_System_Int32_System_Int32_System_Boolean_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.#ctor(Lucene.Net.Util.LuceneVersion,Lucene.Net.Analysis.TokenStream,Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree,Lucene.Net.Analysis.Util.CharArraySet,System.Int32,System.Int32,System.Int32,System.Boolean)">HyphenationCompoundWordTokenFilter(LuceneVersion, TokenStream, HyphenationTree, CharArraySet, Int32, Int32, Int32, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.html">HyphenationCompoundWordTokenFilter</a> instance.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public HyphenationCompoundWordTokenFilter(LuceneVersion matchVersion, TokenStream input, HyphenationTree hyphenator, CharArraySet dictionary, int minWordSize, int minSubwordSize, int maxSubwordSize, bool onlyLongestMatch)</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.LuceneVersion</span></td> |
| <td><span class="parametername">matchVersion</span></td> |
| <td><p>Lucene version to enable correct Unicode 4.0 behavior in the |
| dictionaries if Version > 3.0. See <a href="CompoundWordTokenFilterBase.html#version">CompoundWordTokenFilterBase</a> for details. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.TokenStream</span></td> |
| <td><span class="parametername">input</span></td> |
| <td><p>the <span class="xref">Lucene.Net.Analysis.TokenStream</span> to process </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.html">HyphenationTree</a></td> |
| <td><span class="parametername">hyphenator</span></td> |
| <td><p>the hyphenation pattern tree to use for hyphenation </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a></td> |
| <td><span class="parametername">dictionary</span></td> |
| <td><p>the word dictionary to match against. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minWordSize</span></td> |
| <td><p>only words longer than this get processed </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minSubwordSize</span></td> |
| <td><p>only subwords longer than this get to the output stream </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxSubwordSize</span></td> |
| <td><p>only subwords shorter than this get to the output stream </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">onlyLongestMatch</span></td> |
| <td><p>Add only the longest matching subword to the stream </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_Compound_HyphenationCompoundWordTokenFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.%23ctor(Lucene.Net.Util.LuceneVersion%2CLucene.Net.Analysis.TokenStream%2CLucene.Net.Analysis.Compound.Hyphenation.HyphenationTree%2CSystem.Int32%2CSystem.Int32%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L105">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter__ctor_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_System_Int32_System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.#ctor(Lucene.Net.Util.LuceneVersion,Lucene.Net.Analysis.TokenStream,Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree,System.Int32,System.Int32,System.Int32)">HyphenationCompoundWordTokenFilter(LuceneVersion, TokenStream, HyphenationTree, Int32, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.html">HyphenationCompoundWordTokenFilter</a> with no dictionary. |
| <p> |
| Calls <a class="xref" href="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.html#Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Lucene_Net_Analysis_Util_CharArraySet_System_Int32_System_Int32_System_Int32_System_Boolean_">HyphenationCompoundWordTokenFilter(LuceneVersion, TokenStream, HyphenationTree, CharArraySet, Int32, Int32, Int32, Boolean)</a> |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public HyphenationCompoundWordTokenFilter(LuceneVersion matchVersion, TokenStream input, HyphenationTree hyphenator, int minWordSize, int minSubwordSize, int maxSubwordSize)</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.LuceneVersion</span></td> |
| <td><span class="parametername">matchVersion</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.TokenStream</span></td> |
| <td><span class="parametername">input</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.html">HyphenationTree</a></td> |
| <td><span class="parametername">hyphenator</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minWordSize</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minSubwordSize</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxSubwordSize</span></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_Compound_HyphenationCompoundWordTokenFilter_Decompose.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.Decompose%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L197">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_Decompose_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.Decompose*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_Decompose" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.Decompose">Decompose()</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">protected override void Decompose()</code></pre> |
| </div> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Analysis.Compound.CompoundWordTokenFilterBase.html#Lucene_Net_Analysis_Compound_CompoundWordTokenFilterBase_Decompose">CompoundWordTokenFilterBase.Decompose()</a></div> |
| <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_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_IO_FileInfo_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.IO.FileInfo)%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L155">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_IO_FileInfo_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.IO.FileInfo)">GetHyphenationTree(FileInfo)</h4> |
| <div class="markdown level1 summary"><p>Create a hyphenator tree</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static HyphenationTree GetHyphenationTree(FileInfo hyphenationFile)</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.IO.FileInfo</span></td> |
| <td><span class="parametername">hyphenationFile</span></td> |
| <td><p>the file of the XML grammar to load </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.Compound.Hyphenation.HyphenationTree.html">HyphenationTree</a></td> |
| <td><p>An object representing the hyphenation patterns </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </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_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_IO_FileInfo_System_Text_Encoding_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.IO.FileInfo%2CSystem.Text.Encoding)%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L167">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_IO_FileInfo_System_Text_Encoding_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.IO.FileInfo,System.Text.Encoding)">GetHyphenationTree(FileInfo, Encoding)</h4> |
| <div class="markdown level1 summary"><p>Create a hyphenator tree</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static HyphenationTree GetHyphenationTree(FileInfo hyphenationFile, Encoding encoding)</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.IO.FileInfo</span></td> |
| <td><span class="parametername">hyphenationFile</span></td> |
| <td><p>the file of the XML grammar to load </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Text.Encoding</span></td> |
| <td><span class="parametername">encoding</span></td> |
| <td><p>The character encoding to use</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.Compound.Hyphenation.HyphenationTree.html">HyphenationTree</a></td> |
| <td><p>An object representing the hyphenation patterns </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </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_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_IO_Stream_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.IO.Stream)%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L178">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_IO_Stream_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.IO.Stream)">GetHyphenationTree(Stream)</h4> |
| <div class="markdown level1 summary"><p>Create a hyphenator tree</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static HyphenationTree GetHyphenationTree(Stream hyphenationSource)</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.IO.Stream</span></td> |
| <td><span class="parametername">hyphenationSource</span></td> |
| <td><p>the InputSource pointing to the XML grammar </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.Compound.Hyphenation.HyphenationTree.html">HyphenationTree</a></td> |
| <td><p>An object representing the hyphenation patterns </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </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_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_IO_Stream_System_Text_Encoding_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.IO.Stream%2CSystem.Text.Encoding)%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L190">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_IO_Stream_System_Text_Encoding_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.IO.Stream,System.Text.Encoding)">GetHyphenationTree(Stream, Encoding)</h4> |
| <div class="markdown level1 summary"><p>Create a hyphenator tree</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static HyphenationTree GetHyphenationTree(Stream hyphenationSource, Encoding encoding)</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.IO.Stream</span></td> |
| <td><span class="parametername">hyphenationSource</span></td> |
| <td><p>the InputSource pointing to the XML grammar </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Text.Encoding</span></td> |
| <td><span class="parametername">encoding</span></td> |
| <td><p>The character encoding to use</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.Compound.Hyphenation.HyphenationTree.html">HyphenationTree</a></td> |
| <td><p>An object representing the hyphenation patterns </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </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_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L132">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_String_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.String)">GetHyphenationTree(String)</h4> |
| <div class="markdown level1 summary"><p>Create a hyphenator tree</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static HyphenationTree GetHyphenationTree(string hyphenationFilename)</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">hyphenationFilename</span></td> |
| <td><p>the filename of the XML grammar to load </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.Compound.Hyphenation.HyphenationTree.html">HyphenationTree</a></td> |
| <td><p>An object representing the hyphenation patterns </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </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_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_String_System_Text_Encoding_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.String%2CSystem.Text.Encoding)%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L144">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_HyphenationCompoundWordTokenFilter_GetHyphenationTree_System_String_System_Text_Encoding_" data-uid="Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter.GetHyphenationTree(System.String,System.Text.Encoding)">GetHyphenationTree(String, Encoding)</h4> |
| <div class="markdown level1 summary"><p>Create a hyphenator tree</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static HyphenationTree GetHyphenationTree(string hyphenationFilename, Encoding encoding)</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">hyphenationFilename</span></td> |
| <td><p>the filename of the XML grammar to load </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Text.Encoding</span></td> |
| <td><span class="parametername">encoding</span></td> |
| <td><p>The character encoding to use</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.Compound.Hyphenation.HyphenationTree.html">HyphenationTree</a></td> |
| <td><p>An object representing the hyphenation patterns </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">System.IDisposable</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_Analysis_Compound_HyphenationCompoundWordTokenFilter.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.HyphenationCompoundWordTokenFilter%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.Common/Analysis/Compound/HyphenationCompoundWordTokenFilter.cs/#L43" 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> |
