org.apache.lucene.benchmark.byTask.feeds (Lucene 10.5.1 benchmark API)
Description: declaration: package: org.apache.lucene.benchmark.byTask.feeds

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

package org.apache.lucene.benchmark.byTask.feeds
Sources for benchmark inputs: documents and queries.

- Related Packages
  Package
  Description
  org.apache.lucene.benchmark.byTask
  Benchmarking Lucene By Tasks
  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.tasks
  Extendable benchmark tasks.
  org.apache.lucene.benchmark.byTask.utils
  Utilities used for the benchmark, and for the reports.
- Class
  Description
  AbstractQueryMaker
  Abstract base query maker.
  ContentItemsSource
  Base class for source of data for benchmarking
  ContentSource
  Represents content from a specified source, such as TREC, Reuters etc.
  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).
  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.
  FacetSource
  Source items for facets.
  FileBasedQueryMaker
  Create queries from a FileReader.
  GeonamesLineParser
  A line parser for Geonames.org data.
  HTMLParser
  HTML Parsing Interface for test purposes
  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 `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`.
  NoMoreDataException
  Exception indicating there is no more data.
  QueryMaker
  Create queries for the test.
  RandomFacetSource
  Simple implementation of a random facet source
  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.
  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`.
  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
  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`.