# Package org.apache.lucene.benchmark.byTask.tasks

package org.apache.lucene.benchmark.byTask.tasks
Extendable benchmark tasks.

- Related Packages
  Package
  Description
  org.apache.lucene.benchmark.byTask
  Benchmarking Lucene By Tasks
  org.apache.lucene.benchmark.byTask.feeds
  Sources for benchmark inputs: documents and queries.
  org.apache.lucene.benchmark.byTask.programmatic
  Sample performance test written programmatically - no algorithm file is needed here.
  org.apache.lucene.benchmark.byTask.stats
  Statistics maintained when running benchmark tasks.
  org.apache.lucene.benchmark.byTask.utils
  Utilities used for the benchmark, and for the reports.
- Class
  Description
  AddDocTask
  Add a document, optionally of a certain size.
  AddFacetedDocTask
  Add a faceted document.
  AddIndexesTask
  Adds an input index to an existing index, using `IndexWriter.addIndexes(Directory...)` or `IndexWriter.addIndexes(CodecReader...)`.
  AnalyzerFactoryTask
  Analyzer factory construction task.
  ClearStatsTask
  Clear statistics data.
  CloseIndexTask
  Close index writer.
  CloseReaderTask
  Close index reader.
  CloseTaxonomyIndexTask
  Close taxonomy index.
  CloseTaxonomyReaderTask
  Close taxonomy reader.
  CommitIndexTask
  Commits the IndexWriter.
  CommitTaxonomyIndexTask
  Commits the Taxonomy Index.
  ConsumeContentSourceTask
  Consumes a `ContentSource`.
  CreateIndexTask
  Create an index.
  CreateTaxonomyIndexTask
  Create a taxonomy index.
  FlushIndexTask
  Flush Index Task uses flushNextBuffer() to flush documents at thread level
  ForceMergeTask
  Runs forceMerge on the index.
  NearRealtimeReaderTask
  Spawns a BG thread that periodically (defaults to 3.0 seconds, but accepts param in seconds) wakes up and asks IndexWriter for a near real-time reader.
  NewAnalyzerTask
  Create a new `Analyzer` and set it in the getRunData() for use by all future tasks.
  NewCollationAnalyzerTask
  Task to support benchmarking collation.
  NewCollationAnalyzerTask.Implementation
  Different Collation implementations: currently limited to what is provided in the JDK and ICU.
  NewLocaleTask
  Set a `Locale` for use in benchmarking.
  NewRoundTask
  Increment the counter for properties maintained by Round Number.
  OpenIndexTask
  Open an index writer.
  OpenReaderTask
  Open an index reader.
  OpenTaxonomyIndexTask
  Open a taxonomy index.
  OpenTaxonomyReaderTask
  Open a taxonomy index reader.
  PerfTask
  An abstract task to be tested for performance.
  PrintReaderTask
  Opens a reader and prints basic statistics.
  ReadTask
  Read index (abstract) task.
  ReadTokensTask
  Simple task to test performance of tokenizers.
  ReopenReaderTask
  Reopens IndexReader and closes old IndexReader.
  RepAllTask
  Report all statistics with no aggregations.
  ReportTask
  Report (abstract) task - all report tasks extend this task.
  RepSelectByPrefTask
  Report by-name-prefix statistics with no aggregations.
  RepSumByNameRoundTask
  Report all statistics grouped/aggregated by name and round.
  RepSumByNameTask
  Report all statistics aggregated by name.
  RepSumByPrefRoundTask
  Report all prefix matching statistics grouped/aggregated by name and round.
  RepSumByPrefTask
  Report by-name-prefix statistics aggregated by name.
  ResetInputsTask
  Reset inputs so that the test run would behave, input wise, as if it just started.
  ResetSystemEraseTask
  Reset all index and input data and call gc, erase index and dir, does NOT clear statistics.
  ResetSystemSoftTask
  Reset all index and input data and call gc, does NOT erase index/dir, does NOT clear statistics.
  RollbackIndexTask
  Rollback the index writer.
  SearchTask
  Search task.
  SearchTravRetHighlightTask
  Search and Traverse and Retrieve docs task.
  SearchTravRetLoadFieldSelectorTask
  Search and Traverse and Retrieve docs task using a FieldVisitor loading only the requested fields.
  SearchTravRetTask
  Search and Traverse and Retrieve docs task.
  SearchTravTask
  Search and Traverse task.
  SearchWithCollectorTask
  Does search w/ a custom collector
  SearchWithSortTask
  Does sort search on specified field.
  SetPropTask
  Set a performance test configuration property.
  TaskSequence
  Sequence of parallel or sequential tasks.
  UpdateDocTask
  Update a document, using IndexWriter.updateDocument, optionally with of a certain size.
  WaitTask
  Simply waits for the specified (via the parameter) amount of time.
  WarmTask
  Warm reader task: retrieve all reader documents.
  WriteEnwikiLineDocTask
  A `WriteLineDocTask` which for Wikipedia input, will write category pages to another file, while remaining pages will be written to the original file.
  WriteLineDocTask
  A task which writes documents, one line per document.