FragmentsBuilder is an interface for fragments (snippets) builder classes. A FragmentsBuilder class can be plugged in to Highlighter. More...

Public Member Functions
String	CreateFragment (IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList)
	create a fragment.

String[]	CreateFragments (IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments)
	create multiple fragments.

Detailed Description

FragmentsBuilder is an interface for fragments (snippets) builder classes. A FragmentsBuilder class can be plugged in to Highlighter.

Definition at line 32 of file FragmentsBuilder.cs.

Member Function Documentation

String Lucene.Net.Search.Vectorhighlight.FragmentsBuilder.CreateFragment	(	IndexReader	reader,
		int	docId,
		String	fieldName,
		FieldFragList	fieldFragList
	)

create a fragment.

Parameters

reader	IndexReader of the index
docId	document id to be highlighted
fieldName	field of the document to be highlighted
fieldFragList	FieldFragList object

String [] Lucene.Net.Search.Vectorhighlight.FragmentsBuilder.CreateFragments	(	IndexReader	reader,
		int	docId,
		String	fieldName,
		FieldFragList	fieldFragList,
		int	maxNumFragments
	)

create multiple fragments.

Parameters

reader	IndexReader of the index
docId	document id to be highlighted
fieldName	field of the document to be highlighted
fieldFragList	ieldFragList object
maxNumFragments	maximum number of fragments

Returns: created fragments or null when no fragments created. Size of the array can be less than maxNumFragments

The documentation for this interface was generated from the following file: