Low level api to get the most relevant (formatted) sections of the document. This method has been made public to allow visibility of score information held in TextFragment objects. Thanks to Jason Calabrese for help in redefining the interface.

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

Syntax

C#
public TextFragment[] GetBestTextFragments(
	TokenStream tokenStream,
	string text,
	bool mergeContiguousFragments,
	int maxNumFragments
)
Visual Basic
Public Function GetBestTextFragments ( _
	tokenStream As TokenStream, _
	text As String, _
	mergeContiguousFragments As Boolean, _
	maxNumFragments As Integer _
) As TextFragment()
Visual C++
public:
array<TextFragment^>^ GetBestTextFragments(
	TokenStream^ tokenStream, 
	String^ text, 
	bool mergeContiguousFragments, 
	int maxNumFragments
)

Parameters

tokenStream
Type: Lucene.Net.Analysis..::..TokenStream

[Missing <param name="tokenStream"/> documentation for "M:Lucene.Net.Highlight.Highlighter.GetBestTextFragments(Lucene.Net.Analysis.TokenStream,System.String,System.Boolean,System.Int32)"]

text
Type: System..::..String

[Missing <param name="text"/> documentation for "M:Lucene.Net.Highlight.Highlighter.GetBestTextFragments(Lucene.Net.Analysis.TokenStream,System.String,System.Boolean,System.Int32)"]

mergeContiguousFragments
Type: System..::..Boolean

[Missing <param name="mergeContiguousFragments"/> documentation for "M:Lucene.Net.Highlight.Highlighter.GetBestTextFragments(Lucene.Net.Analysis.TokenStream,System.String,System.Boolean,System.Int32)"]

maxNumFragments
Type: System..::..Int32

[Missing <param name="maxNumFragments"/> documentation for "M:Lucene.Net.Highlight.Highlighter.GetBestTextFragments(Lucene.Net.Analysis.TokenStream,System.String,System.Boolean,System.Int32)"]

Return Value

[Missing <returns> documentation for "M:Lucene.Net.Highlight.Highlighter.GetBestTextFragments(Lucene.Net.Analysis.TokenStream,System.String,System.Boolean,System.Int32)"]

See Also