Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SearchWithCollectorTask

    Does search w/ a custom collector

    Inheritance
    object
    PerfTask
    ReadTask
    SearchTask
    SearchWithCollectorTask
    Implements
    IDisposable
    Inherited Members
    ReadTask.DoLogic()
    ReadTask.RetrieveDoc(IndexReader, int)
    ReadTask.WithScore
    ReadTask.WithMaxScore
    ReadTask.TraversalSize
    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 SearchWithCollectorTask : SearchTask, IDisposable

    Constructors

    SearchWithCollectorTask(PerfRunData)

    Does search w/ a custom collector

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

    Fields

    m_clnName

    Does search w/ a custom collector

    Declaration
    protected string m_clnName
    Field Value
    Type Description
    string

    Properties

    WithCollector

    Does search w/ a custom collector

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

    WithRetrieve

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

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

    WithSearch

    Return true if search should be performed.

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

    WithTraverse

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

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

    WithWarm

    Return true if warming should be performed.

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

    Methods

    CreateCollector()

    Does search w/ a custom collector

    Declaration
    protected override ICollector CreateCollector()
    Returns
    Type Description
    ICollector
    Overrides
    ReadTask.CreateCollector()

    GetQueryMaker()

    Return query maker used for this task.

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

    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
    ReadTask.Setup()

    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.