Class AddFacetedDocTask

Add a faceted document.

Inheritance
object
PerfTask
AddDocTask
AddFacetedDocTask
Implements
Inherited Members
Namespace: Lucene.Net.Benchmarks.ByTask.Tasks
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class AddFacetedDocTask : AddDocTask, IDisposable
Remarks

Config properties:

  • with.facets <tells whether to actually add any facets to the document| Default: true>

    This config property allows to easily compare the performance of adding docs with and without facets. Note that facets are created even when this is false, just that they are not added to the document (nor to the taxonomy).

See AddDocTask for general document parameters and configuration.

Makes use of the FacetSource in effect - see PerfRunData for facet source settings.

Constructors

AddFacetedDocTask(PerfRunData)

Add a faceted document.

Declaration
public AddFacetedDocTask(PerfRunData runData)
Parameters
Type Name Description
PerfRunData runData
Remarks

Config properties:

  • with.facets <tells whether to actually add any facets to the document| Default: true>

    This config property allows to easily compare the performance of adding docs with and without facets. Note that facets are created even when this is false, just that they are not added to the document (nor to the taxonomy).

See AddDocTask for general document parameters and configuration.

Makes use of the FacetSource in effect - see PerfRunData for facet source settings.

Methods

DoLogic()

Perform the task once (ignoring repetitions specification). Return number of work items done by this task. For indexing that can be number of docs added. For warming that can be number of scanned items, etc.

Declaration
public override int DoLogic()
Returns
Type Description
int

Number of work items done by this task.
Overrides
Remarks

Config properties:

  • with.facets <tells whether to actually add any facets to the document| Default: true>

    This config property allows to easily compare the performance of adding docs with and without facets. Note that facets are created even when this is false, just that they are not added to the document (nor to the taxonomy).

See AddDocTask for general document parameters and configuration.

Makes use of the FacetSource in effect - see PerfRunData for facet source settings.

GetLogMessage(int)

Add a faceted document.

Declaration
protected override string GetLogMessage(int recsCount)
Parameters
Type Name Description
int recsCount
Returns
Type Description
string
Overrides
Remarks

Config properties:

  • with.facets <tells whether to actually add any facets to the document| Default: true>

    This config property allows to easily compare the performance of adding docs with and without facets. Note that facets are created even when this is false, just that they are not added to the document (nor to the taxonomy).

See AddDocTask for general document parameters and configuration.

Makes use of the FacetSource in effect - see PerfRunData for facet source settings.

Setup()

Task setup work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work from DoLogic() to this method. Only the work done in DoLogic() is measured for this task. Notice that higher level (sequence) tasks containing this task would then measure larger time than the sum of their contained tasks.

Declaration
public override void Setup()
Overrides
Remarks

Config properties:

  • with.facets <tells whether to actually add any facets to the document| Default: true>

    This config property allows to easily compare the performance of adding docs with and without facets. Note that facets are created even when this is false, just that they are not added to the document (nor to the taxonomy).

See AddDocTask for general document parameters and configuration.

Makes use of the FacetSource in effect - see PerfRunData for facet source settings.

Implements