Extracts all terms texts of a given Query into an array of WeightedTerms

Namespace: Lucene.Net.Highlight
Assembly: Lucene.Net.Contrib.Highlighter (in Lucene.Net.Contrib.Highlighter.dll) Version: 2.3.2.1

Syntax

C#
public static WeightedTerm[] GetIdfWeightedTerms(
	Query query,
	IndexReader reader,
	string fieldName
)
Visual Basic
Public Shared Function GetIdfWeightedTerms ( _
	query As Query, _
	reader As IndexReader, _
	fieldName As String _
) As WeightedTerm()
Visual C++
public:
static array<WeightedTerm^>^ GetIdfWeightedTerms(
	Query^ query, 
	IndexReader^ reader, 
	String^ fieldName
)

Parameters

query
Type: Lucene.Net.Search..::..Query
Query to extract term texts from
reader
Type: Lucene.Net.Index..::..IndexReader
used to compute IDF which can be used to a) score selected fragments better b) use graded highlights eg chaning intensity of font color
fieldName
Type: System..::..String
the field on which Inverse Document Frequency (IDF) calculations are based

Return Value

an array of the terms used in a query, plus their weights.

See Also