Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
Lucene.Net.Search.Vectorhighlight.FragmentsBuilder Interface Reference

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

Inherited by Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.

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
readerIndexReader of the index
docIddocument id to be highlighted
fieldNamefield of the document to be highlighted
fieldFragListFieldFragList object
Returns
a created fragment or null when no fragment created

Implemented in Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.

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

create multiple fragments.

Parameters
readerIndexReader of the index
docIddocument id to be highlighted
fieldNamefield of the document to be highlighted
fieldFragListieldFragList object
maxNumFragmentsmaximum number of fragments
Returns
created fragments or null when no fragments created. Size of the array can be less than maxNumFragments

Implemented in Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.


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