Class PerfRunData

Data maintained by a performance test run.

Inheritance

System.Object

PerfRunData

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

| Improve this Doc View Source

PerfRunData(Config)

Declaration

public PerfRunData(Config config)

Parameters

Type	Name	Description
Config	config

Properties

| Improve this Doc View Source

Analyzer

Gets or sets the analyzer.

Declaration

public virtual Analyzer Analyzer { get; set; }

Property Value

Type	Description
Analyzer

| Improve this Doc View Source

AnalyzerFactories

Declaration

public virtual IDictionary<string, AnalyzerFactory> AnalyzerFactories { get; }

Property Value

Type	Description
IDictionary<System.String, AnalyzerFactory>

| Improve this Doc View Source

Config

Gets the config.

Declaration

public virtual Config Config { get; }

Property Value

Type	Description
Config

| Improve this Doc View Source

ContentSource

Gets the ContentSource.

Declaration

public virtual ContentSource ContentSource { get; }

Property Value

Type	Description
ContentSource

| Improve this Doc View Source

DocMaker

Returns the DocMaker.

Declaration

public virtual DocMaker DocMaker { get; }

Property Value

Type	Description
DocMaker

| Improve this Doc View Source

FacetSource

Gets the FacetSource.

Declaration

public virtual FacetSource FacetSource { get; }

Property Value

Type	Description
FacetSource

| Improve this Doc View Source

IndexWriter

Gets or sets the indexWriter.

Declaration

public virtual IndexWriter IndexWriter { get; set; }

Property Value

Type	Description
IndexWriter

| Improve this Doc View Source

Locale

Gets or sets the culture.

Declaration

public virtual CultureInfo Locale { get; set; }

Property Value

Type	Description
CultureInfo

| Improve this Doc View Source

Points

Gets the points.

Declaration

public virtual Points Points { get; }

Property Value

Type	Description
Points

| Improve this Doc View Source

StartTimeMillis

Gets start time in milliseconds.

Declaration

public virtual long StartTimeMillis { get; }

Property Value

Type	Description
System.Int64

| Improve this Doc View Source

TaxonomyDir

Gets the taxonomy directory.

Declaration

public virtual Directory TaxonomyDir { get; }

Property Value

Type	Description
Directory

| Improve this Doc View Source

TaxonomyWriter

Gets or sets the taxonomy writer.

Declaration

public virtual ITaxonomyWriter TaxonomyWriter { get; set; }

Property Value

Type	Description
ITaxonomyWriter

Methods

| Improve this Doc View Source

Dispose()

Declaration

public void Dispose()

| Improve this Doc View Source

Dispose(Boolean)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

| Improve this Doc View Source

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

| Improve this Doc View Source

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

| Improve this Doc View Source

GetPerfObject(String)

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

Declaration

public virtual object GetPerfObject(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
System.Object

| Improve this Doc View Source

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

| Improve this Doc View Source

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

| Improve this Doc View Source

Reinit(Boolean)

Declaration

public virtual void Reinit(bool eraseIndex)

Parameters

Type	Name	Description
System.Boolean	eraseIndex

| Improve this Doc View Source

ResetInputs()

Declaration

public virtual void ResetInputs()

| Improve this Doc View Source

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.

| Improve this Doc View Source

SetPerfObject(String, Object)

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

Declaration

public virtual void SetPerfObject(string key, object obj)

Parameters

Type	Name	Description
System.String	key
System.Object	obj

| Improve this Doc View Source

SetStartTimeMillis()

Declaration

public virtual long SetStartTimeMillis()

Returns

Type	Description
System.Int64

| Improve this Doc View Source

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.