| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class AnalyzerFactoryTask |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class AnalyzerFactoryTask |
| | 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="benchmark/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.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask"> |
| |
| |
| <h1 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask" class="text-break">Class AnalyzerFactoryTask |
| </h1> |
| <div class="markdown level0 summary"><p>Analyzer factory construction task. The name given to the constructed factory may |
| be given to <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.NewAnalyzerTask.html">NewAnalyzerTask</a>, which will call <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Utils.AnalyzerFactory.html#Lucene_Net_Benchmarks_ByTask_Utils_AnalyzerFactory_Create">Create()</a>.</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"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html">PerfTask</a></div> |
| <div class="level2"><span class="xref">AnalyzerFactoryTask</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.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_m_logStep">PerfTask.m_logStep</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_m_params">PerfTask.m_params</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_NEW_LINE">PerfTask.NEW_LINE</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetRunInBackground_System_Int32_">PerfTask.SetRunInBackground(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunInBackground">PerfTask.RunInBackground</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_BackgroundDeltaPriority">PerfTask.BackgroundDeltaPriority</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Stop">PerfTask.Stop</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_StopNow">PerfTask.StopNow()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Clone">PerfTask.Clone()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose">PerfTask.Dispose()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose_System_Boolean_">PerfTask.Dispose(Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunAndMaybeStats_System_Boolean_">PerfTask.RunAndMaybeStats(Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetName">PerfTask.GetName()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetName_System_String_">PerfTask.SetName(String)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunData">PerfTask.RunData</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Depth">PerfTask.Depth</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ToString">PerfTask.ToString()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetLogMessage_System_Int32_">PerfTask.GetLogMessage(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNeverLogAtStart">PerfTask.ShouldNeverLogAtStart</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNotRecordStats">PerfTask.ShouldNotRecordStats</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Setup">PerfTask.Setup()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_TearDown">PerfTask.TearDown()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Params">PerfTask.Params</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DisableCounting">PerfTask.DisableCounting</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_AlgLineNum">PerfTask.AlgLineNum</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.html">Lucene.Net.Benchmarks.ByTask.Tasks</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class AnalyzerFactoryTask : PerfTask, IDisposable</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>Params are in the form argname:argvalue or argname:"argvalue" or argname:'argvalue'; |
| use backslashes to escape '"' or "'" inside a quoted value when it's used as the enclosing |
| quotation mark, |
| <p> |
| Specify params in a comma separated list of the following, in order: |
| <ol><li> |
| <ul><li><strong>Required</strong>: <code>name:<em>analyzer-factory-name</em></code></li><li>Optional: <code>positionIncrementGap:<em>int value</em></code> (default: 0)</li><li>Optional: <code>offsetGap:<em>int value</em></code> (default: 1)</li></ul> |
| </li><li>zero or more CharFilterFactory's, followed by</li><li>exactly one TokenizerFactory, followed by</li><li>zero or more TokenFilterFactory's</li></ol> |
| <p> |
| Each component analysis factory map specify <tt>luceneMatchVersion</tt> (defaults to |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Util.LuceneVersion.html#Lucene_Net_Util_LuceneVersion_LUCENE_CURRENT">LUCENE_CURRENT</a>) and any of the args understood by the specified |
| *Factory class, in the above-describe param format. |
| <p> |
| Example:</p> |
| <pre><code> -AnalyzerFactory(name:'strip html, fold to ascii, whitespace tokenize, max 10k tokens', |
| positionIncrementGap:100, |
| HTMLStripCharFilter, |
| MappingCharFilter(mapping:'mapping-FoldToASCII.txt'), |
| WhitespaceTokenizer(luceneMatchVersion:LUCENE_43), |
| TokenLimitFilter(maxTokenCount:10000, consumeAllTokens:false)) |
| [...] |
| -NewAnalyzer('strip html, fold to ascii, whitespace tokenize, max 10k tokens')</code></pre> |
| <p><p> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Utils.AnalyzerFactory.html">AnalyzerFactory</a> will direct analysis component factories to look for resources |
| under the directory specified in the "work.dir" property.</p> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask__ctor_Lucene_Net_Benchmarks_ByTask_PerfRunData_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.%23ctor(Lucene.Net.Benchmarks.ByTask.PerfRunData)%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.Benchmark/ByTask/Tasks/AnalyzerFactoryTask.cs/#L89">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask__ctor_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.#ctor*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask__ctor_Lucene_Net_Benchmarks_ByTask_PerfRunData_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.#ctor(Lucene.Net.Benchmarks.ByTask.PerfRunData)">AnalyzerFactoryTask(PerfRunData)</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 AnalyzerFactoryTask(PerfRunData runData)</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.Benchmarks.ByTask.PerfRunData.html">PerfRunData</a></td> |
| <td><span class="parametername">runData</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_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_SupportsParams.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.SupportsParams%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.Benchmark/ByTask/Tasks/AnalyzerFactoryTask.cs/#L571">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_SupportsParams_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.SupportsParams*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_SupportsParams" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.SupportsParams">SupportsParams</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override bool SupportsParams { get; }</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><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SupportsParams">PerfTask.SupportsParams</a></div> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_SupportsParams_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SupportsParams">SupportsParams</a></div> |
| </div> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_DoLogic.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.DoLogic%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.Benchmark/ByTask/Tasks/AnalyzerFactoryTask.cs/#L94">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_DoLogic_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.DoLogic*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_DoLogic" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.DoLogic">DoLogic()</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override int DoLogic()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic">PerfTask.DoLogic()</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_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_GetLineNumber_J2N_IO_StreamTokenizer_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.GetLineNumber(J2N.IO.StreamTokenizer)%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.Benchmark/ByTask/Tasks/AnalyzerFactoryTask.cs/#L574">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_GetLineNumber_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.GetLineNumber*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_GetLineNumber_J2N_IO_StreamTokenizer_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.GetLineNumber(J2N.IO.StreamTokenizer)">GetLineNumber(StreamTokenizer)</h4> |
| <div class="markdown level1 summary"><p>Returns the current line in the algorithm 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 int GetLineNumber(StreamTokenizer stok)</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">J2N.IO.StreamTokenizer</span></td> |
| <td><span class="parametername">stok</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.Int32</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_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_LookupAnalysisClass_System_String_System_Type_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.LookupAnalysisClass(System.String%2CSystem.Type)%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.Benchmark/ByTask/Tasks/AnalyzerFactoryTask.cs/#L533">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_LookupAnalysisClass_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.LookupAnalysisClass*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_LookupAnalysisClass_System_String_System_Type_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.LookupAnalysisClass(System.String,System.Type)">LookupAnalysisClass(String, Type)</h4> |
| <div class="markdown level1 summary"><p>This method looks up a class with its fully qualified name (FQN), or a short-name |
| class-simplename, or with a package suffix, assuming "Lucene.Net.Analysis." |
| as the namespace prefix (e.g. "standard.ClassicTokenizerFactory" -> |
| "Lucene.Net.Analysis.Standard.ClassicTokenizerFactory").</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Type LookupAnalysisClass(string className, Type expectedType)</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">className</span></td> |
| <td><p>The namespace qualified name or the short name of the class.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Type</span></td> |
| <td><span class="parametername">expectedType</span></td> |
| <td><p>The superclass <code data-dev-comment-type="paramref" class="paramref">className</code> is expected to extend. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Type</span></td> |
| <td><p>The loaded type.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_LookupAnalysisClass_System_String_System_Type__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>If <code data-dev-comment-type="paramref" class="paramref">className</code> contains a period, the class is first looked up as-is, assuming that it |
| is an FQN. If this fails, lookup is retried after prepending the Lucene analysis |
| package prefix to the class name. |
| <p> |
| If <code data-dev-comment-type="paramref" class="paramref">className</code> does not contain a period, the analysis SPI *Factory.LookupClass() |
| methods are used to find the class.</p> |
| </div> |
| <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.TypeLoadException</span></td> |
| <td><p>If lookup fails.</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_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_SetParams_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.SetParams(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.Benchmark/ByTask/Tasks/AnalyzerFactoryTask.cs/#L108">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_SetParams_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.SetParams*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask_SetParams_System_String_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask.SetParams(System.String)">SetParams(String)</h4> |
| <div class="markdown level1 summary"><p>Sets the params. |
| Analysis component factory names may optionally include the "Factory" suffix.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override void SetParams(string params)</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">params</span></td> |
| <td><p>analysis pipeline specification: name, (optional) positionIncrementGap, |
| (optional) offsetGap, 0+ CharFilterFactory's, 1 TokenizerFactory, |
| and 0+ TokenFilterFactory's</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetParams_System_String_">PerfTask.SetParams(String)</a></div> |
| <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_Benchmarks_ByTask_Tasks_AnalyzerFactoryTask.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.AnalyzerFactoryTask%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.Benchmark/ByTask/Tasks/AnalyzerFactoryTask.cs/#L73" 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> |