Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SearchWithSortTask

    Does sort search on specified field.

    Inheritance
    object
    PerfTask
    ReadTask
    SearchWithSortTask
    Implements
    IDisposable
    Inherited Members
    ReadTask.DoLogic()
    ReadTask.CreateCollector()
    ReadTask.RetrieveDoc(IndexReader, int)
    ReadTask.WithCollector
    ReadTask.TraversalSize
    ReadTask.Setup()
    ReadTask.NumHits
    ReadTask.NumToHighlight
    ReadTask.GetBenchmarkHighlighter(Query)
    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.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 SearchWithSortTask : ReadTask, IDisposable

    Constructors

    SearchWithSortTask(PerfRunData)

    Does sort search on specified field.

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

    Properties

    Sort

    Does sort search on specified field.

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

    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

    WithMaxScore

    Whether maxScores should be computed (only useful with field sort)

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

    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

    WithScore

    Whether scores should be computed (only useful with field sort)

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

    WithSearch

    Return true if search should be performed.

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

    WithTraverse

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

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

    WithWarm

    Return true if warming should be performed.

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

    Methods

    GetQueryMaker()

    Return query maker used for this task.

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

    SetParams(string)

    SortFields: field:type,field:type[,noscore][,nomaxscore]

    If noscore is present, then we turn off score tracking in Lucene.Net.Search.TopFieldCollector. If nomaxscore is present, then we turn off maxScore tracking in Lucene.Net.Search.TopFieldCollector.

    name:string,page:int,subject:string
    Declaration
    public override void SetParams(string sortField)
    Parameters
    Type Name Description
    string sortField
    Overrides
    PerfTask.SetParams(string)

    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.