Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class DirContentSource

    A ContentSource using the Dir collection for its input. Supports the following configuration parameters (on top of ContentSource):

    • work.dirspecifies the working directory. Required if "docs.dir" denotes a relative path (default=work).
    • docs.dirspecifies the directory the Dir collection. Can be set to a relative path if "work.dir" is also specified (default=dir-out).
    Inheritance
    object
    ContentItemsSource
    ContentSource
    DirContentSource
    Implements
    IDisposable
    Inherited Members
    ContentItemsSource.m_forever
    ContentItemsSource.m_logStep
    ContentItemsSource.m_verbose
    ContentItemsSource.m_encoding
    ContentItemsSource.AddBytes(long)
    ContentItemsSource.AddItem()
    ContentItemsSource.CollectFiles(DirectoryInfo, IList<FileInfo>)
    ContentItemsSource.ShouldLog()
    ContentItemsSource.Dispose()
    ContentItemsSource.BytesCount
    ContentItemsSource.ItemsCount
    ContentItemsSource.Config
    ContentItemsSource.TotalBytesCount
    ContentItemsSource.TotalItemsCount
    ContentItemsSource.PrintStatistics(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Benchmarks.ByTask.Feeds
    Assembly: Lucene.Net.Benchmark.dll
    Syntax
    public class DirContentSource : ContentSource, IDisposable

    Methods

    Dispose(bool)

    Releases resources used by the DirContentSource 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
    ContentItemsSource.Dispose(bool)

    GetNextDocData(DocData)

    Returns the next DocData from the content source. Implementations must account for multi-threading, as multiple threads can call this method simultaneously.

    Declaration
    public override DocData GetNextDocData(DocData docData)
    Parameters
    Type Name Description
    DocData docData
    Returns
    Type Description
    DocData
    Overrides
    ContentSource.GetNextDocData(DocData)

    ResetInputs()

    Resets the input for this content source, so that the test would behave as if it was just started, input-wise.

    NOTE: the default implementation resets the number of bytes and items generated since the last reset, so it's important to call base.ResetInputs() in case you override this method.
    Declaration
    public override void ResetInputs()
    Overrides
    ContentItemsSource.ResetInputs()

    SetConfig(Config)

    Sets the Config for this content source. If you override this method, you must call base.SetConfig(config).

    Declaration
    public override void SetConfig(Config config)
    Parameters
    Type Name Description
    Config config
    Overrides
    ContentItemsSource.SetConfig(Config)

    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.