Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class NewLocaleTask

    Set a CultureInfo for use in benchmarking.

    Inheritance
    object
    PerfTask
    NewLocaleTask
    Implements
    IDisposable
    Inherited Members
    PerfTask.m_logStep
    PerfTask.m_params
    PerfTask.NEW_LINE
    PerfTask.SetRunInBackground(int)
    PerfTask.RunInBackground
    PerfTask.BackgroundDeltaPriority
    PerfTask.Stop
    PerfTask.StopNow()
    PerfTask.Clone()
    PerfTask.Dispose()
    PerfTask.Dispose(bool)
    PerfTask.RunAndMaybeStats(bool)
    PerfTask.GetName()
    PerfTask.SetName(string)
    PerfTask.RunData
    PerfTask.Depth
    PerfTask.ToString()
    PerfTask.GetLogMessage(int)
    PerfTask.ShouldNeverLogAtStart
    PerfTask.ShouldNotRecordStats
    PerfTask.Setup()
    PerfTask.TearDown()
    PerfTask.Params
    PerfTask.DisableCounting
    PerfTask.AlgLineNum
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    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"
    • en,US
      : Language "en", country "US"
    • nb-NO
      : Language "nb" (Bokmål), country "NO"
    • ROOT
      : The InvariantCulture

    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"
    • en,US
      : Language "en", country "US"
    • nb-NO
      : Language "nb" (Bokmål), country "NO"
    • ROOT
      : The InvariantCulture

    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
    PerfTask.SupportsParams
    Remarks

    Locales can be specified in the following ways:

    • de: Language "de"
    • en,US
      : Language "en", country "US"
    • nb-NO
      : Language "nb" (Bokmål), country "NO"
    • ROOT
      : The InvariantCulture

    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
    PerfTask.DoLogic()
    Remarks

    Locales can be specified in the following ways:

    • de: Language "de"
    • en,US
      : Language "en", country "US"
    • nb-NO
      : Language "nb" (Bokmål), country "NO"
    • ROOT
      : The InvariantCulture

    SetParams(string)

    Set the params of this task.

    Declaration
    public override void SetParams(string @params)
    Parameters
    Type Name Description
    string params
    Overrides
    PerfTask.SetParams(string)
    Remarks

    Locales can be specified in the following ways:

    • de: Language "de"
    • en,US
      : Language "en", country "US"
    • nb-NO
      : Language "nb" (Bokmål), country "NO"
    • ROOT
      : The InvariantCulture
    Exceptions
    Type Condition
    NotSupportedException

    For tasks supporting command line parameters.

    Implements

    IDisposable
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.