Class PassageFormatter

Creates a formatted snippet from the top passages.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

System.Object

PassageFormatter

DefaultPassageFormatter

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Lucene.Net.Search.PostingsHighlight

Assembly: Lucene.Net.ICU.dll

Syntax

public abstract class PassageFormatter

Methods

Format(Passage[], String)

Formats the top passages from content into a human-readable text snippet.

Declaration

public abstract object Format(Passage[] passages, string content)

Parameters

Type	Name	Description
Passage[]	passages	top-N passages for the field. Note these are sorted in the order that they appear in the document for convenience.
System.String	content	content for the field.

Returns

Type	Description
System.Object	formatted highlight. Note that for the non-expert APIs in ICUPostingsHighlighter that return System.String, the System.Object.ToString() method on the System.Object returned by this method is used to compute the string.