Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class WarmTask

    Warm reader task: retrieve all reader documents.

    Inheritance
    object
    PerfTask
    ReadTask
    WarmTask
    Implements
    IDisposable
    Inherited Members
    ReadTask.DoLogic()
    ReadTask.CreateCollector()
    ReadTask.RetrieveDoc(IndexReader, int)
    ReadTask.WithCollector
    ReadTask.WithScore
    ReadTask.WithMaxScore
    ReadTask.TraversalSize
    ReadTask.Setup()
    ReadTask.NumHits
    ReadTask.NumToHighlight
    ReadTask.GetBenchmarkHighlighter(Query)
    ReadTask.Sort
    ReadTask.GetFieldsToHighlight(Document)
    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.TearDown()
    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 WarmTask : ReadTask, IDisposable
    Remarks

    Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.

    Other side effects: counts additional 1 (record) for each retrieved (non null) document.

    Constructors

    WarmTask(PerfRunData)

    Warm reader task: retrieve all reader documents.

    Declaration
    public WarmTask(PerfRunData runData)
    Parameters
    Type Name Description
    PerfRunData runData
    Remarks

    Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.

    Other side effects: counts additional 1 (record) for each retrieved (non null) document.

    Properties

    WithRetrieve

    Return true if, with search & results traversing, docs should be retrieved.

    Declaration
    public override bool WithRetrieve { get; }
    Property Value
    Type Description
    bool
    Overrides
    ReadTask.WithRetrieve
    Remarks

    Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.

    Other side effects: counts additional 1 (record) for each retrieved (non null) document.

    WithSearch

    Return true if search should be performed.

    Declaration
    public override bool WithSearch { get; }
    Property Value
    Type Description
    bool
    Overrides
    ReadTask.WithSearch
    Remarks

    Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.

    Other side effects: counts additional 1 (record) for each retrieved (non null) document.

    WithTraverse

    Return true if, with search, results should be traversed.

    Declaration
    public override bool WithTraverse { get; }
    Property Value
    Type Description
    bool
    Overrides
    ReadTask.WithTraverse
    Remarks

    Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.

    Other side effects: counts additional 1 (record) for each retrieved (non null) document.

    WithWarm

    Return true if warming should be performed.

    Declaration
    public override bool WithWarm { get; }
    Property Value
    Type Description
    bool
    Overrides
    ReadTask.WithWarm
    Remarks

    Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.

    Other side effects: counts additional 1 (record) for each retrieved (non null) document.

    Methods

    GetQueryMaker()

    Return query maker used for this task.

    Declaration
    public override IQueryMaker GetQueryMaker()
    Returns
    Type Description
    IQueryMaker
    Overrides
    ReadTask.GetQueryMaker()
    Remarks

    Note: This task reuses the reader if it is already open. Otherwise a reader is opened at start and closed at the end.

    Other side effects: counts additional 1 (record) for each retrieved (non null) document.

    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.