Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class CheckAbort

    Class for recording units of work when merging segments.

    Inheritance
    object
    CheckAbort
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Index
    Assembly: Lucene.Net.dll
    Syntax
    public class CheckAbort

    Constructors

    CheckAbort(OneMerge, Directory)

    Creates a CheckAbort instance.

    Declaration
    public CheckAbort(MergePolicy.OneMerge merge, Directory dir)
    Parameters
    Type Name Description
    MergePolicy.OneMerge merge
    Directory dir

    Fields

    NONE

    If you use this: IW.Dispose(false) cannot abort your merge!

    Note

    This API is for internal purposes only and might change in incompatible ways in the next release.

    Declaration
    public static readonly CheckAbort NONE
    Field Value
    Type Description
    CheckAbort

    Methods

    Work(double)

    Records the fact that roughly units amount of work have been done since this method was last called. When adding time-consuming code into SegmentMerger, you should test different values for units to ensure that the time in between calls to merge.CheckAborted is up to ~ 1 second.

    Declaration
    public virtual void Work(double units)
    Parameters
    Type Name Description
    double units
    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.