Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class ReadTokensTask

    Simple task to test performance of tokenizers. It just creates a token stream for each field of the document and read all tokens out of that stream.

    Inheritance
    object
    PerfTask
    ReadTokensTask
    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.RunAndMaybeStats(bool)
    PerfTask.GetName()
    PerfTask.SetName(string)
    PerfTask.RunData
    PerfTask.Depth
    PerfTask.ToString()
    PerfTask.ShouldNeverLogAtStart
    PerfTask.ShouldNotRecordStats
    PerfTask.SupportsParams
    PerfTask.SetParams(string)
    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 ReadTokensTask : PerfTask, IDisposable

    Constructors

    ReadTokensTask(PerfRunData)

    Simple task to test performance of tokenizers. It just creates a token stream for each field of the document and read all tokens out of that stream.

    Declaration
    public ReadTokensTask(PerfRunData runData)
    Parameters
    Type Name Description
    PerfRunData runData

    Methods

    Dispose(bool)

    Releases resources used by the ReadTokensTask and if overridden in a derived class, optionally releases unmanaged resources.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    true to release both managed and unmanaged resources; false to release only unmanaged resources.

    Overrides
    PerfTask.Dispose(bool)

    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()

    GetLogMessage(int)

    Simple task to test performance of tokenizers. It just creates a token stream for each field of the document and read all tokens out of that stream.

    Declaration
    protected override string GetLogMessage(int recsCount)
    Parameters
    Type Name Description
    int recsCount
    Returns
    Type Description
    string
    Overrides
    PerfTask.GetLogMessage(int)

    Setup()

    Task setup work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work from DoLogic() to this method. Only the work done in DoLogic() is measured for this task. Notice that higher level (sequence) tasks containing this task would then measure larger time than the sum of their contained tasks.

    Declaration
    public override void Setup()
    Overrides
    PerfTask.Setup()

    TearDown()

    Task teardown work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work from DoLogic() to this method. Only the work done in DoLogic() is measured for this task. Notice that higher level (sequence) tasks containing this task would then measure larger time than the sum of their
    contained tasks.

    Declaration
    public override void TearDown()
    Overrides
    PerfTask.TearDown()

    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.