Class PerfRunData

Data maintained by a performance test run.

Inheritance
object
PerfRunData
Implements
Inherited Members
Namespace: Lucene.Net.Benchmarks.ByTask
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class PerfRunData : IDisposable
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Constructors

PerfRunData(Config)

Data maintained by a performance test run.

Declaration
public PerfRunData(Config config)
Parameters
Type Name Description
Config config
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

PerfRunData(Config, bool, bool)

Data maintained by a performance test run.

Declaration
protected PerfRunData(Config config, bool performReinit, bool logQueries)
Parameters
Type Name Description
Config config
bool performReinit
bool logQueries
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Properties

Analyzer

Gets or sets the analyzer.

Declaration
public virtual Analyzer Analyzer { get; set; }
Property Value
Type Description
Analyzer
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

AnalyzerFactories

Data maintained by a performance test run.

Declaration
public virtual IDictionary<string, AnalyzerFactory> AnalyzerFactories { get; }
Property Value
Type Description
IDictionary<string, AnalyzerFactory>
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Config

Gets the config.

Declaration
public virtual Config Config { get; }
Property Value
Type Description
Config
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

ContentSource

Gets the ContentSource.

Declaration
public virtual ContentSource ContentSource { get; }
Property Value
Type Description
ContentSource
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Directory

Gets or sets the directory.

Declaration
public virtual Directory Directory { get; set; }
Property Value
Type Description
Directory
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

DocMaker

Returns the DocMaker.

Declaration
public virtual DocMaker DocMaker { get; }
Property Value
Type Description
DocMaker
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

FacetSource

Gets the FacetSource.

Declaration
public virtual FacetSource FacetSource { get; }
Property Value
Type Description
FacetSource
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

IndexWriter

Gets or sets the indexWriter.

Declaration
public virtual IndexWriter IndexWriter { get; set; }
Property Value
Type Description
IndexWriter
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Locale

Gets or sets the culture.

Declaration
public virtual CultureInfo Locale { get; set; }
Property Value
Type Description
CultureInfo
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Points

Gets the points.

Declaration
public virtual Points Points { get; }
Property Value
Type Description
Points
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

StartTimeMillis

Gets start time in milliseconds.

Declaration
public virtual long StartTimeMillis { get; }
Property Value
Type Description
long
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

TaxonomyDir

Gets the taxonomy directory.

Declaration
public virtual Directory TaxonomyDir { get; }
Property Value
Type Description
Directory
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

TaxonomyWriter

Gets or sets the taxonomy writer.

Declaration
public virtual ITaxonomyWriter TaxonomyWriter { get; set; }
Property Value
Type Description
ITaxonomyWriter
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Methods

CreateDirectory(bool, string, string)

Data maintained by a performance test run.

Declaration
protected virtual Directory CreateDirectory(bool eraseIndex, string dirName, string dirParam)
Parameters
Type Name Description
bool eraseIndex
string dirName
string dirParam
Returns
Type Description
Directory
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Dispose(bool)

Data maintained by a performance test run.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

GetIndexReader()

Returns the indexReader. NOTE: this returns a reference. You must call IndexReader.DecRef() when you're done.

Declaration
public virtual DirectoryReader GetIndexReader()
Returns
Type Description
DirectoryReader
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

GetIndexSearcher()

Returns the indexSearcher. NOTE: this returns a reference to the underlying IndexReader. You must call IndexReader.DecRef() when you're done.

Declaration
public virtual IndexSearcher GetIndexSearcher()
Returns
Type Description
IndexSearcher
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

GetPerfObject(string)

Returns an object that was previously set by SetPerfObject(string, object).

Declaration
public virtual object GetPerfObject(string key)
Parameters
Type Name Description
string key
Returns
Type Description
object
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

GetQueryMaker(ReadTask)

Returns the queryMaker by read task type (class).

Declaration
public virtual IQueryMaker GetQueryMaker(ReadTask readTask)
Parameters
Type Name Description
ReadTask readTask
Returns
Type Description
IQueryMaker
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

GetTaxonomyReader()

Returns the taxonomyReader. NOTE: this returns a reference. You must call TaxonomyReader.DecRef() when you're done.

Declaration
public virtual TaxonomyReader GetTaxonomyReader()
Returns
Type Description
TaxonomyReader
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Reinit(bool)

Data maintained by a performance test run.

Declaration
public virtual void Reinit(bool eraseIndex)
Parameters
Type Name Description
bool eraseIndex
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

ResetInputs()

Data maintained by a performance test run.

Declaration
public virtual void ResetInputs()
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

SetIndexReader(DirectoryReader)

Set the index reader. Takes ownership of that index reader, that is, internally performs indexReader.incRef() (If caller no longer needs that reader it should decRef()/close() it after calling this method, otherwise, the reader will remain open).

Declaration
public virtual void SetIndexReader(DirectoryReader indexReader)
Parameters
Type Name Description
DirectoryReader indexReader

The indexReader to set.
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

SetPerfObject(string, object)

Sets an object that is required by PerfTasks, keyed by the given key. If the object implements IDisposable, it will be disposed by Dispose().

Declaration
public virtual void SetPerfObject(string key, object obj)
Parameters
Type Name Description
string key
object obj
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

SetStartTimeMillis()

Data maintained by a performance test run.

Declaration
public virtual long SetStartTimeMillis()
Returns
Type Description
long
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

SetTaxonomyReader(TaxonomyReader)

Set the taxonomy reader. Takes ownership of that taxonomy reader, that is, internally performs taxoReader.IncRef() (If caller no longer needs that reader it should DecRef()/Dispose() it after calling this method, otherwise, the reader will remain open).

Declaration
public virtual void SetTaxonomyReader(TaxonomyReader taxoReader)
Parameters
Type Name Description
TaxonomyReader taxoReader

The taxonomy reader to set.
Remarks

Data includes:

  • Configuration.
  • Directory, Writer, Reader.
  • Taxonomy Directory, Writer, Reader.
  • DocMaker, FacetSource and a few instances of QueryMaker.
  • Named AnalysisFactories.
  • Analyzer.
  • Statistics data which updated during the run.

Config properties:
  • work.dir<path to root of docs and index dirs| Default: work>
  • analyzer<class name for analyzer| Default: StandardAnalyzer>
  • doc.maker<class name for doc-maker| Default: DocMaker>
  • facet.source<class name for facet-source| Default: RandomFacetSource>
  • query.maker<class name for query-maker| Default: SimpleQueryMaker>
  • log.queries<whether queries should be printed| Default: false>
  • directory<type of directory to use for the index| Default: RAMDirectory>
  • taxonomy.directory<type of directory for taxonomy index| Default: RAMDirectory>

Implements