Class NewLocaleTask
Set a CultureInfo for use in benchmarking.
Implements
Inherited Members
Namespace: Lucene.Net.Benchmarks.ByTask.Tasks
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class NewLocaleTask : PerfTask, IDisposable
Remarks
Locales can be specified in the following ways:
de: Language "de"-
: Language "en", country "US"en,US -
: Language "nb" (Bokmål), country "NO"nb-NO -
: The InvariantCultureROOT
Constructors
NewLocaleTask(PerfRunData)
Create a new CultureInfo and set it it in the RunData for use by all future tasks.
Declaration
public NewLocaleTask(PerfRunData runData)
Parameters
| Type | Name | Description |
|---|---|---|
| PerfRunData | runData |
Remarks
Locales can be specified in the following ways:
de: Language "de"-
: Language "en", country "US"en,US -
: Language "nb" (Bokmål), country "NO"nb-NO -
: The InvariantCultureROOT
Properties
SupportsParams
Sub classes that support parameters must override this method to return
true if this task supports command line params.
Declaration
public override bool SupportsParams { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Overrides
Remarks
Locales can be specified in the following ways:
de: Language "de"-
: Language "en", country "US"en,US -
: Language "nb" (Bokmål), country "NO"nb-NO -
: The InvariantCultureROOT
Methods
DoLogic()
Perform the task once (ignoring repetitions specification). Return number of work items done by this task. For indexing that can be number of docs added. For warming that can be number of scanned items, etc.
Declaration
public override int DoLogic()
Returns
| Type | Description |
|---|---|
| int | Number of work items done by this task. |
Overrides
Remarks
Locales can be specified in the following ways:
de: Language "de"-
: Language "en", country "US"en,US -
: Language "nb" (Bokmål), country "NO"nb-NO -
: The InvariantCultureROOT
SetParams(string)
Set the params of this task.
Declaration
public override void SetParams(string @params)
Parameters
| Type | Name | Description |
|---|---|---|
| string | params |
Overrides
Remarks
Locales can be specified in the following ways:
de: Language "de"-
: Language "en", country "US"en,US -
: Language "nb" (Bokmål), country "NO"nb-NO -
: The InvariantCultureROOT
Exceptions
| Type | Condition |
|---|---|
| NotSupportedException | For tasks supporting command line parameters. |