# All Classes and Interfaces

Class
Description
AbstractQueryMaker
Abstract base query maker.
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...)`.
Algorithm
Test algorithm, as read from file
AnalyzerFactory
A factory to create an analyzer.
AnalyzerFactoryTask
Analyzer factory construction task.
Benchmark
Run the benchmark algorithm.
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.
Config
Perf run configuration properties.
Constants
Various benchmarking constants (mostly defaults)
ConsumeContentSourceTask
Consumes a `ContentSource`.
ContentItemsSource
Base class for source of data for benchmarking
ContentSource
Represents content from a specified source, such as TREC, Reuters etc.
CreateIndexTask
Create an index.
CreateTaxonomyIndexTask
Create a taxonomy index.
DemoHTMLParser
Simple HTML Parser extracting title, meta tags, and body text that is based on NekoHTML.
DemoHTMLParser.Parser
The actual parser to read HTML documents
DirContentSource
A `ContentSource` using the Dir collection for its input.
DirContentSource.Iterator
Iterator over the files in the directory
DocData
Output of parsing (e.g.
DocMaker
Creates `Document` objects.
DocMaker.DocState
Document state, supports reuse of field instances across documents (see `reuseFields` parameter).
DocNameExtractor
Utility: extract doc names from an index
EnwikiContentSource
A `ContentSource` which reads the English Wikipedia dump.
EnwikiQueryMaker
A QueryMaker that uses common and uncommon actual Wikipedia queries for searching the English Wikipedia collection.
ExtractWikipedia
Extract the downloaded Wikipedia dump into separate files for indexing.
FacetSource
Source items for facets.
FileBasedQueryMaker
Create queries from a FileReader.
FlushIndexTask
Flush Index Task uses flushNextBuffer() to flush documents at thread level
ForceMergeTask
Runs forceMerge on the index.
Format
Formatting utilities (for reports).
GeonamesLineParser
A line parser for Geonames.org data.
HTMLParser
HTML Parsing Interface for test purposes
Judge
Judge if a document is relevant for a quality query.
LineDocSource
A `ContentSource` reading one line at a time as a `Document` from a single file.
LineDocSource.HeaderLineParser
`LineDocSource.LineParser` which sets field names and order by the header - any header - of the lines file.
LineDocSource.LineParser
Reader of a single input line into `DocData`.
LineDocSource.SimpleLineParser
`LineDocSource.LineParser` which ignores the header passed to its constructor and assumes simply that field names and their order are the same as in `WriteLineDocTask.DEFAULT_FIELDS`
LongToEnglishContentSource
Creates documents whose content is a `long` number starting from ``Long.MIN_VALUE` + 10`.
LongToEnglishQueryMaker
Creates queries whose content is a spelled-out `long` number starting from ``Long.MIN_VALUE` + 10`.
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.
NoMoreDataException
Exception indicating there is no more data.
OpenIndexTask
Open an index writer.
OpenReaderTask
Open an index reader.
OpenTaxonomyIndexTask
Open a taxonomy index.
OpenTaxonomyReaderTask
Open a taxonomy index reader.
PerfRunData
Data maintained by a performance test run.
PerfTask
An abstract task to be tested for performance.
Points
Test run data points collected as the test proceeds.
PrintReaderTask
Opens a reader and prints basic statistics.
QualityBenchmark
Main entry point for running a quality benchmark.
QualityQueriesFinder
Suggest Quality queries based on an index contents.
QualityQuery
A QualityQuery has an ID and some name-value pairs.
QualityQueryParser
Parse a QualityQuery into a Lucene query.
QualityStats
Results of quality benchmark run for a single query or for a set of queries.
QualityStats.RecallPoint
A certain rank in which a relevant doc was found.
QueryDriver
Command-line tool for doing a TREC evaluation run.
QueryMaker
Create queries for the test.
RandomFacetSource
Simple implementation of a random facet source
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.
Report
Textual report of current statistics.
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.
ReutersContentSource
A `ContentSource` reading from the Reuters collection.
ReutersQueryMaker
A QueryMaker that makes queries devised manually (by Grant Ingersoll) for searching in the Reuters collection.
RollbackIndexTask
Rollback the index writer.
Sample
Sample performance test written programmatically - no algorithm file is needed here.
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.
SimpleQQParser
Simplistic quality query parser.
SimpleQueryMaker
A QueryMaker that makes queries for a collection created using `SingleDocSource`.
SimpleSloppyPhraseQueryMaker
Create sloppy phrase queries for performance test, in an index created using simple doc maker.
SingleDocSource
Creates the same document each time `SingleDocSource.getNextDocData(DocData)` is called.
SortableSingleDocSource
Adds fields appropriate for sorting: country, random_string and sort_field (int).
SpatialDocMaker
Indexes spatial data according to a configured `SpatialStrategy` with optional shape transformation via a configured `SpatialDocMaker.ShapeConverter`.
SpatialDocMaker.ShapeConverter
Converts one shape to another.
SpatialFileQueryMaker
Reads spatial data from the body field docs from an internally created `LineDocSource`.
StreamUtils
Stream utilities.
StreamUtils.Type
File format type
SubmissionReport
Create a log ready for submission.
TaskSequence
Sequence of parallel or sequential tasks.
TaskStats
Statistics for a task run.
Trec1MQReader
Read topics of TREC 1MQ track.
TrecContentSource
Implements a `ContentSource` over the TREC collection.
TrecDocParser
Parser for trec doc content, invoked on doc text excluding <DOC> and <DOCNO> which are handled in TrecContentSource.
TrecDocParser.ParsePathType
Types of trec parse paths,
TrecFBISParser
Parser for the FBIS docs in trec disks 4+5 collection format
TrecFR94Parser
Parser for the FR94 docs in trec disks 4+5 collection format
TrecFTParser
Parser for the FT docs in trec disks 4+5 collection format
TrecGov2Parser
Parser for the GOV2 collection format
TrecJudge
Judge if given document is relevant to given quality query, based on Trec format for judgements.
TrecLATimesParser
Parser for the FT docs in trec disks 4+5 collection format
TrecParserByPath
Parser for trec docs which selects the parser to apply according to the source files path, defaulting to `TrecGov2Parser`.
TrecTopicsReader
Read TREC topics.
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.