Class DocNameExtractor

Utility: extract doc names from an index

Inheritance

object

DocNameExtractor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Benchmarks.Quality.Utils

Assembly: Lucene.Net.Benchmark.dll

Syntax

public class DocNameExtractor

Constructors

DocNameExtractor(string)

Constructor for DocNameExtractor.

Declaration

public DocNameExtractor(string docNameField)

Parameters

Type	Name	Description
string	docNameField	name of the stored field containing the doc name.

Methods

DocName(IndexSearcher, int)

Extract the name of the input doc from the index.

Declaration

public virtual string DocName(IndexSearcher searcher, int docid)

Parameters

Type	Name	Description
IndexSearcher	searcher	access to the index.
int	docid	ID of doc whose name is needed.

Returns

Type	Description
string	the name of the input doc as extracted from the index.

Exceptions

Type	Condition
IOException	if cannot extract the doc name from the index.