blob: 7a3b15bc9cd7e452c95ac8a320946fb2b7a0fb25 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class PatternParser
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PatternParser
| 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.Hyphenation.PatternParser">
<h1 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser" class="text-break">Class PatternParser
</h1>
<div class="markdown level0 summary"><p>A XMLReader document handler to read and parse hyphenation patterns from a XML
file.
<p>
LUCENENET: This class has been refactored from its Java counterpart to use XmlReader rather
than a SAX parser.</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">PatternParser</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.Compound.Hyphenation.html">Lucene.Net.Analysis.Compound.Hyphenation</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6>
<h5 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class PatternParser</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_Hyphenation_PatternParser__ctor.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.%23ctor%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/Hyphenation/PatternParser.cs/#L57">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser__ctor_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser__ctor" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.#ctor">PatternParser()</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 PatternParser()</code></pre>
</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_Hyphenation_PatternParser__ctor_Lucene_Net_Analysis_Compound_Hyphenation_IPatternConsumer_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.%23ctor(Lucene.Net.Analysis.Compound.Hyphenation.IPatternConsumer)%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/Hyphenation/PatternParser.cs/#L63">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser__ctor_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser__ctor_Lucene_Net_Analysis_Compound_Hyphenation_IPatternConsumer_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.#ctor(Lucene.Net.Analysis.Compound.Hyphenation.IPatternConsumer)">PatternParser(IPatternConsumer)</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 PatternParser(IPatternConsumer consumer)</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.Compound.Hyphenation.IPatternConsumer.html">IPatternConsumer</a></td>
<td><span class="parametername">consumer</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Consumer.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Consumer%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/Hyphenation/PatternParser.cs/#L69">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Consumer_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Consumer*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Consumer" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Consumer">Consumer</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 IPatternConsumer Consumer { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.IPatternConsumer.html">IPatternConsumer</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Characters_System_Char___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Characters(System.Char%5B%5D%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/Hyphenation/PatternParser.cs/#L518">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Characters_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Characters*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Characters_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Characters(System.Char[],System.Int32,System.Int32)">Characters(Char[], Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Receive notification of character data.
<p>
The Parser will call this method to report each chunk of character data. Parsers may
return all contiguous character data in a single chunk, or they may split it into
several chunks; however, all of the characters in any single event must come from
the same external entity so that the Locator provides useful information.
<p>
The application must not attempt to read from the array outside of the specified range.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void Characters(char[] ch, int start, int length)</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.Char</span>[]</td>
<td><span class="parametername">ch</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">start</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">length</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_Hyphenation_PatternParser_EndElement_System_String_System_String_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.EndElement(System.String%2CSystem.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_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/PatternParser.cs/#L468">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_EndElement_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.EndElement*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_EndElement_System_String_System_String_System_String_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.EndElement(System.String,System.String,System.String)">EndElement(String, String, String)</h4>
<div class="markdown level1 summary"><p>Receive notification of the end of an element.
<p>
The parser will invoke this method at the end of every element in the XML document;
there will be a corresponding <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.html#Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_StartElement_System_String_System_String_System_String_System_Collections_Generic_IDictionary_System_String_System_String__">StartElement(String, String, String, IDictionary&lt;String, String&gt;)</a> event for every
<a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.html#Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_EndElement_System_String_System_String_System_String_">EndElement(String, String, String)</a> event (even when the element is empty).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void EndElement(string uri, string local, string raw)</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">uri</span></td>
<td><p>the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">local</span></td>
<td><p>the local name (without prefix), or the empty string if Namespace processing is not being performed</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">raw</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_Hyphenation_PatternParser_GetExceptionWord__1_System_Collections_Generic_IList___0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.GetExceptionWord%60%601(System.Collections.Generic.IList%7B%60%600%7D)%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/Hyphenation/PatternParser.cs/#L346">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_GetExceptionWord_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.GetExceptionWord*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_GetExceptionWord__1_System_Collections_Generic_IList___0__" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.GetExceptionWord``1(System.Collections.Generic.IList{``0})">GetExceptionWord&lt;T1&gt;(IList&lt;T1&gt;)</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 virtual string GetExceptionWord&lt;T1&gt;(IList&lt;T1&gt; ex)</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.Collections.Generic.IList</span>&lt;T1&gt;</td>
<td><span class="parametername">ex</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>
<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">T1</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_Hyphenation_PatternParser_GetInterletterValues_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.GetInterletterValues(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/Hyphenation/PatternParser.cs/#L367">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_GetInterletterValues_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.GetInterletterValues*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_GetInterletterValues_System_String_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.GetInterletterValues(System.String)">GetInterletterValues(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">protected static string GetInterletterValues(string pat)</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">pat</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_GetPattern_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.GetPattern(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/Hyphenation/PatternParser.cs/#L291">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_GetPattern_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.GetPattern*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_GetPattern_System_String_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.GetPattern(System.String)">GetPattern(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">protected static string GetPattern(string word)</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">word</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_NormalizeException__1_System_Collections_Generic_IList___0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.NormalizeException%60%601(System.Collections.Generic.IList%7B%60%600%7D)%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/Hyphenation/PatternParser.cs/#L305">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_NormalizeException_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.NormalizeException*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_NormalizeException__1_System_Collections_Generic_IList___0__" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.NormalizeException``1(System.Collections.Generic.IList{``0})">NormalizeException&lt;T1&gt;(IList&lt;T1&gt;)</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 virtual IList&lt;object&gt; NormalizeException&lt;T1&gt;(IList&lt;T1&gt; ex)</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.Collections.Generic.IList</span>&lt;T1&gt;</td>
<td><span class="parametername">ex</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.Collections.Generic.IList</span>&lt;<span class="xref">System.Object</span>&gt;</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">T1</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_Hyphenation_PatternParser_Parse_System_IO_FileInfo_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(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/Hyphenation/PatternParser.cs/#L108">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_System_IO_FileInfo_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(System.IO.FileInfo)">Parse(FileInfo)</h4>
<div class="markdown level1 summary"><p>Parses a hyphenation pattern file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void Parse(FileInfo file)</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">file</span></td>
<td><p>a <span class="xref">System.IO.FileInfo</span> object representing the file </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>In case of an exception while parsing </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_Hyphenation_PatternParser_Parse_System_IO_FileInfo_System_Text_Encoding_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(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/Hyphenation/PatternParser.cs/#L119">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_System_IO_FileInfo_System_Text_Encoding_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(System.IO.FileInfo,System.Text.Encoding)">Parse(FileInfo, Encoding)</h4>
<div class="markdown level1 summary"><p>Parses a hyphenation pattern file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void Parse(FileInfo file, 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">file</span></td>
<td><p>a <span class="xref">System.IO.FileInfo</span> object representing the file </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="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>In case of an exception while parsing </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_Hyphenation_PatternParser_Parse_System_IO_Stream_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(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/Hyphenation/PatternParser.cs/#L140">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_System_IO_Stream_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(System.IO.Stream)">Parse(Stream)</h4>
<div class="markdown level1 summary"><p>Parses a hyphenation pattern file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void Parse(Stream xmlStream)</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">xmlStream</span></td>
<td><p>The stream containing the XML data.
<p>
The <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.html">PatternParser</a> scans the first bytes of the stream looking for a byte order mark
or other sign of encoding. When encoding is determined, the encoding is used to continue reading
the stream, and processing continues parsing the input as a stream of (Unicode) characters.</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>In case of an exception while parsing </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_Hyphenation_PatternParser_Parse_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(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/Hyphenation/PatternParser.cs/#L80">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_System_String_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(System.String)">Parse(String)</h4>
<div class="markdown level1 summary"><p>Parses a hyphenation pattern file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void Parse(string path)</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">path</span></td>
<td><p>The complete file path to be read.</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>In case of an exception while parsing </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_Hyphenation_PatternParser_Parse_System_String_System_Text_Encoding_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(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/Hyphenation/PatternParser.cs/#L92">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_System_String_System_Text_Encoding_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(System.String,System.Text.Encoding)">Parse(String, Encoding)</h4>
<div class="markdown level1 summary"><p>Parses a hyphenation pattern file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void Parse(string path, 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">path</span></td>
<td><p>The complete file path to be read.</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="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>In case of an exception while parsing </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_Hyphenation_PatternParser_Parse_System_Xml_XmlReader_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(System.Xml.XmlReader)%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/Hyphenation/PatternParser.cs/#L155">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_Parse_System_Xml_XmlReader_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.Parse(System.Xml.XmlReader)">Parse(XmlReader)</h4>
<div class="markdown level1 summary"><p>Parses a hyphenation pattern file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void Parse(XmlReader source)</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.Xml.XmlReader</span></td>
<td><span class="parametername">source</span></td>
<td><p><span class="xref">System.Xml.XmlReader</span> input source for the file </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>In case of an exception while parsing </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_Hyphenation_PatternParser_ReadToken_System_Text_StringBuilder_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.ReadToken(System.Text.StringBuilder)%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/Hyphenation/PatternParser.cs/#L234">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_ReadToken_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.ReadToken*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_ReadToken_System_Text_StringBuilder_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.ReadToken(System.Text.StringBuilder)">ReadToken(StringBuilder)</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 virtual string ReadToken(StringBuilder chars)</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.Text.StringBuilder</span></td>
<td><span class="parametername">chars</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_StartElement_System_String_System_String_System_String_System_Collections_Generic_IDictionary_System_String_System_String__.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.StartElement(System.String%2CSystem.String%2CSystem.String%2CSystem.Collections.Generic.IDictionary%7BSystem.String%2CSystem.String%7D)%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/Hyphenation/PatternParser.cs/#L424">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_StartElement_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.StartElement*"></a>
<h4 id="Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_StartElement_System_String_System_String_System_String_System_Collections_Generic_IDictionary_System_String_System_String__" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.StartElement(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String})">StartElement(String, String, String, IDictionary&lt;String, String&gt;)</h4>
<div class="markdown level1 summary"><p>Receive notification of the beginning of an element.
<p>
The Parser will invoke this method at the beginning of every element in the XML document;
there will be a corresponding <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.html#Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_EndElement_System_String_System_String_System_String_">EndElement(String, String, String)</a> event for every <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.html#Lucene_Net_Analysis_Compound_Hyphenation_PatternParser_StartElement_System_String_System_String_System_String_System_Collections_Generic_IDictionary_System_String_System_String__">StartElement(String, String, String, IDictionary&lt;String, String&gt;)</a> event
(even when the element is empty). All of the element&apos;s content will be reported,
in order, before the corresponding endElement event.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void StartElement(string uri, string local, string raw, IDictionary&lt;string, string&gt; attrs)</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">uri</span></td>
<td><p>the Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">local</span></td>
<td><p>the local name (without prefix), or the empty string if Namespace processing is not being performed</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">raw</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IDictionary</span>&lt;<span class="xref">System.String</span>, <span class="xref">System.String</span>&gt;</td>
<td><span class="parametername">attrs</span></td>
<td><p>the attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. The value of this object after startElement returns is undefined</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_Compound_Hyphenation_PatternParser.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.PatternParser%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/Hyphenation/PatternParser.cs/#L35" 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>